Skip to content

armgit / dspy

Public Imported from GitHub
0

DSPy: The framework for programming—not prompting—language models

Python

update LM/RM docs

Arnav Singhvib2a9ae4df251
diff --git a/docs/api/language_model_clients/Cohere.md b/docs/api/language_model_clients/Cohere.md
index f3a39e1e6..f9f874697 100644
--- a/docs/api/language_model_clients/Cohere.md
+++ b/docs/api/language_model_clients/Cohere.md
@@ -2,12 +2,12 @@
sidebar_position: 3
---
-# dsp.Cohere
+# dspy.Cohere
### Usage
```python
-lm = dsp.Cohere(model='command-nightly')
+lm = dspy.Cohere(model='command-nightly')
```
### Constructor
diff --git a/docs/api/language_model_clients/Google_VertexAI.md b/docs/api/language_model_clients/Google_VertexAI.md
index bd8efc90e..bfd40a64c 100644
--- a/docs/api/language_model_clients/Google_VertexAI.md
+++ b/docs/api/language_model_clients/Google_VertexAI.md
@@ -1,4 +1,8 @@
-# GoogleVertexAI Usage Guide
+---
+sidebar_position: 11
+---
+
+# dspy.GoogleVertexAI
This guide provides instructions on how to use the `GoogleVertexAI` class to interact with Google Vertex AI's API for text and code generation.
diff --git a/docs/api/language_model_clients/Mistral.md b/docs/api/language_model_clients/Mistral.md
index 1d9293938..e7a4a7fe0 100644
--- a/docs/api/language_model_clients/Mistral.md
+++ b/docs/api/language_model_clients/Mistral.md
@@ -2,12 +2,12 @@
sidebar_position: 9
---
-# dsp.Mistral
+# dspy.Mistral
### Usage
```python
-lm = dsp.Mistral(model='mistral-medium-latest', api_key="your-mistralai-api-key")
+lm = dspy.Mistral(model='mistral-medium-latest', api_key="your-mistralai-api-key")
```
### Constructor
@@ -31,4 +31,4 @@ class Mistral(LM):
### Methods
-Refer to [`dspy.Mistral`](#) documentation.
+Refer to [`dspy.OpenAI`](https://dspy-docs.vercel.app/api/language_model_clients/OpenAI) documentation.
diff --git a/docs/api/language_model_clients/PremAI.md b/docs/api/language_model_clients/PremAI.md
index 925601dfd..0296750b4 100644
--- a/docs/api/language_model_clients/PremAI.md
+++ b/docs/api/language_model_clients/PremAI.md
@@ -2,7 +2,7 @@
sidebar_position: 5
---
-# dsp.PremAI
+# dspy.PremAI
[PremAI](https://app.premai.io) is an all-in-one platform that simplifies the process of creating robust, production-ready applications powered by Generative AI. By streamlining the development process, PremAI allows you to concentrate on enhancing user experience and driving overall growth for your application.
@@ -18,7 +18,7 @@ Please make sure you have premai python sdk installed. Otherwise you can do it u
pip install -U premai
```
-Here is a quick example on how to use premai python sdk with dspy
+Here is a quick example on how to use premai python sdk with DSPy
```python
from dspy import PremAI
diff --git a/docs/api/language_model_clients/Snowflake.md b/docs/api/language_model_clients/Snowflake.md
index 0266fa443..7ffc49af3 100644
--- a/docs/api/language_model_clients/Snowflake.md
+++ b/docs/api/language_model_clients/Snowflake.md
@@ -1,3 +1,7 @@
+---
+sidebar_position: 12
+---
+
# dspy.Snowflake
### Usage
diff --git a/docs/api/language_model_clients/Watsonx.md b/docs/api/language_model_clients/Watsonx.md
index 2afaabbd8..b6ef27bdb 100644
--- a/docs/api/language_model_clients/Watsonx.md
+++ b/docs/api/language_model_clients/Watsonx.md
@@ -1,4 +1,8 @@
-# Watsonx Usage Guide
+---
+sidebar_position: 12
+---
+
+# dspy.Watsonx
This guide provides instructions on how to use the `Watsonx` class to interact with IBM Watsonx.ai API for text and code generation.
diff --git a/docs/api/retrieval_model_clients/AzureCognitiveSearch.md b/docs/api/retrieval_model_clients/AzureCognitiveSearch.md
index bb210e830..832184563 100644
--- a/docs/api/retrieval_model_clients/AzureCognitiveSearch.md
+++ b/docs/api/retrieval_model_clients/AzureCognitiveSearch.md
@@ -1,5 +1,5 @@
---
-sidebar_position: 3
+sidebar_position: 2
---
# retrieve.AzureCognitiveSearch
diff --git a/docs/api/retrieval_model_clients/ChromadbRM.md b/docs/api/retrieval_model_clients/ChromadbRM.md
index f4da4836a..cfff233d2 100644
--- a/docs/api/retrieval_model_clients/ChromadbRM.md
+++ b/docs/api/retrieval_model_clients/ChromadbRM.md
@@ -1,5 +1,5 @@
---
-sidebar_position: 2
+sidebar_position: 3
---
# retrieve.ChromadbRM
diff --git a/docs/api/retrieval_model_clients/MilvusRM.md b/docs/api/retrieval_model_clients/MilvusRM.md
index 1f5e2ff2a..e8fb41e42 100644
--- a/docs/api/retrieval_model_clients/MilvusRM.md
+++ b/docs/api/retrieval_model_clients/MilvusRM.md
@@ -1,5 +1,5 @@
---
-sidebar_position: 1
+sidebar_position: 5
---
# retrieve.MilvusRM
diff --git a/docs/api/MyScaleRM.md b/docs/api/retrieval_model_clients/MyScaleRM.md
similarity index 99%
rename from docs/api/MyScaleRM.md
rename to docs/api/retrieval_model_clients/MyScaleRM.md
index 717e991a6..08c07b1a1 100644
--- a/docs/api/MyScaleRM.md
+++ b/docs/api/retrieval_model_clients/MyScaleRM.md
@@ -1,8 +1,9 @@
---
-sidebar_position: 8
+sidebar_position: 6
---
# retrieve.MyScaleRM
+
## Constructor
Initializes an instance of the `MyScaleRM` class, which is designed to use MyScaleDB (a ClickHouse fork optimized for vector similarity and full-text search) to retrieve documents based on query embeddings. This class supports embedding generation using either local models or OpenAI's API and manages database interactions efficiently.
diff --git a/docs/api/retrieval_model_clients/Neo4jRM.md b/docs/api/retrieval_model_clients/Neo4jRM.md
index 6b408b780..ca153431d 100644
--- a/docs/api/retrieval_model_clients/Neo4jRM.md
+++ b/docs/api/retrieval_model_clients/Neo4jRM.md
@@ -1,3 +1,6 @@
+---
+sidebar_position: 7
+---
# retrieve.neo4j_rm
diff --git a/docs/api/retrieval_model_clients/RAGatouilleRM.md b/docs/api/retrieval_model_clients/RAGatouilleRM.md
index 4780b106a..de7a73399 100644
--- a/docs/api/retrieval_model_clients/RAGatouilleRM.md
+++ b/docs/api/retrieval_model_clients/RAGatouilleRM.md
@@ -1,8 +1,8 @@
---
-sidebar_position: 5
+sidebar_position: 8
---
-# dspy.RAGatouilleRM
+# retrieve.RAGatouilleRM
### Constructor
diff --git a/docs/api/retrieval_model_clients/SnowflakeRM.md b/docs/api/retrieval_model_clients/SnowflakeRM.md
index 65112c84c..c0f4d89bc 100644
--- a/docs/api/retrieval_model_clients/SnowflakeRM.md
+++ b/docs/api/retrieval_model_clients/SnowflakeRM.md
@@ -1,3 +1,7 @@
+---
+sidebar_position: 9
+---
+
# retrieve.SnowflakeRM
### Constructor
diff --git a/docs/api/retrieval_model_clients/WatsonDiscovery.md b/docs/api/retrieval_model_clients/WatsonDiscovery.md
index c046a78fe..3bb358ce8 100644
--- a/docs/api/retrieval_model_clients/WatsonDiscovery.md
+++ b/docs/api/retrieval_model_clients/WatsonDiscovery.md
@@ -1,5 +1,5 @@
---
-sidebar_position: 1
+sidebar_position: 10
---
# retrieve.WatsonDiscoveryRM