Updating ML Commons API documentation (#156) (#163)

* updating ML Commons API documentation Signed-off-by: Alibi Zhenis <[email protected]> * updating developer guide Signed-off-by: Alibi Zhenis <[email protected]> --------- Signed-off-by: Alibi Zhenis <[email protected]> (cherry picked from commit d1101a2) Co-authored-by: Alibi Zhenis <[email protected]>
opensearch-project · May 16, 2023 · 60c98c8 · 60c98c8
1 parent a81b524
commit 60c98c8
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 5 deletions.
diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md
@@ -123,6 +123,17 @@ $ nox -s format
 $ nox -s test
 ```
 
+#### To test documentation
+
+```bash
+# New HTML pages will be created in build/html
+$ cd docs
+$ pip install -r requirements-docs.txt
+$ make clean
+$ make html
+```
+
+
 #### Default setup for opensearch
 
 ```yml

diff --git a/docs/source/reference/api/ml_commons_delete_task_api.rst b/docs/source/reference/api/ml_commons_delete_task_api.rst
@@ -0,0 +1,6 @@
+Delete Task
+==================
+
+.. currentmodule:: opensearch_py_ml
+
+.. autofunction:: opensearch_py_ml.ml_commons.MLCommonClient.delete_task
diff --git a/docs/source/reference/api/ml_commons_upload_pretrained_api.rst b/docs/source/reference/api/ml_commons_upload_pretrained_api.rst
@@ -0,0 +1,6 @@
+Upload Pretrained Model
+==================
+
+.. currentmodule:: opensearch_py_ml
+
+.. autofunction:: opensearch_py_ml.ml_commons.MLCommonClient.upload_pretrained_model
diff --git a/docs/source/reference/mlcommons.rst b/docs/source/reference/mlcommons.rst
@@ -6,21 +6,28 @@ MLCommons Support
 .. currentmodule:: opensearch_py_ml
 
 Upload Model
-~~~~~~~~~~~~~~
+~~~~~~~~~~~~
 .. toctree::
    :maxdepth: 2
 
    api/ml_commons_upload_api
 
+Upload Pretrained Model
+~~~~~~~~~~~~~~~~~~~~~~~
+.. toctree::
+   :maxdepth: 2
+
+   api/ml_commons_upload_pretrained_api
+
 Load Model
-~~~~~~~~~~~~~~
+~~~~~~~~~~
 .. toctree::
    :maxdepth: 2
 
    api/ml_commons_load_api
 
 Get Task Info
-~~~~~~~~~~~~~~
+~~~~~~~~~~~~~
 .. toctree::
    :maxdepth: 2
 
@@ -33,17 +40,31 @@ Get Model Info
 
    api/ml_commons_get_model_info_api
 
+Generate Embedding
+~~~~~~~~~~~~~~~~~~
+.. toctree::
+   :maxdepth: 2
+
+   api/ml_commons_generate_embedding_api
+
 Unload Model
-~~~~~~~~~~~~~~
+~~~~~~~~~~~~
 .. toctree::
    :maxdepth: 2
 
    api/ml_commons_unload_model_api
 
 Delete Model
-~~~~~~~~~~~~~~
+~~~~~~~~~~~~
 .. toctree::
    :maxdepth: 2
 
    api/ml_commons_delete_model_api
 
+Delete Task
+~~~~~~~~~~~
+.. toctree::
+   :maxdepth: 2
+
+   api/ml_commons_delete_task_api
+