Skip to content

Commit f1871a2

Browse files
committed
ODSC-40388: add class doc for serde and also add ml pipeline in the readme
1 parent f1503e6 commit f1871a2

File tree

3 files changed

+68
-9
lines changed

3 files changed

+68
-9
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![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/)
44

5-
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.
5+
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.
66

77
With ADS you can:
88

@@ -14,6 +14,7 @@ With ADS you can:
1414
- Deploy models as HTTP endpoints with [Model Deployment](https://docs.oracle.com/en-us/iaas/data-science/using/model-dep-about.htm).
1515
- 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).
1616
- Train machine learning models in OCI Data Science [Jobs](https://docs.oracle.com/en-us/iaas/data-science/using/jobs-about.htm).
17+
- 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#).
1718
- Manage the life cycle of conda environments through the `ads conda` command line interface (CLI).
1819

1920
## Installation

docs/source/ads.model.framework.rst

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,32 @@ ads.model.framework package
44
Submodules
55
----------
66

7+
ads.model.framework.automl\_model module
8+
----------------------------------------
9+
10+
.. automodule:: ads.model.framework.automl_model
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
:inherited-members:
15+
16+
ads.model.framework.huggingface\_model module
17+
---------------------------------------------
18+
19+
.. automodule:: ads.model.framework.huggingface_model
20+
:members:
21+
:undoc-members:
22+
:show-inheritance:
23+
:inherited-members:
24+
725
ads.model.framework.lightgbm\_model module
826
------------------------------------------
927

1028
.. automodule:: ads.model.framework.lightgbm_model
1129
:members:
1230
:undoc-members:
1331
:show-inheritance:
32+
:inherited-members:
1433

1534
ads.model.framework.pytorch\_model module
1635
-----------------------------------------
@@ -19,6 +38,7 @@ ads.model.framework.pytorch\_model module
1938
:members:
2039
:undoc-members:
2140
:show-inheritance:
41+
:inherited-members:
2242

2343
ads.model.framework.sklearn\_model module
2444
-----------------------------------------
@@ -27,6 +47,7 @@ ads.model.framework.sklearn\_model module
2747
:members:
2848
:undoc-members:
2949
:show-inheritance:
50+
:inherited-members:
3051

3152
ads.model.framework.spark\_model module
3253
---------------------------------------
@@ -35,6 +56,7 @@ ads.model.framework.spark\_model module
3556
:members:
3657
:undoc-members:
3758
:show-inheritance:
59+
:inherited-members:
3860

3961
ads.model.framework.tensorflow\_model module
4062
--------------------------------------------
@@ -43,6 +65,7 @@ ads.model.framework.tensorflow\_model module
4365
:members:
4466
:undoc-members:
4567
:show-inheritance:
68+
:inherited-members:
4669

4770
ads.model.framework.xgboost\_model module
4871
-----------------------------------------
@@ -51,14 +74,7 @@ ads.model.framework.xgboost\_model module
5174
:members:
5275
:undoc-members:
5376
:show-inheritance:
54-
55-
ads.model.framework.huggingface\_model module
56-
-----------------------------------------
57-
58-
.. automodule:: ads.model.framework.huggingface_model
59-
:members:
60-
:undoc-members:
61-
:show-inheritance:
77+
:inherited-members:
6278

6379
Module contents
6480
---------------
@@ -67,3 +83,4 @@ Module contents
6783
:members:
6884
:undoc-members:
6985
:show-inheritance:
86+
:inherited-members:

docs/source/ads.model.serde.rst

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
ads.model.serde package
2+
=======================
3+
4+
Submodules
5+
----------
6+
7+
ads.model.serde.common module
8+
-----------------------------
9+
10+
.. automodule:: ads.model.serde.common
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
:inherited-members:
15+
16+
ads.model.serde.model\_input module
17+
-----------------------------------
18+
19+
.. automodule:: ads.model.serde.model_input
20+
:members:
21+
:undoc-members:
22+
:show-inheritance:
23+
:inherited-members:
24+
25+
ads.model.serde.model\_serializer module
26+
----------------------------------------
27+
28+
.. automodule:: ads.model.serde.model_serializer
29+
:members:
30+
:undoc-members:
31+
:show-inheritance:
32+
:inherited-members:
33+
34+
Module contents
35+
---------------
36+
37+
.. automodule:: ads.model.serde
38+
:members:
39+
:undoc-members:
40+
:show-inheritance:
41+
:inherited-members:

0 commit comments

Comments
 (0)