GITBOOK-128: No subject

Moloejoe · gitbook-bot · commit 46922dc1838b · 2024-03-19T21:20:54.000Z
diff --git a/pgml-cms/docs/api/client-sdk/collections.md b/pgml-cms/docs/api/client-sdk/collections.md
@@ -1,3 +1,9 @@
+---
+description: >-
+  Organizational building blocks of the SDK. Manage all documents and related
+  chunks, embeddings, tsvectors, and pipelines.
+---
+
 # Collections
 
 Collections are the organizational building blocks of the SDK. They manage all documents and related chunks, embeddings, tsvectors, and pipelines.
@@ -130,7 +136,7 @@ await collection.upsert_documents(documents)
 {% endtab %}
 {% endtabs %}
 
-Documents  can be merged by setting the `merge` option. On conflict, new document keys will override old document keys.
+Documents can be merged by setting the `merge` option. On conflict, new document keys will override old document keys.
 
 {% tabs %}
 {% tab title="JavaScript" %}
diff --git a/pgml-cms/docs/api/client-sdk/pipelines.md b/pgml-cms/docs/api/client-sdk/pipelines.md
@@ -1,3 +1,9 @@
+---
+description: >-
+  Pipelines are composed of a model, splitter, and additional optional
+  arguments.
+---
+
 # Pipelines
 
 `Pipeline`s define the schema for the transformation of documents. Different `Pipeline`s can be used for different tasks.
@@ -263,7 +269,7 @@ await collection.enable_pipeline(pipeline)
 {% endtab %}
 {% endtabs %}
 
-Enabling a `Pipeline` will cause it to automatically run  on all documents it may have missed while disabled.
+Enabling a `Pipeline` will cause it to automatically run on all documents it may have missed while disabled.
 
 ## **Remove a Pipeline**
 
diff --git a/pgml-cms/docs/api/client-sdk/tutorials/semantic-search.md b/pgml-cms/docs/api/client-sdk/tutorials/semantic-search.md
@@ -1,5 +1,7 @@
 ---
-description: Example for Semantic Search
+description: >-
+  JavaScript and Python code snippets for using instructor models in more
+  advanced search use cases.
 ---
 
 # Semantic Search
diff --git a/pgml-cms/docs/api/sql-extension/pgml.deploy.md b/pgml-cms/docs/api/sql-extension/pgml.deploy.md
@@ -1,3 +1,9 @@
+---
+description: >-
+  Release trained models when ML quality metrics computed during training
+  improve. Track model deployments over time and rollback if needed.
+---
+
 # pgml.deploy()
 
 ## Deployments
diff --git a/pgml-cms/docs/api/sql-extension/pgml.embed.md b/pgml-cms/docs/api/sql-extension/pgml.embed.md
@@ -1,3 +1,9 @@
+---
+description: >-
+  Generate high quality embeddings with faster end-to-end vector operations
+  without an additional vector database.
+---
+
 # pgml.embed()
 
 Embeddings are a numeric representation of text. They are used to represent words and sentences as vectors, an array of numbers. Embeddings can be used to find similar pieces of text, by comparing the similarity of the numeric vectors using a distance measure, or they can be used as input features for other machine learning models, since most algorithms can't use text directly.
diff --git a/pgml-cms/docs/api/sql-extension/pgml.predict/README.md b/pgml-cms/docs/api/sql-extension/pgml.predict/README.md
@@ -1,3 +1,9 @@
+---
+description: >-
+  Batch predict from data in a table. Online predict with parameters passed in a
+  query. Automatically reuse pre-processing steps from training.
+---
+
 # pgml.predict()
 
 ## API
@@ -51,7 +57,7 @@ LIMIT 25;
 
 ### Classification Example
 
-If you've already been through the [pgml.train](../../../api/sql-extension/pgml.train/ "mention") examples, you can see the predictive results of those models:
+If you've already been through the [pgml.train](../pgml.train "mention") examples, you can see the predictive results of those models:
 
 ```sql
 SELECT
diff --git a/pgml-cms/docs/api/sql-extension/pgml.train/README.md b/pgml-cms/docs/api/sql-extension/pgml.train/README.md
@@ -1,8 +1,7 @@
 ---
 description: >-
-  The training function is at the heart of PostgresML. It's a powerful single
-  mechanism that can handle many different training tasks which are configurable
-  with the function parameters.
+  Pre-process and pull data to train a model using any of 50 different ML
+  algorithms.
 ---
 
 # pgml.train()
diff --git a/pgml-cms/docs/api/sql-extension/pgml.transform/README.md b/pgml-cms/docs/api/sql-extension/pgml.transform/README.md
@@ -1,4 +1,7 @@
 ---
+description: >-
+  Perform dozens of state-of-the-art natural language processing (NLP) tasks
+  with thousands of models. Serve with the same Postgres infrastructure.
 layout:
   title:
     visible: true
diff --git a/pgml-cms/docs/api/sql-extension/pgml.tune.md b/pgml-cms/docs/api/sql-extension/pgml.tune.md
@@ -1,3 +1,7 @@
+---
+description: Fine tune open-source models on your own data.
+---
+
 # pgml.tune()
 
 ## Fine Tuning
