Skip to content

Updated docs and docs landing page #1575

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 17, 2024
Merged

Updated docs and docs landing page #1575

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions pgml-cms/docs/open-source/korvus/example-apps/rag-with-openai.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
5 changes: 5 additions & 0 deletions pgml-cms/docs/open-source/korvus/example-apps/semantic-search.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
8 changes: 4 additions & 4 deletions pgml-dashboard/src/api/cms.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
13 changes: 2 additions & 11 deletions pgml-dashboard/src/components/pages/docs/landing_page/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"),
Expand All @@ -42,7 +42,7 @@ lazy_static! {
.into_iter()
.map(|s| s.to_owned())
.collect();
static ref TUTORIAL_TARGETS: Vec<String> = Vec::from(["semantic search"])
static ref TUTORIAL_TARGETS: Vec<String> = Vec::from(["semantic search", "rag with openai"])
.into_iter()
.map(|s| s.to_owned())
.collect();
Expand All @@ -63,7 +63,6 @@ lazy_static! {
pub struct LandingPage {
pgml_ai: Vec<DocCard>,
pgml_ml: Vec<DocCard>,
benchmarks: Vec<DocCard>,
korvus_overview: Vec<DocCard>,
korvus_tutorials: Vec<DocCard>,
feature_banner: FeatureBanner,
Expand All @@ -80,14 +79,12 @@ impl LandingPage {
pub async fn parse_sections(mut self, links: Vec<IndexLink>) -> Self {
let mut children: Vec<IndexLink> = links.clone();

let mut benchmarks_folder: Vec<IndexLink> = Vec::new();
let mut extension_folder: Vec<IndexLink> = Vec::new();
let mut korvus_folder: Vec<IndexLink> = 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,
_ => {
Expand Down Expand Up @@ -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);
Expand Down
11 changes: 3 additions & 8 deletions pgml-dashboard/src/components/pages/docs/landing_page/template.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ <h1 class="text-center">PostgresML</br><span class="text-gradient-green">Documen

<div class="mt-5">
<%- section_title(
"<h2>SQL Extension</h2>",
"<h2>PGML SQL Extension</h2>",
"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.") %>

<div class="d-flex flex-column gap-4_5">
Expand All @@ -76,13 +76,13 @@ <h1 class="text-center">PostgresML</br><span class="text-gradient-green">Documen
<div class="d-flex flex-column gap-3 align-items-center">
<%- section_title(
r#"<div class="d-flex gap-2">
<h2>Client SDK</h2>
<h2>Korvus SDK</h2>
<div class="language-logos p-2 d-flex gap-2 h-100 rounded-2">
<img width="28px" height="28px" src="/dashboard/static/images/logos/javascript.png"/>
<img width="28px" height="28px" src="/dashboard/static/images/logos/python.png"/>
</div>
</div>"#,
"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.")%>
</div>
<div class="d-flex flex-column gap-4_5">
<div class="d-flex flex-column">
Expand All @@ -96,11 +96,6 @@ <h2>Client SDK</h2>
</div>
</div>

<div class="mt-5">
<%- section_title("<h2>Benchmarks</h2>", "")%>
<%- section_links(benchmarks)%>
</div>

<div class="container mt-5">
<div class="row d-flex flex-column flex-xl-row" style="min-height: 39rem;">
<div class="align-items-center d-flex" style="flex: 1">
Expand Down
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy