From 65f47e9dba5bf608c224487ac8cf66bec734123b Mon Sep 17 00:00:00 2001 From: "opensearch-trigger-bot[bot]" <98922864+opensearch-trigger-bot[bot]@users.noreply.github.com> Date: Mon, 11 Sep 2023 18:13:06 -0700 Subject: [PATCH] fixing doc link (#1318) (#1319) * fixing doc link Signed-off-by: Dhrubo Saha * fixing indentation Signed-off-by: Dhrubo Saha --------- Signed-off-by: Dhrubo Saha (cherry picked from commit a43616993c1cb52a064baddae64bdf6a1388587b) Co-authored-by: Dhrubo Saha --- .../text_embedding_model_examples.md | 62 +++++++++---------- docs/tutorials/remote_inference.md | 4 +- 2 files changed, 33 insertions(+), 33 deletions(-) diff --git a/docs/model_serving_framework/text_embedding_model_examples.md b/docs/model_serving_framework/text_embedding_model_examples.md index ee04e11ae8..5c77f2a584 100644 --- a/docs/model_serving_framework/text_embedding_model_examples.md +++ b/docs/model_serving_framework/text_embedding_model_examples.md @@ -79,7 +79,7 @@ POST /_plugins/_ml/models/_register { "name": "huggingface/sentence-transformers/all-MiniLM-L12-v2", "version": "1.0.1", - "model_format": "TORCH_SCRIPT" + "model_format": "TORCH_SCRIPT", "model_group_id": "7IjOsYgBFp6IJxCceZ1-" } @@ -129,12 +129,12 @@ Now we can register model using URL upload: POST /_plugins/_ml/models/_register { "name": "sentence-transformers/all-MiniLM-L6-v2", - "version": "1.0.1", - "description": "This is a sentence-transformers model: It maps sentences & paragraphs to a 384 dimensional dense vector space and can be used for tasks like clustering or semantic search.", - "model_task_type": "TEXT_EMBEDDING", - "model_format": "TORCH_SCRIPT", - "model_content_hash_value": "c15f0d2e62d872be5b5bc6c84d2e0f4921541e29fefbef51d59cc10a8ae30e0f", - "model_config": { + "version": "1.0.1", + "description": "This is a sentence-transformers model: It maps sentences & paragraphs to a 384 dimensional dense vector space and can be used for tasks like clustering or semantic search.", + "model_task_type": "TEXT_EMBEDDING", + "model_format": "TORCH_SCRIPT", + "model_content_hash_value": "c15f0d2e62d872be5b5bc6c84d2e0f4921541e29fefbef51d59cc10a8ae30e0f", + "model_config": { "model_type": "bert", "embedding_dimension": 384, "framework_type": "sentence_transformers", @@ -303,18 +303,18 @@ The only difference is the uploading model input, for load/predict/profile/unloa # Sample request POST /_plugins/_ml/models/_upload { - "name": "sentence-transformers/all-MiniLM-L6-v2", - "version": "1.0.0", - "description": "test model", - "model_format": "TORCH_SCRIPT", - "model_config": { - "model_type": "bert", - "embedding_dimension": 384, - "framework_type": "huggingface_transformers", - "pooling_mode":"mean", - "normalize_result":"true" - }, - "url": "https://github.com/opensearch-project/ml-commons/raw/2.x/ml-algorithms/src/test/resources/org/opensearch/ml/engine/algorithms/text_embedding/all-MiniLM-L6-v2_torchscript_huggingface.zip?raw=true" + "name": "sentence-transformers/all-MiniLM-L6-v2", + "version": "1.0.0", + "description": "test model", + "model_format": "TORCH_SCRIPT", + "model_config": { + "model_type": "bert", + "embedding_dimension": 384, + "framework_type": "huggingface_transformers", + "pooling_mode":"mean", + "normalize_result":"true" + }, + "url": "https://github.com/opensearch-project/ml-commons/raw/2.x/ml-algorithms/src/test/resources/org/opensearch/ml/engine/algorithms/text_embedding/all-MiniLM-L6-v2_torchscript_huggingface.zip?raw=true" } ``` @@ -330,17 +330,17 @@ The only difference is the uploading model input, for load/predict/profile/unloa # Sample request POST /_plugins/_ml/models/_upload { - "name": "sentence-transformers/all-MiniLM-L6-v2", - "version": "1.0.0", - "description": "test model", - "model_format": "ONNX", - "model_config": { - "model_type": "bert", - "embedding_dimension": 384, - "framework_type": "huggingface_transformers", - "pooling_mode":"mean", - "normalize_result":"true" - }, - "url": "https://github.com/opensearch-project/ml-commons/raw/2.x/ml-algorithms/src/test/resources/org/opensearch/ml/engine/algorithms/text_embedding/all-MiniLM-L6-v2_onnx.zip?raw=true" + "name": "sentence-transformers/all-MiniLM-L6-v2", + "version": "1.0.0", + "description": "test model", + "model_format": "ONNX", + "model_config": { + "model_type": "bert", + "embedding_dimension": 384, + "framework_type": "huggingface_transformers", + "pooling_mode":"mean", + "normalize_result":"true" + }, + "url": "https://github.com/opensearch-project/ml-commons/raw/2.x/ml-algorithms/src/test/resources/org/opensearch/ml/engine/algorithms/text_embedding/all-MiniLM-L6-v2_onnx.zip?raw=true" } ``` diff --git a/docs/tutorials/remote_inference.md b/docs/tutorials/remote_inference.md index 8cd653b3a9..8120c90cdc 100644 --- a/docs/tutorials/remote_inference.md +++ b/docs/tutorials/remote_inference.md @@ -54,7 +54,7 @@ That means if user have access to a model group, they have access to all model v # Connector -A connector defines protocol between ml-commons and external ML service. Read this [connector doc](https://opensearch.org/docs/latest/ml-commons-plugin/connectors/) for more details. +A connector defines protocol between ml-commons and external ML service. Read this [connector doc](https://opensearch.org/docs/latest/ml-commons-plugin/extensibility/connectors/) for more details. A connector consists of 7 parts @@ -473,4 +473,4 @@ POST _plugins/_ml/models/AFeTb4kBJ1eYAeTMSVl0/_predict ] } } -``` \ No newline at end of file +```