Skip to content

Commit c2ad776

Browse files
authored
ODSC-39261: update the automl user guide (#95)
2 parents 692b45d + cbf43e3 commit c2ad776

File tree

83 files changed

+720
-3586
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

83 files changed

+720
-3586
lines changed

docs/source/ads.automl.rst

Lines changed: 0 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +0,0 @@
1-
ads.automl package
2-
==================
3-
4-
Submodules
5-
----------
6-
7-
ads.automl.driver module
8-
------------------------
9-
10-
.. automodule:: ads.automl.driver
11-
:members:
12-
:undoc-members:
13-
:show-inheritance:
14-
15-
ads.automl.provider module
16-
--------------------------
17-
18-
.. automodule:: ads.automl.provider
19-
:members:
20-
:undoc-members:
21-
:show-inheritance:
22-
23-
Module contents
24-
---------------
25-
26-
.. automodule:: ads.automl
27-
:members:
28-
:undoc-members:
29-
:show-inheritance:

docs/source/ads.explanations.rst

Lines changed: 0 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +0,0 @@
1-
ads.explanations package
2-
========================
3-
4-
Submodules
5-
----------
6-
7-
ads.explanations.base\_explainer module
8-
---------------------------------------
9-
10-
.. automodule:: ads.explanations.base_explainer
11-
:members:
12-
:undoc-members:
13-
:show-inheritance:
14-
15-
ads.explanations.explainer module
16-
---------------------------------
17-
18-
.. automodule:: ads.explanations.explainer
19-
:members:
20-
:undoc-members:
21-
:show-inheritance:
22-
23-
ads.explanations.mlx\_global\_explainer module
24-
----------------------------------------------
25-
26-
.. automodule:: ads.explanations.mlx_global_explainer
27-
:members:
28-
:undoc-members:
29-
:show-inheritance:
30-
31-
ads.explanations.mlx\_interface module
32-
--------------------------------------
33-
34-
.. automodule:: ads.explanations.mlx_interface
35-
:members:
36-
:undoc-members:
37-
:show-inheritance:
38-
39-
ads.explanations.mlx\_local\_explainer module
40-
---------------------------------------------
41-
42-
.. automodule:: ads.explanations.mlx_local_explainer
43-
:members:
44-
:undoc-members:
45-
:show-inheritance:
46-
47-
ads.explanations.mlx\_whatif\_explainer module
48-
----------------------------------------------
49-
50-
.. automodule:: ads.explanations.mlx_whatif_explainer
51-
:members:
52-
:undoc-members:
53-
:show-inheritance:
54-
55-
Module contents
56-
---------------
57-
58-
.. automodule:: ads.explanations
59-
:members:
60-
:undoc-members:
61-
:show-inheritance:

docs/source/ads.model.extractor.rst

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,6 @@ ads.model.extractor package
44
Submodules
55
----------
66

7-
ads.model.extractor.automl\_extractor module
8-
--------------------------------------------
9-
10-
.. automodule:: ads.model.extractor.automl_extractor
11-
:members:
12-
:undoc-members:
13-
:show-inheritance:
14-
157
ads.model.extractor.keras\_extractor module
168
-------------------------------------------
179

docs/source/ads.model.framework.rst

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,6 @@ 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-
157
ads.model.framework.lightgbm\_model module
168
------------------------------------------
179

docs/source/ads.model.rst

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -51,17 +51,6 @@ ads.model.base\_properties module
5151
:undoc-members:
5252
:show-inheritance:
5353

54-
ads.model.datascience\_model module
55-
-----------------------------------
56-
57-
.. automodule:: ads.model.datascience_model
58-
:members:
59-
:undoc-members:
60-
:show-inheritance:
61-
62-
ads.model.generic\_model module
63-
-------------------------------
64-
6554
.. automodule:: ads.model.generic_model
6655
:members:
6756
:undoc-members:

docs/source/ads.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ Subpackages
77
.. toctree::
88
:maxdepth: 4
99

10-
ads.automl
1110
ads.bds
1211
ads.catalog
1312
ads.common

docs/source/user_guide/loading_data/connect_legacy.rst

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -221,20 +221,6 @@ Close the cursor and connection using the ``.close()`` method:
221221
connection.close()
222222
223223
224-
Train a Models with ADB
225-
========================
226-
227-
After you load your data from ADB, the ``ADSDataset`` object is created, which allows you to build models using AutoML.
228-
229-
.. code-block:: python3
230-
231-
from ads.automl.driver import AutoML
232-
from ads.automl.provider import OracleAutoMLProvider
233-
234-
train, test = ds.train_test_split()
235-
model, baseline = AutoML(train, provider= OracleAutoMLProvider()).train(model_list=["LGBMClassifier"])
236-
237-
238224
Update ADB Tables
239225
=================
240226

docs/source/user_guide/model_catalog/model_catalog.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,6 @@ The ADS SDK automatically captures some of the metadata for you. It captures pr
5858
A model can be saved to the model catalog using the generic approach or the ``ADSModel`` approach:
5959

6060
* The generic approach creates a generic model artifact using ``.prepare_generic_model()``, and saves it to the model catalog.
61-
* The ``ADSModel`` approach prepares an artifact from the ``ADSModel`` object, and saves it to the model catalog using the ``.prepare()`` method. ``ADSModel`` objects are typically created from the AutoML engine. Data scientists can also convert models trained with other machine learning libraries into an ``ADSModel`` object (using the ``.from_estimator()`` method).
6261

6362
**Notes:**
6463

docs/source/user_guide/model_explainability/accumulated_local_effects.rst

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

0 commit comments

Comments
 (0)