From 60c98c8401c6ff6ad07ee5ecf6b9e430e291c059 Mon Sep 17 00:00:00 2001 From: "opensearch-trigger-bot[bot]" <98922864+opensearch-trigger-bot[bot]@users.noreply.github.com> Date: Tue, 16 May 2023 10:21:06 -0700 Subject: [PATCH] Updating ML Commons API documentation (#156) (#163) * updating ML Commons API documentation Signed-off-by: Alibi Zhenis * updating developer guide Signed-off-by: Alibi Zhenis --------- Signed-off-by: Alibi Zhenis (cherry picked from commit d1101a2e6f0a501c1d3ed4058131afe8a5e5f1e2) Co-authored-by: Alibi Zhenis <92104549+AlibiZhenis@users.noreply.github.com> --- DEVELOPER_GUIDE.md | 11 +++++++ .../api/ml_commons_delete_task_api.rst | 6 ++++ .../api/ml_commons_upload_pretrained_api.rst | 6 ++++ docs/source/reference/mlcommons.rst | 31 ++++++++++++++++--- 4 files changed, 49 insertions(+), 5 deletions(-) create mode 100644 docs/source/reference/api/ml_commons_delete_task_api.rst create mode 100644 docs/source/reference/api/ml_commons_upload_pretrained_api.rst diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md index be1d931d..d0765cbc 100644 --- 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 new file mode 100644 index 00000000..f9b79de1 --- /dev/null +++ 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 new file mode 100644 index 00000000..73cff858 --- /dev/null +++ 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 index ae6ffb77..258dc853 100644 --- 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 +