fixing docs (opensearch-project#1193)

Signed-off-by: Dhrubo Saha <[email protected]>
HenryL27 · Sep 1, 2023 · 81c79d5 · 81c79d5
1 parent 5de485e
commit 81c79d5
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 16 deletions.
diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md
@@ -59,7 +59,7 @@ Fork ml-commons by clicking the "Fork" button at the top of the [GitHub reposito
 Clone your forked version of ml-commons to your local machine (replace `opensearch-project` in the command below with your GitHub username):
 
 ```bash
-$ git clone [email protected]:opensearch-project/opensearch-py-ml.git
+$ git clone [email protected]:opensearch-project/ml-commons.git
 ```
 
 ### Run OpenSearch

diff --git a/docs/remote_inference_blueprints/cohere_connector_embedding_blueprint.md b/docs/remote_inference_blueprints/cohere_connector_embedding_blueprint.md
@@ -5,9 +5,9 @@
 ```json
 POST /_plugins/_ml/connectors/_create
 {
-  "name": "<YOUR MODEL NAME>",
-  "description": "<YOUR MODEL DESCRIPTION>",
-  "version": "<YOUR MODEL VERSION>",
+  "name": "<YOUR CONNECTOR NAME>",
+  "description": "<YOUR CONNECTOR DESCRIPTION>",
+  "version": "<YOUR CONNECTOR VERSION>",
   "protocol": "http",
   "credential": {
     "cohere_key": "<PLEASE ADD YOUR Cohere API KEY HERE>"

diff --git a/docs/remote_inference_blueprints/cohere_connector_rerank_blueprint.md b/docs/remote_inference_blueprints/cohere_connector_rerank_blueprint.md
@@ -5,9 +5,9 @@
 ```json
 POST /_plugins/_ml/connectors/_create
 {
-  "name": "<YOUR MODEL NAME>",
-  "description": "<YOUR MODEL DESCRIPTION>",
-  "version": "<YOUR MODEL VERSION>",
+  "name": "<YOUR CONNECTOR NAME>",
+  "description": "<YOUR CONNECTOR DESCRIPTION>",
+  "version": "<YOUR CONNECTOR VERSION>",
   "protocol": "http",
   "parameters": {
     "endpoint": "api.cohere.ai",

diff --git a/docs/remote_inference_blueprints/open_ai_connector_chat_blueprint.md b/docs/remote_inference_blueprints/open_ai_connector_chat_blueprint.md
@@ -4,9 +4,9 @@
 ```json
 POST /_plugins/_ml/connectors/_create
 {
-  "name": "<YOUR MODEL NAME>",
-  "description": "<YOUR MODEL DESCRIPTION>",
-  "version": "<YOUR MODEL VERSION>",
+  "name": "<YOUR CONNECTOR NAME>",
+  "description": "<YOUR CONNECTOR DESCRIPTION>",
+  "version": "<YOUR CONNECTOR VERSION>",
   "protocol": "http",
   "parameters": {
     "endpoint": "api.openai.com",

diff --git a/docs/remote_inference_blueprints/open_ai_connector_completion_blueprint.md b/docs/remote_inference_blueprints/open_ai_connector_completion_blueprint.md
@@ -5,9 +5,9 @@
 ```json
 POST /_plugins/_ml/connectors/_create
 {
-    "name": "<YOUR MODEL NAME>",
-    "description": "<YOUR MODEL DESCRIPTION>",
-    "version": "<YOUR MODEL VERSION>",
+    "name": "<YOUR CONNECTOR NAME>",
+    "description": "<YOUR CONNECTOR DESCRIPTION>",
+    "version": "<YOUR CONNECTOR VERSION>",
     "protocol": "http",
     "parameters": {
         "endpoint": "api.openai.com",

diff --git a/docs/remote_inference_blueprints/sagemaker_connector_blueprint.md b/docs/remote_inference_blueprints/sagemaker_connector_blueprint.md
@@ -3,9 +3,9 @@
 ```json
 POST /_plugins/_ml/connectors/_create
 {
-  "name": "<YOUR MODEL NAME>",
-  "description": "<YOUR MODEL DESCRIPTION>",
-  "version": "<YOUR MODEL VERSION>",
+  "name": "<YOUR CONNECTOR NAME>",
+  "description": "<YOUR CONNECTOR DESCRIPTION>",
+  "version": "<YOUR CONNECTOR VERSION>",
   "protocol": "aws_sigv4",
   "credential": {
     "access_key": "<PLEASE ADD YOUR AWS ACCESS KEY HERE>",