Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating ML Commons API documentation #156

Merged
merged 4 commits into from
May 16, 2023
Merged

Updating ML Commons API documentation #156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9a30b4c
updating ML Commons API documentation
AlibiZhenis Apr 29, 2023
f9d4e5c
Merge branch 'opensearch-project:main' into main
AlibiZhenis May 10, 2023
277b858
updating developer guide
AlibiZhenis May 12, 2023
12fee52
merging
AlibiZhenis May 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions DEVELOPER_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions docs/source/reference/api/ml_commons_delete_task_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Delete Task
==================

.. currentmodule:: opensearch_py_ml

.. autofunction:: opensearch_py_ml.ml_commons.MLCommonClient.delete_task
6 changes: 6 additions & 0 deletions docs/source/reference/api/ml_commons_upload_pretrained_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Upload Pretrained Model
==================
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you cover this line upto Model


.. currentmodule:: opensearch_py_ml

.. autofunction:: opensearch_py_ml.ml_commons.MLCommonClient.upload_pretrained_model
31 changes: 26 additions & 5 deletions docs/source/reference/mlcommons.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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