Rename APIs for model serving framework (#159) (#167)

* renaming APIs for OS 2.7 Signed-off-by: Alibi Zhenis <[email protected]> * updating tests Signed-off-by: Alibi Zhenis <[email protected]> * linting Signed-off-by: Alibi Zhenis <[email protected]> * adding new methods and marking old ones as deprecated Signed-off-by: Alibi Zhenis <[email protected]> * fixing tests Signed-off-by: Alibi Zhenis <[email protected]> * updating documentation Signed-off-by: Alibi Zhenis <[email protected]> * partially fixing tests for codecov/patch Signed-off-by: Alibi Zhenis <[email protected]> * adding comments Signed-off-by: Alibi Zhenis <[email protected]> * change constant name Signed-off-by: Alibi Zhenis <[email protected]> * linting Signed-off-by: Alibi Zhenis <[email protected]> * fixing tests Signed-off-by: Alibi Zhenis <[email protected]> --------- Signed-off-by: Alibi Zhenis <[email protected]> (cherry picked from commit 7d01104) Co-authored-by: Alibi Zhenis <[email protected]>
thanawan-atc · May 31, 2023 · 45299b6 · 45299b6
1 parent 60c98c8
commit 45299b6
Show file tree

Hide file tree

Showing 13 changed files with 454 additions and 66 deletions.
diff --git a/.github/workflows/integration.yml b/.github/workflows/integration.yml
@@ -12,7 +12,7 @@ jobs:
         cluster: ["opensearch"]
         secured: ["true"]
         entry:
-          - { opensearch_version: 2.6.0 }
+          - { opensearch_version: 2.7.0 }
 
     steps:
       - name: Checkout

diff --git a/docs/source/reference/api/ml_commons_deploy_api.rst b/docs/source/reference/api/ml_commons_deploy_api.rst
@@ -0,0 +1,6 @@
+Deploy Model
+==================
+
+.. currentmodule:: opensearch_py_ml
+
+.. autofunction:: opensearch_py_ml.ml_commons.MLCommonClient.deploy_model
diff --git a/docs/source/reference/api/ml_commons_register_api.rst b/docs/source/reference/api/ml_commons_register_api.rst
@@ -0,0 +1,6 @@
+Register Model
+==================
+
+.. currentmodule:: opensearch_py_ml
+
+.. autofunction:: opensearch_py_ml.ml_commons.MLCommonClient.register_model
diff --git a/docs/source/reference/api/ml_commons_register_pretrained_api.rst b/docs/source/reference/api/ml_commons_register_pretrained_api.rst
@@ -0,0 +1,6 @@
+Register Pretrained Model
+==============================
+
+.. currentmodule:: opensearch_py_ml
+
+.. autofunction:: opensearch_py_ml.ml_commons.MLCommonClient.register_pretrained_model
diff --git a/docs/source/reference/api/ml_commons_undeploy_model_api.rst b/docs/source/reference/api/ml_commons_undeploy_model_api.rst
@@ -0,0 +1,6 @@
+Undeploy Model
+==================
+
+.. currentmodule:: opensearch_py_ml
+
+.. autofunction:: opensearch_py_ml.ml_commons.MLCommonClient.undeploy_model
diff --git a/docs/source/reference/api/ml_commons_upload_pretrained_api.rst b/docs/source/reference/api/ml_commons_upload_pretrained_api.rst
@@ -1,5 +1,5 @@
 Upload Pretrained Model
-==================
+===========================
 
 .. currentmodule:: opensearch_py_ml
 

diff --git a/docs/source/reference/mlcommons.rst b/docs/source/reference/mlcommons.rst
@@ -6,63 +6,91 @@ MLCommons Support
 .. currentmodule:: opensearch_py_ml
 
 Upload Model
-~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 .. toctree::
    :maxdepth: 2
 
    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
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. toctree::
+   :maxdepth: 2
+
+   api/ml_commons_deploy_api
+
 Get Task Info
-~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 .. toctree::
    :maxdepth: 2
 
    api/ml_commons_get_task_info_api
 
 Get Model Info
-~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 .. toctree::
    :maxdepth: 2
 
    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
 
+Undeploy Model
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. toctree::
+   :maxdepth: 2
+
+   api/ml_commons_undeploy_model_api
+
 Delete Model
-~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 .. toctree::
    :maxdepth: 2
 
    api/ml_commons_delete_model_api
 
 Delete Task
-~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 .. toctree::
    :maxdepth: 2
 

diff --git a/opensearch_py_ml/ml_commons/ml_common_utils.py b/opensearch_py_ml/ml_commons/ml_common_utils.py
@@ -6,7 +6,7 @@
 # GitHub history for details.
 
 ML_BASE_URI = "/_plugins/_ml"
-MODEL_UPLOAD_CHUNK_SIZE = 10_000_000
+MODEL_CHUNK_MAX_SIZE = 10_000_000
 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