Skip to content

Commit 071979a

Browse files
authored
Merge branch 'main' into release/2.8.x
2 parents 9125e13 + c06c589 commit 071979a

File tree

4 files changed

+21
-25
lines changed

4 files changed

+21
-25
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -23,95 +23,95 @@ You have various options when installing ADS.
2323
### Installing the oracle-ads base package
2424

2525
```bash
26-
$ python3 -m pip install oracle-ads
26+
python3 -m pip install oracle-ads
2727
```
2828

2929
### Installing extras libraries
3030

3131
The `all-optional` module will install all optional dependencies. Note the single quotes around installation of extra libraries.
3232

3333
```bash
34-
$ python3 -m pip install 'oracle-ads[all-optional]'
34+
python3 -m pip install 'oracle-ads[all-optional]'
3535
```
3636

3737
To work with gradient boosting models, install the `boosted` module. This module includes XGBoost and LightGBM model classes.
3838

3939
```bash
40-
$ python3 -m pip install 'oracle-ads[boosted]'
40+
python3 -m pip install 'oracle-ads[boosted]'
4141
```
4242

4343
For big data use cases using Oracle Big Data Service (BDS), install the `bds` module. It includes the following libraries, `ibis-framework[impala]`, `hdfs[kerberos]` and `sqlalchemy`.
4444

4545
```bash
46-
$ python3 -m pip install 'oracle-ads[bds]'
46+
python3 -m pip install 'oracle-ads[bds]'
4747
```
4848

4949
To work with a broad set of data formats (for example, Excel, Avro, etc.) install the `data` module. It includes the `fastavro`, `openpyxl`, `pandavro`, `asteval`, `datefinder`, `htmllistparse`, and `sqlalchemy` libraries.
5050

5151
```bash
52-
$ python3 -m pip install 'oracle-ads[data]'
52+
python3 -m pip install 'oracle-ads[data]'
5353
```
5454

5555
To work with geospatial data install the `geo` module. It includes the `geopandas` and libraries from the `viz` module.
5656

5757
```bash
58-
$ python3 -m pip install 'oracle-ads[geo]'
58+
python3 -m pip install 'oracle-ads[geo]'
5959
```
6060

6161
Install the `notebook` module to use ADS within a OCI Data Science service [notebook session](https://docs.oracle.com/en-us/iaas/data-science/using/manage-notebook-sessions.htm). This module installs `ipywidgets` and `ipython` libraries.
6262

6363
```bash
64-
$ python3 -m pip install 'oracle-ads[notebook]'
64+
python3 -m pip install 'oracle-ads[notebook]'
6565
```
6666

6767
To work with ONNX-compatible run times and libraries designed to maximize performance and model portability, install the `onnx` module. It includes the following libraries, `onnx`, `onnxruntime`, `onnxmltools`, `skl2onnx`, `xgboost`, `lightgbm` and libraries from the `viz` module.
6868

6969
```bash
70-
$ python3 -m pip install 'oracle-ads[onnx]'
70+
python3 -m pip install 'oracle-ads[onnx]'
7171
```
7272

7373
For infrastructure tasks, install the `opctl` module. It includes the following libraries, `oci-cli`, `docker`, `conda-pack`, `nbconvert`, `nbformat`, and `inflection`.
7474

7575
```bash
76-
$ python3 -m pip install 'oracle-ads[opctl]'
76+
python3 -m pip install 'oracle-ads[opctl]'
7777
```
7878

7979
For hyperparameter optimization tasks install the `optuna` module. It includes the `optuna` and libraries from the `viz` module.
8080

8181
```bash
82-
$ python3 -m pip install 'oracle-ads[optuna]'
82+
python3 -m pip install 'oracle-ads[optuna]'
8383
```
8484

8585
Install the `tensorflow` module to include `tensorflow` and libraries from the `viz` module.
8686

8787
```bash
88-
$ python3 -m pip install 'oracle-ads[tensorflow]'
88+
python3 -m pip install 'oracle-ads[tensorflow]'
8989
```
9090

9191
For text related tasks, install the `text` module. This will include the `wordcloud`, `spacy` libraries.
9292

9393
```bash
94-
$ python3 -m pip install 'oracle-ads[text]'
94+
python3 -m pip install 'oracle-ads[text]'
9595
```
9696

9797
Install the `torch` module to include `pytorch` and libraries from the `viz` module.
9898

9999
```bash
100-
$ python3 -m pip install 'oracle-ads[torch]'
100+
python3 -m pip install 'oracle-ads[torch]'
101101
```
102102

103103
Install the `viz` module to include libraries for visualization tasks. Some of the key packages are `bokeh`, `folium`, `seaborn` and related packages.
104104

105105
```bash
106-
$ python3 -m pip install 'oracle-ads[viz]'
106+
python3 -m pip install 'oracle-ads[viz]'
107107
```
108108

109109
**Note**
110110

111111
Multiple extra dependencies can be installed together. For example:
112112

113113
```bash
114-
$ python3 -m pip install 'oracle-ads[notebook,viz,text]'
114+
python3 -m pip install 'oracle-ads[notebook,viz,text]'
115115
```
116116

117117
## Documentation

docs/source/index.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,7 @@ Oracle Accelerated Data Science SDK (ADS)
8181
- Launch distributed ETL, data processing, and model training jobs in Spark with OCI Data Flow.
8282
- Train machine learning models in OCI Data Science Jobs.
8383
- Manage the lifecycle of conda environments through the ads conda command line interface (CLI).
84-
- Distributed Training with PyTorch, Horovod and Dask |beta|
85-
86-
.. |beta| image:: _static/badge_beta.svg
84+
- Distributed Training with PyTorch, Horovod and Dask
8785

8886

8987
.. admonition:: Installation
@@ -189,4 +187,4 @@ Consult the security guide `SECURITY.md <https://github.com/oracle/accelerated-d
189187
License
190188
+++++++
191189

192-
Copyright (c) 2020, 2022 Oracle and/or its affiliates. Licensed under the `Universal Permissive License v1.0 <https://oss.oracle.com/licenses/upl/>`_
190+
Copyright (c) 2020, 2022 Oracle and/or its affiliates. Licensed under the `Universal Permissive License v1.0 <https://oss.oracle.com/licenses/upl/>`_

docs/source/user_guide/model_training/distributed_training/overview.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
===========================
2-
Distributed Training |beta|
3-
===========================
4-
5-
.. |beta| image:: /_static/badge_beta.svg
1+
====================
2+
Distributed Training
3+
====================
64

75
.. admonition:: Distributed Training with OCI Data Science
86

docs/source/user_guide/model_training/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ TensorBoard provides the visualization and the tooling that is needed to watch a
1818
:maxdepth: 1
1919

2020
ads_tuner
21-
Distributed Training [beta] <distributed_training/overview>
21+
distributed_training/overview
2222
tensorboard/tensorboard
2323
model_evaluation/index
2424
model_explainability/index

0 commit comments

Comments
 (0)