Skip to content

Commit c7ef4c1

Browse files
montanalowmontanalow
committed
link fixes
1 parent b9cbb14 commit c7ef4c1

File tree

4 files changed

+116
-112
lines changed

4 files changed

+116
-112
lines changed

‎pgml-cms/docs/SUMMARY.md

Lines changed: 96 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -2,66 +2,66 @@
22

33
## Introduction
44

5-
* [Overview](README)
6-
* [Getting started](introduction/getting-started/README)
7-
* [Create your database](introduction/getting-started/create-your-database)
8-
* [Connect your app](introduction/getting-started/connect-your-app)
9-
* [Import your data](introduction/import-your-data/README)
10-
* [Logical replication](introduction/import-your-data/logical-replication/README)
11-
* [Foreign Data Wrappers](introduction/import-your-data/foreign-data-wrappers)
12-
* [Move data with COPY](introduction/import-your-data/copy)
13-
* [Migrate with pg_dump](introduction/import-your-data/pg-dump)
14-
* [Storage & Retrieval](introduction/import-your-data/storage-and-retrieval/README)
15-
* [Documents](introduction/import-your-data/storage-and-retrieval/documents)
16-
* [Partitioning](introduction/import-your-data/storage-and-retrieval/partitioning)
17-
* [LLM based pipelines with PostgresML and dbt (data build tool)](introduction/import-your-data/storage-and-retrieval/llm-based-pipelines-with-postgresml-and-dbt-data-build-tool)
18-
* [FAQ](introduction/faq)
5+
* [Overview](README.md)
6+
* [Getting started](introduction/getting-started/README.md)
7+
* [Create your database](introduction/getting-started/create-your-database.md)
8+
* [Connect your app](introduction/getting-started/connect-your-app.md)
9+
* [Import your data](introduction/import-your-data/README.md)
10+
* [Logical replication](introduction/import-your-data/logical-replication/README.md)
11+
* [Foreign Data Wrappers](introduction/import-your-data/foreign-data-wrappers.md)
12+
* [Move data with COPY](introduction/import-your-data/copy.md)
13+
* [Migrate with pg_dump](introduction/import-your-data/pg-dump.md)
14+
* [Storage & Retrieval](introduction/import-your-data/storage-and-retrieval/README.md)
15+
* [Documents](introduction/import-your-data/storage-and-retrieval/documents.md)
16+
* [Partitioning](introduction/import-your-data/storage-and-retrieval/partitioning.md)
17+
* [LLM based pipelines with PostgresML and dbt (data build tool)](introduction/import-your-data/storage-and-retrieval/llm-based-pipelines-with-postgresml-and-dbt-data-build-tool.md)
18+
* [FAQ](introduction/faq.md)
1919

2020
## Open Source
2121

22-
* [Overview](open-source/overview)
23-
* [PGML](open-source/pgml/README)
24-
* [API](open-source/pgml/api/README)
25-
* [pgml.embed()](open-source/pgml/api/pgml.embed)
26-
* [pgml.transform()](open-source/pgml/api/pgml.transform)
27-
* [pgml.transform_stream()](open-source/pgml/api/pgml.transform_stream)
28-
* [pgml.deploy()](open-source/pgml/api/pgml.deploy)
29-
* [pgml.decompose()](open-source/pgml/api/pgml.decompose)
30-
* [pgml.chunk()](open-source/pgml/api/pgml.chunk)
31-
* [pgml.generate()](open-source/pgml/api/pgml.generate)
32-
* [pgml.predict()](open-source/pgml/api/pgml.predict/README)
33-
* [Batch Predictions](open-source/pgml/api/pgml.predict/batch-predictions)
34-
* [pgml.train()](open-source/pgml/api/pgml.train)
35-
* [pgml.tune()](open-source/pgml/api/pgml.tune)
36-
* [Guides](open-source/pgml/guides/README)
37-
* [Embeddings](open-source/pgml/guides/embeddings/README)
38-
* [In-database Generation](open-source/pgml/guides/embeddings/in-database-generation)
39-
* [Dimensionality Reduction](open-source/pgml/guides/embeddings/dimensionality-reduction)
40-
* [Aggregation](open-source/pgml/guides/embeddings/vector-aggregation)
41-
* [Similarity](open-source/pgml/guides/embeddings/vector-similarity)
42-
* [Normalization](open-source/pgml/guides/embeddings/vector-normalization)
43-
* [LLMs](open-source/pgml/guides/llms/README)
44-
* [Fill-Mask](open-source/pgml/guides/llms/fill-mask)
45-
* [Question answering](open-source/pgml/guides/llms/question-answering)
46-
* [Summarization](open-source/pgml/guides/llms/summarization)
47-
* [Text classification](open-source/pgml/guides/llms/text-classification)
48-
* [Text Generation](open-source/pgml/guides/llms/text-generation)
49-
* [Text-to-Text Generation](open-source/pgml/guides/llms/text-to-text-generation)
50-
* [Token Classification](open-source/pgml/guides/llms/token-classification)
51-
* [Translation](open-source/pgml/guides/llms/translation)
52-
* [Zero-shot Classification](open-source/pgml/guides/llms/zero-shot-classification)
53-
* [Supervised Learning](open-source/pgml/guides/supervised-learning/README)
54-
* [Regression](open-source/pgml/guides/supervised-learning/regression)
55-
* [Classification](open-source/pgml/guides/supervised-learning/classification)
56-
* [Clustering](open-source/pgml/guides/supervised-learning/clustering)
57-
* [Decomposition](open-source/pgml/guides/supervised-learning/decomposition)
58-
* [Data Pre-processing](open-source/pgml/guides/supervised-learning/data-pre-processing)
59-
* [Hyperparameter Search](open-source/pgml/guides/supervised-learning/hyperparameter-search)
60-
* [Joint Optimization](open-source/pgml/guides/supervised-learning/joint-optimization)
61-
* [Search](open-source/pgml/guides/improve-search-results-with-machine-learning)
62-
* [Chatbots](open-source/pgml/guides/chatbots/README)
63-
* [Unified RAG](open-source/pgml/guides/unified-rag)
64-
* [Vector database](open-source/pgml/guides/vector-database)
22+
* [Overview](open-source/overview.md)
23+
* [PGML](open-source/pgml/README.md)
24+
* [API](open-source/pgml/api/README.md)
25+
* [pgml.embed()](open-source/pgml/api/pgml.embed.md)
26+
* [pgml.transform()](open-source/pgml/api/pgml.transform.md)
27+
* [pgml.transform_stream()](open-source/pgml/api/pgml.transform_stream.md)
28+
* [pgml.deploy()](open-source/pgml/api/pgml.deploy.md)
29+
* [pgml.decompose()](open-source/pgml/api/pgml.decompose.md)
30+
* [pgml.chunk()](open-source/pgml/api/pgml.chunk.md)
31+
* [pgml.generate()](open-source/pgml/api/pgml.generate.md)
32+
* [pgml.predict()](open-source/pgml/api/pgml.predict/README.md)
33+
* [Batch Predictions](open-source/pgml/api/pgml.predict/batch-predictions.md)
34+
* [pgml.train()](open-source/pgml/api/pgml.train.md)
35+
* [pgml.tune()](open-source/pgml/api/pgml.tune.md)
36+
* [Guides](open-source/pgml/guides/README.md)
37+
* [Embeddings](open-source/pgml/guides/embeddings/README.md)
38+
* [In-database Generation](open-source/pgml/guides/embeddings/in-database-generation.md)
39+
* [Dimensionality Reduction](open-source/pgml/guides/embeddings/dimensionality-reduction.md)
40+
* [Aggregation](open-source/pgml/guides/embeddings/vector-aggregation.md)
41+
* [Similarity](open-source/pgml/guides/embeddings/vector-similarity.md)
42+
* [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)
61+
* [Search](open-source/pgml/guides/improve-search-results-with-machine-learning.md)
62+
* [Chatbots](open-source/pgml/guides/chatbots/README.md)
63+
* [Unified RAG](open-source/pgml/guides/unified-rag.md)
64+
* [Vector database](open-source/pgml/guides/vector-database.md)
6565
<!--
6666
* [Search]()
6767
* [Keyword Search]()
@@ -92,53 +92,53 @@
9292
* [Sentiment Analysis]()
9393
* [Summarization]()
9494
-->
95-
* [Developers](open-source/pgml/developers/README)
96-
* [Local Docker Development](open-source/pgml/developers/quick-start-with-docker)
97-
* [Installation](open-source/pgml/developers/installation)
98-
* [Contributing](open-source/pgml/developers/contributing)
99-
* [Distributed Training](open-source/pgml/developers/distributed-training)
100-
* [GPU Support](open-source/pgml/developers/gpu-support)
101-
* [Self-hosting](open-source/pgml/developers/self-hosting/README)
102-
* [Pooler](open-source/pgml/developers/self-hosting/pooler)
103-
* [Building from source](open-source/pgml/developers/self-hosting/building-from-source)
104-
* [Replication](open-source/pgml/developers/self-hosting/replication)
105-
* [Backups](open-source/pgml/developers/self-hosting/backups)
106-
* [Running on EC2](open-source/pgml/developers/self-hosting/running-on-ec2)
107-
* [Korvus](open-source/korvus/README)
108-
* [API](open-source/korvus/api/README)
109-
* [Collections](open-source/korvus/api/collections)
110-
* [Pipelines](open-source/korvus/api/pipelines)
111-
* [Guides](open-source/korvus/guides/README)
112-
* [Constructing Pipelines](open-source/korvus/guides/constructing-pipelines)
113-
* [RAG](open-source/korvus/guides/rag)
114-
* [Vector Search](open-source/korvus/guides/vector-search)
115-
* [Document Search](open-source/korvus/guides/document-search)
116-
* [OpenSourceAI](open-source/korvus/guides/opensourceai)
117-
* [Example Apps](open-source/korvus/example-apps/README)
118-
* [Semantic Search](open-source/korvus/example-apps/semantic-search)
119-
* [RAG with OpenAI](open-source/korvus/example-apps/rag-with-openai)
120-
* [PgCat](open-source/pgcat/README)
121-
* [Features](open-source/pgcat/features)
122-
* [Installation](open-source/pgcat/installation)
123-
* [Configuration](open-source/pgcat/configuration)
95+
* [Developers](open-source/pgml/developers/README.md)
96+
* [Local Docker Development](open-source/pgml/developers/quick-start-with-docker.md)
97+
* [Installation](open-source/pgml/developers/installation.md)
98+
* [Contributing](open-source/pgml/developers/contributing.md)
99+
* [Distributed Training](open-source/pgml/developers/distributed-training.md)
100+
* [GPU Support](open-source/pgml/developers/gpu-support.md)
101+
* [Self-hosting](open-source/pgml/developers/self-hosting/README.md)
102+
* [Pooler](open-source/pgml/developers/self-hosting/pooler.md)
103+
* [Building from source](open-source/pgml/developers/self-hosting/building-from-source.md)
104+
* [Replication](open-source/pgml/developers/self-hosting/replication.md)
105+
* [Backups](open-source/pgml/developers/self-hosting/backups.md)
106+
* [Running on EC2](open-source/pgml/developers/self-hosting/running-on-ec2.md)
107+
* [Korvus](open-source/korvus/README.md)
108+
* [API](open-source/korvus/api/README.md)
109+
* [Collections](open-source/korvus/api/collections.md)
110+
* [Pipelines](open-source/korvus/api/pipelines.md)
111+
* [Guides](open-source/korvus/guides/README.md)
112+
* [Constructing Pipelines](open-source/korvus/guides/constructing-pipelines.md)
113+
* [RAG](open-source/korvus/guides/rag.md)
114+
* [Vector Search](open-source/korvus/guides/vector-search.md)
115+
* [Document Search](open-source/korvus/guides/document-search.md)
116+
* [OpenSourceAI](open-source/korvus/guides/opensourceai.md)
117+
* [Example Apps](open-source/korvus/example-apps/README.md)
118+
* [Semantic Search](open-source/korvus/example-apps/semantic-search.md)
119+
* [RAG with OpenAI](open-source/korvus/example-apps/rag-with-openai.md)
120+
* [PgCat](open-source/pgcat/README.md)
121+
* [Features](open-source/pgcat/features.md)
122+
* [Installation](open-source/pgcat/installation.md)
123+
* [Configuration](open-source/pgcat/configuration.md)
124124

125125
## Cloud
126126

127-
* [Overview](cloud/overview)
128-
* [Serverless](cloud/serverless)
129-
* [Dedicated](cloud/dedicated)
130-
* [Enterprise](cloud/enterprise/README)
131-
* [Teams](cloud/enterprise/teams)
132-
* [VPC](cloud/enterprise/vpc)
133-
* [Privacy Policy](cloud/privacy-policy)
134-
* [Terms of Service](cloud/terms-of-service)
127+
* [Overview](cloud/overview.md)
128+
* [Serverless](cloud/serverless.md)
129+
* [Dedicated](cloud/dedicated.md)
130+
* [Enterprise](cloud/enterprise/README.md)
131+
* [Teams](cloud/enterprise/teams.md)
132+
* [VPC](cloud/enterprise/vpc.md)
133+
* [Privacy Policy](cloud/privacy-policy.md)
134+
* [Terms of Service](cloud/terms-of-service.md)
135135

136136
<!--
137137
## TODO
138138
139139
-- Merge into Introduction > Overview
140-
* [Architecture](resources/architecture/README)
141-
* [Why PostgresML?](resources/architecture/why-postgresml)
140+
* [Architecture](resources/architecture/README.md)
141+
* [Why PostgresML?](resources/architecture/why-postgresml.md)
142142
143143
## Reference
144144

‎pgml-cms/docs/open-source/pgml/api/pgml.embed.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Generate high quality embeddings with faster end-to-end vector oper
44

55
# pgml.embed()
66

7-
The `pgml.embed()` function generates [embeddings](/docs/use-cases/embeddings/) from text, using in-database models downloaded from Hugging Face. Thousands of [open-source models](https://huggingface.co/models?library=sentence-transformers) are available and new and better ones are being published regularly.
7+
The `pgml.embed()` function generates [embeddings](/docs/open-source/pgml/guides/embeddings/) from text, using in-database models downloaded from Hugging Face. Thousands of [open-source models](https://huggingface.co/models?library=sentence-transformers) are available and new and better ones are being published regularly.
88

99
## API
1010

@@ -79,3 +79,7 @@ LIMIT 1;
7979
```
8080

8181
This query will return the quote with the most similar meaning to `'Feel the force!'` by generating an embedding of that quote and comparing it to all other embeddings in the table, using vector cosine similarity as the measure of distance.
82+
83+
## Examples
84+
85+
See the [embeddings](/docs/open-source/pgml/guides/embeddings/) guide for more examples.

0 commit comments

Comments
 (0)