Add model access control documentation for ML Commons (opensearch-pro…

…ject#4223) * Add model access control documentation for ML Commons Signed-off-by: Fanit Kolchina <[email protected]> * Remove permissions for delete API Signed-off-by: Fanit Kolchina <[email protected]> * Add copy buttons Signed-off-by: Fanit Kolchina <[email protected]> * Updated model-level APIs Signed-off-by: Fanit Kolchina <[email protected]> * Add delete model Signed-off-by: Fanit Kolchina <[email protected]> * Reworded role-related text Signed-off-by: Fanit Kolchina <[email protected]> * Implemented tech review comments Signed-off-by: Fanit Kolchina <[email protected]> * Rewording Signed-off-by: Fanit Kolchina <[email protected]> * Remove experimental warning Signed-off-by: Fanit Kolchina <[email protected]> * Register a model group in note format Signed-off-by: Fanit Kolchina <[email protected]> * Implement tech review comments Signed-off-by: Fanit Kolchina <[email protected]> * Resolved Vale comments Signed-off-by: Fanit Kolchina <[email protected]> * Remove space Signed-off-by: Fanit Kolchina <[email protected]> * Apply suggestions from code review Co-authored-by: Chris Moore <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Implemented doc review feedback Signed-off-by: Fanit Kolchina <[email protected]> * Implemented editorial comments Signed-off-by: Fanit Kolchina <[email protected]> * Apply suggestions from code review Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Add more editorial comments Signed-off-by: Fanit Kolchina <[email protected]> * Add more editorial comments Signed-off-by: Fanit Kolchina <[email protected]> * Fix links Signed-off-by: Fanit Kolchina <[email protected]> * Fix more links Signed-off-by: Fanit Kolchina <[email protected]> --------- Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: Chris Moore <[email protected]> Co-authored-by: Melissa Vagi <[email protected]>
harshavamsi · Oct 31, 2023 · 4fef91e · 4fef91e
1 parent 32b1d17
commit 4fef91e
Show file tree

Hide file tree

Showing 4 changed files with 771 additions and 74 deletions.
diff --git a/_ml-commons-plugin/algorithms.md b/_ml-commons-plugin/algorithms.md
@@ -27,7 +27,7 @@ distance_type | enum, such as `EUCLIDEAN`, `COSINE`, or `L1` | The type of measu
 
 ### APIs
 
-* [Train]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/#train-model)
+* [Train]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/#training-the-model)
 * [Predict]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/#predict)
 * [Train and predict]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/#train-and-predict)
 
@@ -77,7 +77,7 @@ optimizerType | OptimizerType | The optimizer used in the model. | SIMPLE_SGD
 
 ### APIs
 
-* [Train]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/#train-model)
+* [Train]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/#training-the-model)
 * [Predict]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/#predict)
 
 ### Example
@@ -189,7 +189,7 @@ time_zone | string | The time zone for the `time_field` field. | "UTC"
 
 ### APIs
 
-* [Train]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/#train-model)
+* [Train]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/#training-the-model)
 * [Predict]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/#predict)
 * [Train and predict]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/#train-and-predict)
 
@@ -211,7 +211,7 @@ RCF Summarize is a clustering algorithm based on the Clustering Using Representa
 
 ### APIs
 
-* [Train]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/#train-model)
+* [Train]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/#training-the-model)
 * [Predict]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/#predict)
 * [Train and predict]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/#train-and-predict)
 
@@ -429,7 +429,7 @@ A classification algorithm, logistic regression models the probability of a disc
 
 ### APIs
 
-* [Train]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/#train-model)
+* [Train]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/#training-the-model)
 * [Predict]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/#predict)
 
 ### Example: Train/Predict with Iris data