Skip to content

Commit 3b5bcab

Browse files
committed
reorganize the model version set docs
1 parent a5ac47c commit 3b5bcab

File tree

12 files changed

+38
-313
lines changed

12 files changed

+38
-313
lines changed

docs/source/user_guide/model_registration/framework_specific_instruction.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,4 @@
1111
frameworks/xgboostmodel
1212
frameworks/automlmodel
1313
frameworks/genericmodel
14+

docs/source/user_guide/model_registration/introduction.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ Register
5151
model_schema
5252
model_metadata
5353
model_file_customization
54+
model_version_set
5455

5556
Deploying model
5657
---------------

docs/source/user_guide/model_registration/quick_start.rst

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -289,3 +289,39 @@ Other Frameworks
289289
# Register the model
290290
model_id = generic_model.save(display_name="Custom Framework Model")
291291
292+
293+
With Model Version Set
294+
----------------------
295+
.. code-block:: python3
296+
297+
import tempfile
298+
from ads.model.generic_model import GenericModel
299+
300+
# Create custom framework model
301+
class Toy:
302+
def predict(self, x):
303+
return x ** 2
304+
model = Toy()
305+
306+
# Instantite ads.model.generic_model.GenericModel using the trained Custom Model
307+
generic_model = GenericModel(estimator=model, artifact_dir=tempfile.mkdtemp())
308+
generic_model.summary_status()
309+
310+
311+
# Within the context manager, you can save the :ref:`Model Serialization` model without specifying the ``model_version_set`` parameter because it's taken from the model context manager. If the model version set doesn't exist in the model catalog, the example creates a model version set named ``my_model_version_set``. If the model version set exists in the model catalog, the models are saved to that model version set.
312+
with ads.model.experiment(name="my_model_version_set", create_if_not_exists=True):
313+
314+
# Autogenerate score.py, pickled model, runtime.yaml, input_schema.json and output_schema.json
315+
generic_model.prepare(
316+
inference_conda_env="dbexp_p38_cpu_v1",
317+
model_file_name="toy_model.pkl",
318+
force_overwrite=True
319+
)
320+
321+
# Check if the artifacts are generated correctly.
322+
# The verify method invokes the ``predict`` function defined inside ``score.py`` in the artifact_dir
323+
generic_model.verify([2])
324+
325+
# Register the model
326+
model_id = generic_model.save(display_name="Custom Framework Model")
327+

docs/source/user_guide/model_version_set/associate_a_model.rst

Lines changed: 0 additions & 66 deletions
This file was deleted.

docs/source/user_guide/model_version_set/create.rst

Lines changed: 0 additions & 34 deletions
This file was deleted.

docs/source/user_guide/model_version_set/delete.rst

Lines changed: 0 additions & 21 deletions
This file was deleted.

docs/source/user_guide/model_version_set/download.rst

Lines changed: 0 additions & 21 deletions
This file was deleted.

docs/source/user_guide/model_version_set/index.rst

Lines changed: 0 additions & 18 deletions
This file was deleted.

docs/source/user_guide/model_version_set/list.rst

Lines changed: 0 additions & 29 deletions
This file was deleted.

docs/source/user_guide/model_version_set/overview.rst

Lines changed: 0 additions & 10 deletions
This file was deleted.

0 commit comments

Comments
 (0)