From 24d2d45dc0d577910100d576390a7c3ee651e8a5 Mon Sep 17 00:00:00 2001 From: SilasMarvin <19626586+SilasMarvin@users.noreply.github.com> Date: Wed, 17 Jul 2024 12:44:46 -0700 Subject: [PATCH] Updated docs and docs landing page --- .../korvus/example-apps/rag-with-openai.md | 4 ++++ .../korvus/example-apps/semantic-search.md | 5 +++++ pgml-dashboard/src/api/cms.rs | 8 ++++---- .../src/components/pages/docs/landing_page/mod.rs | 13 ++----------- .../pages/docs/landing_page/template.html | 11 +++-------- 5 files changed, 18 insertions(+), 23 deletions(-) diff --git a/pgml-cms/docs/open-source/korvus/example-apps/rag-with-openai.md b/pgml-cms/docs/open-source/korvus/example-apps/rag-with-openai.md index 738777f7d..64cc2af4a 100644 --- a/pgml-cms/docs/open-source/korvus/example-apps/rag-with-openai.md +++ b/pgml-cms/docs/open-source/korvus/example-apps/rag-with-openai.md @@ -1,3 +1,7 @@ +--- +description: An example application performing RAG with Korvus and OpenAI. +--- + # Rag with OpenAI This example shows how to use third-party LLM providers like OpenAI to perform RAG with Korvus. diff --git a/pgml-cms/docs/open-source/korvus/example-apps/semantic-search.md b/pgml-cms/docs/open-source/korvus/example-apps/semantic-search.md index 2aaf020fc..d48158b81 100644 --- a/pgml-cms/docs/open-source/korvus/example-apps/semantic-search.md +++ b/pgml-cms/docs/open-source/korvus/example-apps/semantic-search.md @@ -1,3 +1,8 @@ +--- +description: >- + An example application built with Korvus to perform Semantic Search. +--- + # Semantic Search This example demonstrates using the `korvus` SDK to create a collection, add documents, build a pipeline for vector search and make a sample query. diff --git a/pgml-dashboard/src/api/cms.rs b/pgml-dashboard/src/api/cms.rs index 8c8dd278a..ddb3904a7 100644 --- a/pgml-dashboard/src/api/cms.rs +++ b/pgml-dashboard/src/api/cms.rs @@ -563,19 +563,19 @@ impl Collection { .href(&url.to_string_lossy()); links.push(parent); } - _ => error!("unhandled link child: {node:?}"), + _ => warn!("unhandled link child: {node:?}"), } } } - _ => error!("unhandled paragraph child: {node:?}"), + _ => warn!("unhandled paragraph child: {node:?}"), } } } - _ => error!("unhandled list_item child: {node:?}"), + _ => warn!("unhandled list_item child: {node:?}"), } } } - _ => error!("unhandled list child: {node:?}"), + _ => warn!("unhandled list child: {node:?}"), } } Ok(links) diff --git a/pgml-dashboard/src/components/pages/docs/landing_page/mod.rs b/pgml-dashboard/src/components/pages/docs/landing_page/mod.rs index 224281510..05b429a41 100644 --- a/pgml-dashboard/src/components/pages/docs/landing_page/mod.rs +++ b/pgml-dashboard/src/components/pages/docs/landing_page/mod.rs @@ -20,7 +20,7 @@ lazy_static! { ("collections", "overview_key"), ("pipelines", "climate_mini_split"), ("semantic search", "book"), - ("semantic search using instructor model", "book"), + ("rag with openai", "book"), ("postgresml is 8-40x faster than python http microservices", "fit_page"), ("scaling to 1 million requests per second", "bolt"), ("mindsdb vs postgresml", "arrow_split"), @@ -42,7 +42,7 @@ lazy_static! { .into_iter() .map(|s| s.to_owned()) .collect(); - static ref TUTORIAL_TARGETS: Vec = Vec::from(["semantic search"]) + static ref TUTORIAL_TARGETS: Vec = Vec::from(["semantic search", "rag with openai"]) .into_iter() .map(|s| s.to_owned()) .collect(); @@ -63,7 +63,6 @@ lazy_static! { pub struct LandingPage { pgml_ai: Vec, pgml_ml: Vec, - benchmarks: Vec, korvus_overview: Vec, korvus_tutorials: Vec, feature_banner: FeatureBanner, @@ -80,14 +79,12 @@ impl LandingPage { pub async fn parse_sections(mut self, links: Vec) -> Self { let mut children: Vec = links.clone(); - let mut benchmarks_folder: Vec = Vec::new(); let mut extension_folder: Vec = Vec::new(); let mut korvus_folder: Vec = Vec::new(); while !children.is_empty() { let link = children.pop().unwrap(); match link.title.to_lowercase().as_ref() { - "benchmarks" => benchmarks_folder = link.children, "pgml" => extension_folder = link.children, "korvus" => korvus_folder = link.children, _ => { @@ -121,17 +118,11 @@ impl LandingPage { out }; - let benchmarks = find_targets(benchmarks_folder, &BENCHMARKS_TARGETS); let korvus_overview = find_targets(korvus_folder.clone(), &OVERVIEW_TARGETS); let korvus_tutorials = find_targets(korvus_folder, &TUTORIAL_TARGETS); let pgml_ai = find_targets(extension_folder.clone(), &AI_TARGETS); let pgml_ml = find_targets(extension_folder, &ML_TARGETS); - for item in benchmarks { - let card = DocCard::from_index_link(&item).await; - self.benchmarks.push(card); - } - for item in korvus_overview { let card = DocCard::from_index_link(&item).await; self.korvus_overview.push(card); diff --git a/pgml-dashboard/src/components/pages/docs/landing_page/template.html b/pgml-dashboard/src/components/pages/docs/landing_page/template.html index e86f400e7..fa9ffe539 100644 --- a/pgml-dashboard/src/components/pages/docs/landing_page/template.html +++ b/pgml-dashboard/src/components/pages/docs/landing_page/template.html @@ -55,7 +55,7 @@

PostgresML
Documen
<%- section_title( - "

SQL Extension

", + "

PGML SQL Extension

", "The SQL extension provides end-to-end ML & AI functionality from inference to deployment. It can be used in any combination to implement bespoke models across use cases.") %>
@@ -76,13 +76,13 @@

PostgresML
Documen
<%- section_title( r#"
-

Client SDK

+

Korvus SDK

"#, - "Our Client SDK implements the best practices to streamline development of common ML/AI use cases in JavaScript or Python.")%> + "Korvus implements the best practices to streamline development of common ML/AI use cases in JavaScript, Python, C and Rust.")%>
@@ -96,11 +96,6 @@

Client SDK

-
- <%- section_title("

Benchmarks

", "")%> - <%- section_links(benchmarks)%> -
-