Add model access control documentation for ML Commons #4223

kolchfa-aws · 2023-06-02T20:03:05Z

Fixes #3514

Checklist

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

rbhavna · 2023-06-07T22:35:30Z

_ml-commons-plugin/model-access-control.md

+
+- `public`: All users who have access to the cluster can access this model group.
+- `private`: Only the model owner or an admin user can access this model group.
+- `restricted`: The owner, an admin user, or any user who shares one of the model group's backend roles can access any model in this model group. When creating a `restricted` model group, the owner must attach one or more of the owner's backend roles to the model. For a user to be able to access a model group, one of the user's backend roles must match one of the model group's backend roles. This grants the user permissions associated with the user role to which that backend role is mapped. For example, if the backend role is mapped to the `ml_full_access` user role, users with this role can use the Register, Deploy, Predict, Delete, Search and Get Model APIs on any model in this model group. 


ml_full_access is the permission/security role actually. Also its not necessary a backend role should be mapped to these permission roles, a user can directly be mapped to these permission roles. For example, a user is direclt mapped to "ml_full_access" and has a backend role of that of a model group, then then can perform all the said actions on the models of this group. We might have to rephrase this paragraph a little.

Thank you for the clarification, reworded.

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

ylwu-amzn · 2023-06-08T17:43:00Z

_ml-commons-plugin/api.md

 }
 ```

 ## Registering a model

 Use the register operation to register a custom model to a model index. ML Commons splits the model into smaller chunks and saves those chunks in the model's index.

+### Model access control considerations
+
+For clusters with model access control enabled, the following users can register new model versions for model groups with the specified access levels:


How about add a link to the cluster setting for model access control enabled ? So user can know how to enable model access control

Ignore the comment, see line 171 already has a link to model access control page.

ylwu-amzn · 2023-06-08T17:47:05Z

_ml-commons-plugin/api.md

+    "description": "test model",
+    "model_format": "TORCH_SCRIPT",
+    "model_group_id": "FTNlQ4gBYW0Qyy5ZoxfR",
+    "model_content_hash_value": "9376c2ebd7c83f99ec2526323786c348d2382e6d86576f750c89ea544d6bbb14",


model_content_hash_value is mandatory, add this field to filed table above? Explain that the hash value is using sha-256

ylwu-amzn · 2023-06-08T17:48:39Z

_ml-commons-plugin/api.md

+        "framework_type": "sentence_transformers",
+       "all_config": "{\"_name_or_path\":\"nreimers/MiniLM-L6-H384-uncased\",\"architectures\":[\"BertModel\"],\"attention_probs_dropout_prob\":0.1,\"gradient_checkpointing\":false,\"hidden_act\":\"gelu\",\"hidden_dropout_prob\":0.1,\"hidden_size\":384,\"initializer_range\":0.02,\"intermediate_size\":1536,\"layer_norm_eps\":1e-12,\"max_position_embeddings\":512,\"model_type\":\"bert\",\"num_attention_heads\":12,\"num_hidden_layers\":6,\"pad_token_id\":0,\"position_embedding_type\":\"absolute\",\"transformers_version\":\"4.8.2\",\"type_vocab_size\":2,\"use_cache\":true,\"vocab_size\":30522}"
+    },
+    "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_sentence-transformer.zip?raw=true"


This file is in github test code, we add this as the pre-trained model not uploaded to model repo yet.
How about change to https://artifacts.opensearch.org/models/ml-models/huggingface/sentence-transformers/all-MiniLM-L6-v2/1.0.1/torch_script/sentence-transformers_all-MiniLM-L6-v2-1.0.1-torch_script.zip

And the model_content_hash_value change to c15f0d2e62d872be5b5bc6c84d2e0f4921541e29fefbef51d59cc10a8ae30e0f

ylwu-amzn · 2023-06-08T17:52:16Z

_ml-commons-plugin/api.md

 }
 ```

 ## Deploying a model

 The deploy model operation reads the model's chunks from the model index and then creates an instance of the model to cache into memory. This operation requires the `model_id`.

+### Model access control considerations
+
+For clusters with model access control enabled, the following users can deploy models in model groups with the specified access levels:


This part seems same with register model API. Actually model access control will be applied to all APIs for uploaded model. Maybe we don't need to specifically mention the access control for register and deploy model API.

ylwu-amzn · 2023-06-08T18:03:43Z

_ml-commons-plugin/api.md

+"created_time" : 1665961344044,
+"last_uploaded_time" : 1665961373000,
+"last_loaded_time" : 1665961815959,
+"total_chunks" : 9
 }
 ```

 ## Registering a model


Add register model group API? User need to register model group first, then register model version to model group.

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

rbhavna · 2023-06-13T18:14:31Z

_ml-commons-plugin/model-access-control.md

+          "last_updated_time": 1684362571300,
+          "name": "model_group_test",
+          "description": "This is an example description",
+          "tags": {


Can we remove the tags fields and the keys from this response? We actually removed this field and this happened to be an old response.

rbhavna · 2023-06-13T18:16:18Z

_ml-commons-plugin/model-access-control.md

+
+- `public`: All users who have access to the cluster can access this model group.
+- `private`: Only the model owner or an admin user can access this model group.
+- `restricted`: The owner, an admin user, or any user who shares one of the model group's backend roles can access any model in this model group. When creating a `restricted` model group, the owner must attach one or more of the owner's backend roles to the model. For a user to be able to access a model group, one of the user's backend roles must match one of the model group's backend roles. 


Maybe remove the last line here. It seems the same as first sentence.

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

cwillum

Let me know if you have questions for any of the comments/suggestions. We can revisit any of these a second time.

cwillum · 2023-06-14T02:54:30Z

_ml-commons-plugin/api.md

+
+- `public` model group: Any user.
+- `restricted` model group: Only the model owner or users with at least one backend role matching one of the backend roles of this model group.
+-  `private` model group: Only the model owner. 


Is there an extra space in front of private?

_ml-commons-plugin/api.md

cwillum · 2023-06-14T19:18:26Z

_ml-commons-plugin/model-access-control.md

+Only admin users can assign backend roles to users.
+{: .note}
+
+For example, consider two users: `alice` and `bob`.


I would set up this example with different language. Something like, "When assigning backend roles, consider the following example:"

And I think the language from the Security Analytics Security page would fit better here, too (same example but worded better).
https://opensearch.org/docs/latest/security-analytics/security/

_ml-commons-plugin/model-access-control.md

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Co-authored-by: Chris Moore <107723039+cwillum@users.noreply.github.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

…ct/documentation-website into ml-model-access

kolchfa-aws · 2023-06-14T21:24:35Z

@cwillum Reworded and implemented comments. Please review again when you get a chance. Thanks!

cwillum

Looks good.

vagimeli

Please see the edits and suggested comments. Overall content is in good shape. Edits are copyedits for style guide compliance and clarity of information. Please let me know if we need to sync to discuss any editorial feedback. Thanks!

vagimeli · 2023-06-15T23:26:52Z

_ml-commons-plugin/api.md


-In order to train tasks through the API, three inputs are required. 
+In order to train tasks through the API, three inputs are required: 


Suggested change

In order to train tasks through the API, three inputs are required:

To train tasks through the API, three inputs are required:

vagimeli · 2023-06-15T23:31:05Z

_ml-commons-plugin/api.md


 - Algorithm name: Must be one of a [FunctionName](https://github.com/opensearch-project/ml-commons/blob/1.3/common/src/main/java/org/opensearch/ml/common/parameter/FunctionName.java). This determines what algorithm the ML Engine runs. To add a new function, see [How To Add a New Function](https://github.com/opensearch-project/ml-commons/blob/main/docs/how-to-add-new-function.md).
- Model hyper parameters: Adjust these parameters to make the model train better.  
+- Model hyperparameters: Adjust these parameters to make the model train better.  


Suggested rewrite: "Model hyperparameters: Adjust these parameters to improve model accuracy."

vagimeli · 2023-06-15T23:36:33Z

_ml-commons-plugin/api.md


 - Algorithm name: Must be one of a [FunctionName](https://github.com/opensearch-project/ml-commons/blob/1.3/common/src/main/java/org/opensearch/ml/common/parameter/FunctionName.java). This determines what algorithm the ML Engine runs. To add a new function, see [How To Add a New Function](https://github.com/opensearch-project/ml-commons/blob/main/docs/how-to-add-new-function.md).
- Model hyper parameters: Adjust these parameters to make the model train better.  
+- Model hyperparameters: Adjust these parameters to make the model train better.  
 - Input data: The data input that trains the ML model, or applies the ML models to predictions. You can input data in two ways, query against your index or use data frame.


Suggested change

- Input data: The data input that trains the ML model, or applies the ML models to predictions. You can input data in two ways, query against your index or use data frame.

- Input data: The data that trains the ML model, or applies the ML models to predictions. You can input data in two ways, query against your index or use a data frame.

_ml-commons-plugin/api.md

vagimeli · 2023-06-16T20:41:47Z

_ml-commons-plugin/api.md

+```
+{% include copy-curl.html %}
+
+The response contains the model ID of the model version:


Suggested change

The response contains the model ID of the model version:

The response contains the model ID of the model version:

Suggested change

The response contains the model ID of the model version:

The response contains the `model_ID` of the model version:

Similarly to the above comment, I think it's ok.

vagimeli · 2023-06-16T20:46:34Z

_ml-commons-plugin/api.md

-model_id | string | Returns runtime data for a specific model. You can string together multiple `model_id`s to return multiple model profiles.
-tasks | string | Returns runtime data for a specific task. You can string together multiple `task_id`s to return multiple task profiles.
+model_id | String | Returns runtime data for a specific model. You can string together multiple `model_id`s to return multiple model profiles.
+tasks | String | Returns runtime data for a specific task. You can string together multiple `task_id`s to return multiple task profiles.


Should "tasks" be task_id? Or, model_id be "models?" See lines 514 and 515.

tasks is correct. I put everything in tic marks though.

_ml-commons-plugin/api.md

vagimeli · 2023-06-16T20:53:16Z

_ml-commons-plugin/index.md

@@ -13,17 +13,16 @@ ML Commons for OpenSearch eases the development of machine learning features by

 Interaction with the ML Commons plugin occurs through either the [REST API]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api) or [`ad`]({{site.url}}{{site.baseurl}}/search-plugins/sql/ppl/functions#ad) and [`kmeans`]({{site.url}}{{site.baseurl}}/search-plugins/sql/ppl/functions#kmeans) Piped Processing Language (PPL) commands.

-Models [trained]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api#train-model) through the ML Commons plugin support model-based algorithms such as kmeans. After you've trained a model enough so that it meets your precision requirements, you can apply the model to [predict]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api#predict) new data safely. 
+Models [trained]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api#train-model) through the ML Commons plugin support model-based algorithms such as k-means. After you've trained a model enough so that it meets your precision requirements, you can apply the model to [predict]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api#predict) new data safely. 


Line 12: Define ML on first mention as follows: "ML Commons for...of machine learning (ML)..."

_ml-commons-plugin/model-access-control.md

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add model access control documentation for ML Commons Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove permissions for delete API Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add copy buttons Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Updated model-level APIs Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add delete model Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Reworded role-related text Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Implemented tech review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Rewording Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove experimental warning Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Register a model group in note format Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Implement tech review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Resolved Vale comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove space Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Chris Moore <107723039+cwillum@users.noreply.github.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Implemented doc review feedback Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Implemented editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Add more editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add more editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Fix links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Fix more links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Chris Moore <107723039+cwillum@users.noreply.github.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com>

This reverts commit e69009b.

* Add model access control documentation for ML Commons Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove permissions for delete API Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add copy buttons Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Updated model-level APIs Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add delete model Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Reworded role-related text Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Implemented tech review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Rewording Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove experimental warning Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Register a model group in note format Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Implement tech review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Resolved Vale comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove space Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Chris Moore <107723039+cwillum@users.noreply.github.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Implemented doc review feedback Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Implemented editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Add more editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add more editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Fix links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Fix more links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Chris Moore <107723039+cwillum@users.noreply.github.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

This reverts commit e69009b. Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

…ject#4223) * Add model access control documentation for ML Commons Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove permissions for delete API Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add copy buttons Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Updated model-level APIs Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add delete model Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Reworded role-related text Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Implemented tech review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Rewording Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove experimental warning Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Register a model group in note format Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Implement tech review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Resolved Vale comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove space Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Chris Moore <107723039+cwillum@users.noreply.github.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Implemented doc review feedback Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Implemented editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Add more editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add more editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Fix links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Fix more links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Chris Moore <107723039+cwillum@users.noreply.github.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com>

* Add model access control documentation for ML Commons Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove permissions for delete API Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add copy buttons Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Updated model-level APIs Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add delete model Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Reworded role-related text Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Implemented tech review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Rewording Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove experimental warning Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Register a model group in note format Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Implement tech review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Resolved Vale comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Remove space Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Chris Moore <107723039+cwillum@users.noreply.github.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Implemented doc review feedback Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Implemented editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Add more editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add more editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Fix links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Fix more links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Chris Moore <107723039+cwillum@users.noreply.github.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com>

Add model access control documentation for ML Commons

8b6a768

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

kolchfa-aws requested review from cwillum, hdhalter, Naarcha-AWS, vagimeli, ananzh, seanneumann, AMoo-Miki and natebower as code owners June 2, 2023 20:03

kolchfa-aws added 2 commits June 5, 2023 10:22

Remove permissions for delete API

5df27b5

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Add copy buttons

8d0a421

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

kolchfa-aws self-assigned this Jun 6, 2023

kolchfa-aws added the v2.9.0 label Jun 6, 2023

kolchfa-aws added 2 commits June 7, 2023 17:22

Updated model-level APIs

ec90b23

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Add delete model

018a5b0

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

rbhavna reviewed Jun 7, 2023

View reviewed changes

Reworded role-related text

33749c6

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

ylwu-amzn reviewed Jun 8, 2023

View reviewed changes

kolchfa-aws added 4 commits June 8, 2023 18:53

Implemented tech review comments

d512817

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Rewording

4f22b86

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Remove experimental warning

670d2cf

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Register a model group in note format

e1026a8

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

rbhavna reviewed Jun 13, 2023

View reviewed changes

Implement tech review comments

b85ab3e

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

rbhavna approved these changes Jun 13, 2023

View reviewed changes

Resolved Vale comments

baf1faa

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

cwillum reviewed Jun 14, 2023

View reviewed changes

kolchfa-aws and others added 4 commits June 14, 2023 16:39

Remove space

18ab382

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Apply suggestions from code review

1e888ff

Co-authored-by: Chris Moore <107723039+cwillum@users.noreply.github.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

Implemented doc review feedback

c1542d8

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Merge branch 'ml-model-access' of https://github.com/opensearch-proje…

0d52ae7

…ct/documentation-website into ml-model-access

cwillum approved these changes Jun 14, 2023

View reviewed changes

vagimeli reviewed Jun 16, 2023

View reviewed changes

kolchfa-aws and others added 7 commits June 19, 2023 14:04

Implemented editorial comments

0ae9d1a

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Apply suggestions from code review

bebf080

Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

Add more editorial comments

92d3735

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Resolved merge conflicts

e1ae5b5

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Add more editorial comments

2ccaf9f

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Fix links

e6f9cb3

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Fix more links

775b291

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

vagimeli approved these changes Jun 19, 2023

View reviewed changes

One last editorial comment

ea4d8e2

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

kolchfa-aws merged commit 52b4a9e into main Jun 19, 2023

vagimeli added a commit that referenced this pull request Jun 23, 2023

Revert "Add model access control documentation for ML Commons (#4223)"

28c0a7a

This reverts commit e69009b.

kolchfa-aws added the release-notes PR: Include this PR in the automated release notes label Jul 17, 2023

vagimeli added a commit that referenced this pull request Aug 24, 2023

Revert "Add model access control documentation for ML Commons (#4223)"

e50c25b

This reverts commit e69009b. Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

kolchfa-aws deleted the ml-model-access branch March 28, 2024 21:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add model access control documentation for ML Commons #4223

Add model access control documentation for ML Commons #4223

kolchfa-aws commented Jun 2, 2023

rbhavna Jun 7, 2023

kolchfa-aws Jun 8, 2023

ylwu-amzn Jun 8, 2023

ylwu-amzn Jun 8, 2023

ylwu-amzn Jun 8, 2023

ylwu-amzn Jun 8, 2023 •

edited

Loading

ylwu-amzn Jun 8, 2023 •

edited

Loading

ylwu-amzn Jun 8, 2023

rbhavna Jun 13, 2023

rbhavna Jun 13, 2023

cwillum left a comment

cwillum Jun 14, 2023

cwillum Jun 14, 2023

kolchfa-aws commented Jun 14, 2023

cwillum left a comment

vagimeli left a comment

vagimeli Jun 15, 2023

vagimeli Jun 15, 2023

vagimeli Jun 15, 2023

vagimeli Jun 16, 2023

kolchfa-aws Jun 19, 2023

vagimeli Jun 16, 2023

kolchfa-aws Jun 19, 2023

vagimeli Jun 16, 2023


		In order to train tasks through the API, three inputs are required.
		In order to train tasks through the API, three inputs are required:

	In order to train tasks through the API, three inputs are required:
	To train tasks through the API, three inputs are required:

	- Input data: The data input that trains the ML model, or applies the ML models to predictions. You can input data in two ways, query against your index or use data frame.
	- Input data: The data that trains the ML model, or applies the ML models to predictions. You can input data in two ways, query against your index or use a data frame.

	The response contains the model ID of the model version:
	The response contains the model ID of the model version:

	The response contains the model ID of the model version:
	The response contains the `model_ID` of the model version:

Add model access control documentation for ML Commons #4223

Add model access control documentation for ML Commons #4223

Conversation

kolchfa-aws commented Jun 2, 2023

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ylwu-amzn Jun 8, 2023 • edited Loading

Choose a reason for hiding this comment

ylwu-amzn Jun 8, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cwillum left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kolchfa-aws commented Jun 14, 2023

cwillum left a comment

Choose a reason for hiding this comment

vagimeli left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ylwu-amzn Jun 8, 2023 •

edited

Loading

ylwu-amzn Jun 8, 2023 •

edited

Loading