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

Jump to bottom

Rename APIs for model serving framework #159

Merged
merged 13 commits into from
May 31, 2023
Merged

Rename APIs for model serving framework #159

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
2385d06
renaming APIs for OS 2.7
AlibiZhenis May 4, 2023
5c769d5
updating tests
AlibiZhenis May 4, 2023
5b78d46
linting
AlibiZhenis May 4, 2023
10aed7b
adding new methods and marking old ones as deprecated
AlibiZhenis May 10, 2023
e808ce5
fixing tests
AlibiZhenis May 12, 2023
146e8ab
Merge branch 'opensearch-project:main' into renameAPI
AlibiZhenis May 14, 2023
20a8fab
Merge branch 'opensearch-project:main' into renameAPI
AlibiZhenis May 17, 2023
9470d1e
updating documentation
AlibiZhenis May 17, 2023
dafeef6
partially fixing tests for codecov/patch
AlibiZhenis May 18, 2023
75a765a
adding comments
AlibiZhenis May 18, 2023
f0e4b80
change constant name
AlibiZhenis May 19, 2023
86e7c51
linting
AlibiZhenis May 19, 2023
3a7d72b
fixing tests
AlibiZhenis May 19, 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
2 changes: 1 addition & 1 deletion .github/workflows/integration.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
cluster: ["opensearch"]
secured: ["true"]
entry:
- { opensearch_version: 2.6.0 }
- { opensearch_version: 2.7.0 }

steps:
- name: Checkout
Expand Down
6 changes: 6 additions & 0 deletions docs/source/reference/api/ml_commons_deploy_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Deploy Model
==================

.. currentmodule:: opensearch_py_ml

.. autofunction:: opensearch_py_ml.ml_commons.MLCommonClient.deploy_model
6 changes: 6 additions & 0 deletions docs/source/reference/api/ml_commons_register_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Register Model
==================

.. currentmodule:: opensearch_py_ml

.. autofunction:: opensearch_py_ml.ml_commons.MLCommonClient.register_model
6 changes: 6 additions & 0 deletions docs/source/reference/api/ml_commons_register_pretrained_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Register 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.

We need to cover ====== all the way to Model.


.. currentmodule:: opensearch_py_ml

.. autofunction:: opensearch_py_ml.ml_commons.MLCommonClient.register_pretrained_model
6 changes: 6 additions & 0 deletions docs/source/reference/api/ml_commons_undeploy_model_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Undeploy Model
==================

.. currentmodule:: opensearch_py_ml

.. autofunction:: opensearch_py_ml.ml_commons.MLCommonClient.undeploy_model
28 changes: 28 additions & 0 deletions docs/source/reference/mlcommons.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,41 @@ Upload Model

api/ml_commons_upload_api

Register Model
~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 2

api/ml_commons_register_api

Upload Pretrained Model
~~~~~~~~~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 2

api/ml_commons_upload_pretrained_api

Register Pretrained Model
~~~~~~~~~~~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 2

api/ml_commons_register_pretrained_api

Load Model
~~~~~~~~~~
.. toctree::
:maxdepth: 2

api/ml_commons_load_api

Deploy Model
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same here.

~~~~~~~~~~
.. toctree::
:maxdepth: 2

api/ml_commons_deploy_api

Get Task Info
~~~~~~~~~~~~~
.. toctree::
Expand Down Expand Up @@ -54,6 +75,13 @@ Unload Model

api/ml_commons_unload_model_api

Undeploy Model
~~~~~~~~~~~~
.. toctree::
:maxdepth: 2

api/ml_commons_undeploy_model_api

Delete Model
~~~~~~~~~~~~
.. toctree::
Expand Down
2 changes: 1 addition & 1 deletion opensearch_py_ml/ml_commons/ml_common_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# GitHub history for details.

ML_BASE_URI = "/_plugins/_ml"
MODEL_UPLOAD_CHUNK_SIZE = 10_000_000
MODEL_REGISTER_CHUNK_SIZE = 10_000_000
Copy link
Collaborator

Choose a reason for hiding this comment

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

How about change to MODEL_CHUNK_SIZE_LIMIT

Copy link
Collaborator

Choose a reason for hiding this comment

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

Or to match the MODEL_MAX_SIZE, another option is MODEL_CHUNK_MAX_SIZE ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

MODEL_MAX_SIZE = 4_000_000_000
BUF_SIZE = 65536 # lets read stuff in 64kb chunks!
TIMEOUT = 120 # timeout for synchronous method calls in seconds
Loading