ODSC-40388: improve class doc (#112)

Author: z7ye

README.md

@@ -2,7 +2,7 @@
 
 [![PyPI](https://img.shields.io/pypi/v/oracle-ads.svg)](https://pypi.org/project/oracle-ads/) [![Python](https://img.shields.io/pypi/pyversions/oracle-ads.svg?style=plastic)](https://pypi.org/project/oracle-ads/)
 
-The [Oracle Accelerated Data Science (ADS) SDK](https://accelerated-data-science.readthedocs.io/en/latest/index.html) is maintained by the Oracle Cloud Infrastructure (OCI) [Data Science service](https://docs.oracle.com/en-us/iaas/data-science/using/data-science.htm) team. It speeds up common data science activities by providing tools that automate and simplify common data science tasks. Additionally, provides data scientists a friendly pythonic interface to OCI services. Some of the more notable services are OCI Data Science, Model Catalog, Model Deployment, Jobs, Data Flow, Object Storage, Vault, Big Data Service, Data Catalog, and the Autonomous Database. ADS gives you an interface to manage the life cycle of machine learning models, from data acquisition to model evaluation, interpretation, and model deployment.
+The [Oracle Accelerated Data Science (ADS) SDK](https://accelerated-data-science.readthedocs.io/en/latest/index.html) is maintained by the Oracle Cloud Infrastructure (OCI) [Data Science service](https://docs.oracle.com/en-us/iaas/data-science/using/data-science.htm) team. It speeds up common data science activities by providing tools that automate and simplify common data science tasks. Additionally, provides data scientists a friendly pythonic interface to OCI services. Some of the more notable services are OCI Data Science, Model Catalog, Model Deployment, Jobs, ML Pipelines, Data Flow, Object Storage, Vault, Big Data Service, Data Catalog, and the Autonomous Database. ADS gives you an interface to manage the life cycle of machine learning models, from data acquisition to model evaluation, interpretation, and model deployment.
 
 With ADS you can:
 
@@ -14,6 +14,7 @@ With ADS you can:
  - Deploy models as HTTP endpoints with [Model Deployment](https://docs.oracle.com/en-us/iaas/data-science/using/model-dep-about.htm).
  - Launch distributed ETL, data processing, and model training jobs in Spark with [OCI Data Flow](https://docs.oracle.com/en-us/iaas/data-flow/using/home.htm).
  - Train machine learning models in OCI Data Science [Jobs](https://docs.oracle.com/en-us/iaas/data-science/using/jobs-about.htm).
+ - Define and run an end-to-end machine learning orchestration covering all the steps of machine learning lifecycle in a repeatable, continuous [ML Pipelines](https://accelerated-data-science.readthedocs.io/en/latest/user_guide/pipeline/overview.html#).
  - Manage the life cycle of conda environments through the `ads conda` command line interface (CLI).
 
 ## Installation

docs/source/ads.model.framework.rst

@@ -4,13 +4,23 @@ ads.model.framework package
 Submodules
 ----------
 
+ads.model.framework.huggingface\_model module
+---------------------------------------------
+
+.. automodule:: ads.model.framework.huggingface_model
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
+
 ads.model.framework.lightgbm\_model module
 ------------------------------------------
 
 .. automodule:: ads.model.framework.lightgbm_model
    :members:
    :undoc-members:
    :show-inheritance:
+   :inherited-members:
 
 ads.model.framework.pytorch\_model module
 -----------------------------------------
@@ -19,6 +29,7 @@ ads.model.framework.pytorch\_model module
    :members:
    :undoc-members:
    :show-inheritance:
+   :inherited-members:
 
 ads.model.framework.sklearn\_model module
 -----------------------------------------
@@ -27,6 +38,7 @@ ads.model.framework.sklearn\_model module
    :members:
    :undoc-members:
    :show-inheritance:
+   :inherited-members:
 
 ads.model.framework.spark\_model module
 ---------------------------------------
@@ -35,6 +47,7 @@ ads.model.framework.spark\_model module
    :members:
    :undoc-members:
    :show-inheritance:
+   :inherited-members:
 
 ads.model.framework.tensorflow\_model module
 --------------------------------------------
@@ -43,6 +56,7 @@ ads.model.framework.tensorflow\_model module
    :members:
    :undoc-members:
    :show-inheritance:
+   :inherited-members:
 
 ads.model.framework.xgboost\_model module
 -----------------------------------------
@@ -51,14 +65,7 @@ ads.model.framework.xgboost\_model module
    :members:
    :undoc-members:
    :show-inheritance:
-
-ads.model.framework.huggingface\_model module
------------------------------------------
-
-.. automodule:: ads.model.framework.huggingface_model
-   :members:
-   :undoc-members:
-   :show-inheritance:
+   :inherited-members:
 
 Module contents
 ---------------
@@ -67,3 +74,4 @@ Module contents
    :members:
    :undoc-members:
    :show-inheritance:
+   :inherited-members:

docs/source/ads.model.serde.rst

@@ -0,0 +1,41 @@
+ads.model.serde package
+=======================
+
+Submodules
+----------
+
+ads.model.serde.common module
+-----------------------------
+
+.. automodule:: ads.model.serde.common
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
+
+ads.model.serde.model\_input module
+-----------------------------------
+
+.. automodule:: ads.model.serde.model_input
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
+
+ads.model.serde.model\_serializer module
+----------------------------------------
+
+.. automodule:: ads.model.serde.model_serializer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
+
+Module contents
+---------------
+
+.. automodule:: ads.model.serde
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members: