Skip to content

Commit 45e8a4e

Browse files
authored
Organize guides, and prevent wrapping in docs nav (#1604)
1 parent a4d25df commit 45e8a4e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+181
-165
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -97,10 +97,10 @@ SELECT pgml.transform(
9797
```
9898

9999
## Tabular data
100-
- [47+ classification and regression algorithms](https://postgresml.org/docs/api/sql-extension/pgml.train/)
100+
- [47+ classification and regression algorithms](https://postgresml.org/docs/open-source/pgml/api/pgml.train)
101101
- [8 - 40X faster inference than HTTP based model serving](https://postgresml.org/blog/postgresml-is-8x-faster-than-python-http-microservices)
102102
- [Millions of transactions per second](https://postgresml.org/blog/scaling-postgresml-to-one-million-requests-per-second)
103-
- [Horizontal scalability](https://github.com/postgresml/pgcat)
103+
- [Horizontal scalability](https://postgresml.org/docs/open-source/pgcat/)
104104

105105
**Training a classification model**
106106

@@ -142,7 +142,7 @@ docker run \
142142
sudo -u postgresml psql -d postgresml
143143
```
144144

145-
For more details, take a look at our [Quick Start with Docker](https://postgresml.org/docs/resources/developer-docs/quick-start-with-docker) documentation.
145+
For more details, take a look at our [Quick Start with Docker](https://postgresml.org/docs/open-source/pgml/developers/quick-start-with-docker) documentation.
146146

147147
# Getting Started
148148

@@ -1105,7 +1105,7 @@ pgml: SELECT logs->>'epoch' AS epoch, logs->>'step' AS step, logs->>'loss' AS lo
11051105
During training, model is periodically uploaded to Hugging Face Hub. You will find the model at `https://huggingface.co/<username>/<project_name>`. An example model that was automatically pushed to Hugging Face Hub is [here](https://huggingface.co/santiadavani/imdb_review_sentiement).
11061106

11071107
### 6. Inference using fine-tuned model
1108-
Now, that we have fine-tuned model on Hugging Face Hub, we can use [`pgml.transform`](https://postgresml.org/docs/introduction/apis/sql-extensions/pgml.transform/text-classification) to perform real-time predictions as well as batch predictions.
1108+
Now, that we have fine-tuned model on Hugging Face Hub, we can use [`pgml.transform`](/docs/open-source/pgml/api/pgml.transform) to perform real-time predictions as well as batch predictions.
11091109

11101110
**Real-time predictions**
11111111

pgml-cms/blog/semantic-search-in-postgres-in-15-minutes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ SELECT pgml.embed('mixedbread-ai/mxbai-embed-large-v1', 'Generating embeddings i
5656

5757
!!!
5858

59-
We used the [pgml.embed](/docs/api/sql-extension/pgml.embed) PostresML function to generate an embedding of the sentence "Generating embeddings in Postgres is fun!" using the [mixedbread-ai/mxbai-embed-large-v1](https://huggingface.co/mixedbread-ai/mxbai-embed-large-v1) model from mixedbread.ai.
59+
We used the [pgml.embed](/docs/open-source/pgml/api/pgml.embed) PostresML function to generate an embedding of the sentence "Generating embeddings in Postgres is fun!" using the [mixedbread-ai/mxbai-embed-large-v1](https://huggingface.co/mixedbread-ai/mxbai-embed-large-v1) model from mixedbread.ai.
6060

6161
The output size of the vector varies per model, and in `mxbai-embed-large-v1` outputs vectors with 1024 dimensions: each vector contains 1024 floating point numbers.
6262

pgml-cms/blog/sentiment-analysis-using-express-js-and-postgresml.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Express is a mature JS backend framework touted as being fast and flexible. It i
2424

2525
Sentiment analysis is a valuable tool for understanding the emotional polarity of text. You can determine if the text is positive, negative, or neutral. Common use cases include understanding product reviews, survey questions, and social media posts.
2626

27-
In this application, we'll be applying sentiment analysis to note taking. Note taking and journaling can be an excellent practice for work efficiency and self improvement. However, if you are like me, it quickly becomes impossible to find and make use of anything I've written down. Notes that are useful must be easy to navigate. With this motivation, let's create a demo that can record notes throughout the day. Each day will have a summary and sentiment score. That way, if I'm looking for that time a few weeks ago when we were frustrated with our old MLOps platform — it will be easy to find.&#x20;
27+
In this application, we'll be applying sentiment analysis to note taking. Note taking and journaling can be an excellent practice for work efficiency and self improvement. However, if you are like me, it quickly becomes impossible to find and make use of anything I've written down. Notes that are useful must be easy to navigate. With this motivation, let's create a demo that can record notes throughout the day. Each day will have a summary and sentiment score. That way, if I'm looking for that time a few weeks ago when we were frustrated with our old MLOps platform — it will be easy to find.
2828

2929
We will perform all the Machine Learning heavy lifting with the pgml extension function `pgml.transform()`. This brings Hugging Face Transformers into our data layer.
3030

@@ -36,7 +36,7 @@ You can see the full code on [GitHub](https://github.com/postgresml/example-expr
3636

3737
This app is composed of three main parts, reading and writing to a database, performing sentiment analysis on entries, and creating a summary.
3838

39-
We are going to use [postgresql-client](https://www.npmjs.com/package/postgresql-client) to connect to our DB.&#x20;
39+
We are going to use [postgresql-client](https://www.npmjs.com/package/postgresql-client) to connect to our DB.
4040

4141
When the application builds we ensure we have two tables, one for notes and one for the the daily summary and sentiment score.
4242

@@ -62,7 +62,7 @@ const day = await connection.execute(`
6262

6363
We also have three endpoints to hit:
6464

65-
* `app.get(“/", async (req, res, next)` which returns all the notes for that day and the daily summary.&#x20;
65+
* `app.get(“/", async (req, res, next)` which returns all the notes for that day and the daily summary.
6666
* `app.post(“/add", async (req, res, next)` which accepts a new note entry and performs a sentiment analysis. We simplify the score by converting it to 1, 0, -1 for positive, neutral, negative and save it in our notes table.
6767

6868
```postgresql
@@ -146,8 +146,8 @@ not bad for less than an hour of coding.
146146

147147
### Final Thoughts
148148

149-
This app is far from complete but does show an easy and scalable way to get started with ML in Express. From here I encourage you to head over to our [docs](https://postgresml.org/docs/api/sql-extension/) and see what other features could be added.
149+
This app is far from complete but does show an easy and scalable way to get started with ML in Express. From here I encourage you to head over to our [docs](https://postgresml.org/docs) and see what other features could be added.
150150

151-
If SQL is not your thing, no worries. Check out or [JS SDK](https://postgresml.org/docs/api/client-sdk/getting-started) to streamline all our best practices with simple JavaScript.&#x20;
151+
If SQL is not your thing, no worries. Check out or [JS SDK](https://postgresml.org/docs/open-source/korvus/) to streamline all our best practices with simple JavaScript.
152152

153-
We love hearing from you — please reach out to us on [Discord ](https://discord.gg/DmyJP3qJ7U)or simply [Contact Us](https://postgresml.org/contact) here if you have any questions or feedback.&#x20;
153+
We love hearing from you — please reach out to us on [Discord ](https://discord.gg/DmyJP3qJ7U)or simply [Contact Us](https://postgresml.org/contact) here if you have any questions or feedback.

pgml-cms/blog/using-postgresml-with-django-and-embedding-search.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ PostgresML allows anyone to integrate advanced AI capabilities into their applic
2828

2929
Advanced search engines like Google use this technique to extract the meaning of search queries and rank the results based on what the user actually _wants_, unlike simple keyword matches which can easily give irrelevant results.
3030

31-
To accomplish this, for each document in our app, we include an embedding column stored as a vector. A vector is just an array of floating point numbers. For each item in our to-do list, we automatically generate the embedding using the PostgresML [`pgml.embed()`](https://postgresml.org/docs/introduction/apis/sql-extensions/pgml.embed) function. This function runs inside the database and doesn't require the Django app to install the model locally.
31+
To accomplish this, for each document in our app, we include an embedding column stored as a vector. A vector is just an array of floating point numbers. For each item in our to-do list, we automatically generate the embedding using the PostgresML [`pgml.embed()`](/docs/open-source/pgml/api/pgml.embed) function. This function runs inside the database and doesn't require the Django app to install the model locally.
3232

3333
An embedding model running inside PostgresML is able to extract the meaning of search queries & compare it to the meaning of the documents it stores, just like a human being would if they were able to search millions of documents in just a few milliseconds.
3434

pgml-cms/docs/README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,14 @@ PostgresML allows you to take advantage of the fundamental relationship between
2323

2424
These capabilities are primarily provided by two open-source software projects, that may be used independently, but are designed to be used together with the rest of the Postgres ecosystem:
2525

26-
* [**pgml**](/docs/api/sql-extension/) - an open source extension for PostgreSQL. It adds support for GPUs and the latest ML & AI algorithms _inside_ the database with a SQL API and no additional infrastructure, networking latency, or reliability costs.
27-
* [**PgCat**](/docs/product/pgcat/) - an open source connection pooler for PostgreSQL. It abstracts the scalability and reliability concerns of managing a distributed cluster of Postgres databases. Client applications connect only to the pooler, which handles load balancing, sharding, and failover, outside of any single database server.
26+
* [**pgml**](/docs/open-source/pgml/) - an open source extension for PostgreSQL. It adds support for GPUs and the latest ML & AI algorithms _inside_ the database with a SQL API and no additional infrastructure, networking latency, or reliability costs.
27+
* [**PgCat**](/docs/open-source/pgcat/) - an open source connection pooler for PostgreSQL. It abstracts the scalability and reliability concerns of managing a distributed cluster of Postgres databases. Client applications connect only to the pooler, which handles load balancing, sharding, and failover, outside of any single database server.
2828

2929
<figure><img src=".gitbook/assets/architecture.png" alt="PostgresML architectural diagram"><figcaption></figcaption></figure>
3030

31-
To learn more about how we designed PostgresML, take a look at our [architecture overview](/docs/resources/architecture/).
32-
3331
## Client SDK
3432

35-
The PostgresML team also provides [native language SDKs](/docs/api/client-sdk/) which implement best practices for common ML & AI applications. The JavaScript and Python SDKs are generated from the a core Rust library, which provides a uniform API, correctness and efficiency across all environments.
33+
The PostgresML team also provides [native language SDKs](/docs/open-source/korvus/) which implement best practices for common ML & AI applications. The JavaScript and Python SDKs are generated from the a core Rust library, which provides a uniform API, correctness and efficiency across all environments.
3634

3735
While using the SDK is completely optional, SDK clients can perform advanced machine learning tasks in a single SQL request, without having to transfer additional data, models, hardware or dependencies to the client application.
3836

pgml-cms/docs/SUMMARY.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -23,31 +23,15 @@
2323
* [PGML](open-source/pgml/README.md)
2424
* [API](open-source/pgml/api/README.md)
2525
* [pgml.embed()](open-source/pgml/api/pgml.embed.md)
26-
* [pgml.transform()](open-source/pgml/api/pgml.transform/README.md)
27-
* [Fill-Mask](open-source/pgml/api/pgml.transform/fill-mask.md)
28-
* [Question answering](open-source/pgml/api/pgml.transform/question-answering.md)
29-
* [Summarization](open-source/pgml/api/pgml.transform/summarization.md)
30-
* [Text classification](open-source/pgml/api/pgml.transform/text-classification.md)
31-
* [Text Generation](open-source/pgml/api/pgml.transform/text-generation.md)
32-
* [Text-to-Text Generation](open-source/pgml/api/pgml.transform/text-to-text-generation.md)
33-
* [Token Classification](open-source/pgml/api/pgml.transform/token-classification.md)
34-
* [Translation](open-source/pgml/api/pgml.transform/translation.md)
35-
* [Zero-shot Classification](open-source/pgml/api/pgml.transform/zero-shot-classification.md)
26+
* [pgml.transform()](open-source/pgml/api/pgml.transform.md)
3627
* [pgml.transform_stream()](open-source/pgml/api/pgml.transform_stream.md)
3728
* [pgml.deploy()](open-source/pgml/api/pgml.deploy.md)
3829
* [pgml.decompose()](open-source/pgml/api/pgml.decompose.md)
3930
* [pgml.chunk()](open-source/pgml/api/pgml.chunk.md)
4031
* [pgml.generate()](open-source/pgml/api/pgml.generate.md)
4132
* [pgml.predict()](open-source/pgml/api/pgml.predict/README.md)
4233
* [Batch Predictions](open-source/pgml/api/pgml.predict/batch-predictions.md)
43-
* [pgml.train()](open-source/pgml/api/pgml.train/README.md)
44-
* [Regression](open-source/pgml/api/pgml.train/regression.md)
45-
* [Classification](open-source/pgml/api/pgml.train/classification.md)
46-
* [Clustering](open-source/pgml/api/pgml.train/clustering.md)
47-
* [Decomposition](open-source/pgml/api/pgml.train/decomposition.md)
48-
* [Data Pre-processing](open-source/pgml/api/pgml.train/data-pre-processing.md)
49-
* [Hyperparameter Search](open-source/pgml/api/pgml.train/hyperparameter-search.md)
50-
* [Joint Optimization](open-source/pgml/api/pgml.train/joint-optimization.md)
34+
* [pgml.train()](open-source/pgml/api/pgml.train.md)
5135
* [pgml.tune()](open-source/pgml/api/pgml.tune.md)
5236
* [Guides](open-source/pgml/guides/README.md)
5337
* [Embeddings](open-source/pgml/guides/embeddings/README.md)
@@ -56,11 +40,27 @@
5640
* [Aggregation](open-source/pgml/guides/embeddings/vector-aggregation.md)
5741
* [Similarity](open-source/pgml/guides/embeddings/vector-similarity.md)
5842
* [Normalization](open-source/pgml/guides/embeddings/vector-normalization.md)
43+
* [LLMs](open-source/pgml/guides/llms/README.md)
44+
* [Fill-Mask](open-source/pgml/guides/llms/fill-mask.md)
45+
* [Question answering](open-source/pgml/guides/llms/question-answering.md)
46+
* [Summarization](open-source/pgml/guides/llms/summarization.md)
47+
* [Text classification](open-source/pgml/guides/llms/text-classification.md)
48+
* [Text Generation](open-source/pgml/guides/llms/text-generation.md)
49+
* [Text-to-Text Generation](open-source/pgml/guides/llms/text-to-text-generation.md)
50+
* [Token Classification](open-source/pgml/guides/llms/token-classification.md)
51+
* [Translation](open-source/pgml/guides/llms/translation.md)
52+
* [Zero-shot Classification](open-source/pgml/guides/llms/zero-shot-classification.md)
53+
* [Supervised Learning](open-source/pgml/guides/supervised-learning/README.md)
54+
* [Regression](open-source/pgml/guides/supervised-learning/regression.md)
55+
* [Classification](open-source/pgml/guides/supervised-learning/classification.md)
56+
* [Clustering](open-source/pgml/guides/supervised-learning/clustering.md)
57+
* [Decomposition](open-source/pgml/guides/supervised-learning/decomposition.md)
58+
* [Data Pre-processing](open-source/pgml/guides/supervised-learning/data-pre-processing.md)
59+
* [Hyperparameter Search](open-source/pgml/guides/supervised-learning/hyperparameter-search.md)
60+
* [Joint Optimization](open-source/pgml/guides/supervised-learning/joint-optimization.md)
5961
* [Search](open-source/pgml/guides/improve-search-results-with-machine-learning.md)
6062
* [Chatbots](open-source/pgml/guides/chatbots/README.md)
61-
* [Supervised Learning](open-source/pgml/guides/supervised-learning.md)
6263
* [Unified RAG](open-source/pgml/guides/unified-rag.md)
63-
* [Natural Language Processing](open-source/pgml/guides/natural-language-processing.md)
6464
* [Vector database](open-source/pgml/guides/vector-database.md)
6565
<!--
6666
* [Search]()

pgml-cms/docs/introduction/getting-started/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ description: Getting starting with PostgresML, a GPU powered machine learning da
66

77
A PostgresML deployment consists of multiple components working in concert to provide a complete Machine Learning platform:
88

9-
* PostgreSQL database, with [_pgml_](/docs/api/sql-extension/), _pgvector_ and many other extensions that add features useful in day-to-day and machine learning use cases
10-
* [PgCat pooler](/docs/product/pgcat/) to load balance thousands of concurrenct client requests across several database instances
9+
* PostgreSQL database, with `pgml`, `pgvector` and many other extensions that add features useful in day-to-day and machine learning use cases
10+
* [PgCat pooler](/docs/open-source/pgcat/) to load balance thousands of concurrenct client requests across several database instances
1111
* A web application to manage deployed models and share experiments analysis with SQL notebooks
1212

13-
We provide a fully managed solution in [our cloud](create-your-database), and document a self-hosted installation in the [Developer Docs](/docs/resources/developer-docs/quick-start-with-docker).
13+
We provide a fully managed solution in [our cloud](/docs/cloud/overview), and document a self-hosted installation in the [Developer Docs](/docs/open-source/pgml/developers/quick-start-with-docker).
1414

1515
<figure class="my-4"><img src="../../.gitbook/assets/architecture.png" alt="PostgresML architecture"><figcaption></figcaption></figure>
1616

1717
By building PostgresML on top of a mature database, we get reliable backups for model inputs and proven scalability without reinventing the wheel, so that we can focus on providing access to the latest developments in open source machine learning and artificial intelligence.
1818

19-
This guide will help you get started with [$100 credits](create-your-database), which includes access to GPU accelerated models and 5 GB of storage, or you can skip to our [Developer Docs](/docs/resources/developer-docs/quick-start-with-docker) to see how to run PostgresML locally with our Docker image.
19+
This guide will help you get started with [$100 credits](create-your-database), which includes access to GPU accelerated models and 5 GB of storage, or you can skip to our [Developer Docs](/docs/open-source/pgml/developers/quick-start-with-docker) to see how to run PostgresML locally with our Docker image.

0 commit comments

Comments
 (0)
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