Skip to content

Update README.md #78

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 31, 2023
Merged

Update README.md #78

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,95 +23,95 @@ You have various options when installing ADS.
### Installing the oracle-ads base package

```bash
$ python3 -m pip install oracle-ads
python3 -m pip install oracle-ads
```

### Installing extras libraries

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

```bash
$ python3 -m pip install 'oracle-ads[all-optional]'
python3 -m pip install 'oracle-ads[all-optional]'
```

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

```bash
$ python3 -m pip install 'oracle-ads[boosted]'
python3 -m pip install 'oracle-ads[boosted]'
```

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`.

```bash
$ python3 -m pip install 'oracle-ads[bds]'
python3 -m pip install 'oracle-ads[bds]'
```

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.

```bash
$ python3 -m pip install 'oracle-ads[data]'
python3 -m pip install 'oracle-ads[data]'
```

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

```bash
$ python3 -m pip install 'oracle-ads[geo]'
python3 -m pip install 'oracle-ads[geo]'
```

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.

```bash
$ python3 -m pip install 'oracle-ads[notebook]'
python3 -m pip install 'oracle-ads[notebook]'
```

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.

```bash
$ python3 -m pip install 'oracle-ads[onnx]'
python3 -m pip install 'oracle-ads[onnx]'
```

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

```bash
$ python3 -m pip install 'oracle-ads[opctl]'
python3 -m pip install 'oracle-ads[opctl]'
```

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

```bash
$ python3 -m pip install 'oracle-ads[optuna]'
python3 -m pip install 'oracle-ads[optuna]'
```

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

```bash
$ python3 -m pip install 'oracle-ads[tensorflow]'
python3 -m pip install 'oracle-ads[tensorflow]'
```

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

```bash
$ python3 -m pip install 'oracle-ads[text]'
python3 -m pip install 'oracle-ads[text]'
```

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

```bash
$ python3 -m pip install 'oracle-ads[torch]'
python3 -m pip install 'oracle-ads[torch]'
```

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

```bash
$ python3 -m pip install 'oracle-ads[viz]'
python3 -m pip install 'oracle-ads[viz]'
```

**Note**

Multiple extra dependencies can be installed together. For example:

```bash
$ python3 -m pip install 'oracle-ads[notebook,viz,text]'
python3 -m pip install 'oracle-ads[notebook,viz,text]'
```

## Documentation
Expand Down