You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,95 +23,95 @@ You have various options when installing ADS.
23
23
### Installing the oracle-ads base package
24
24
25
25
```bash
26
-
$ python3 -m pip install oracle-ads
26
+
python3 -m pip install oracle-ads
27
27
```
28
28
29
29
### Installing extras libraries
30
30
31
-
The `all-optional` module will install all optional dependencies.
31
+
The `all-optional` module will install all optional dependencies. Note the single quotes around installation of extra libraries.
32
32
33
33
```bash
34
-
$ python3 -m pip install oracle-ads[all-optional]
34
+
python3 -m pip install 'oracle-ads[all-optional]'
35
35
```
36
36
37
37
To work with gradient boosting models, install the `boosted` module. This module includes XGBoost and LightGBM model classes.
38
38
39
39
```bash
40
-
$ python3 -m pip install oracle-ads[boosted]
40
+
python3 -m pip install 'oracle-ads[boosted]'
41
41
```
42
42
43
43
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`.
44
44
45
45
```bash
46
-
$ python3 -m pip install oracle-ads[bds]
46
+
python3 -m pip install 'oracle-ads[bds]'
47
47
```
48
48
49
49
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.
50
50
51
51
```bash
52
-
$ python3 -m pip install oracle-ads[data]
52
+
python3 -m pip install 'oracle-ads[data]'
53
53
```
54
54
55
55
To work with geospatial data install the `geo` module. It includes the `geopandas` and libraries from the `viz` module.
56
56
57
57
```bash
58
-
$ python3 -m pip install oracle-ads[geo]
58
+
python3 -m pip install 'oracle-ads[geo]'
59
59
```
60
60
61
61
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.
62
62
63
63
```bash
64
-
$ python3 -m pip install oracle-ads[notebook]
64
+
python3 -m pip install 'oracle-ads[notebook]'
65
65
```
66
66
67
67
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.
68
68
69
69
```bash
70
-
$ python3 -m pip install oracle-ads[onnx]
70
+
python3 -m pip install 'oracle-ads[onnx]'
71
71
```
72
72
73
73
For infrastructure tasks, install the `opctl` module. It includes the following libraries, `oci-cli`, `docker`, `conda-pack`, `nbconvert`, `nbformat`, and `inflection`.
74
74
75
75
```bash
76
-
$ python3 -m pip install oracle-ads[opctl]
76
+
python3 -m pip install 'oracle-ads[opctl]'
77
77
```
78
78
79
79
For hyperparameter optimization tasks install the `optuna` module. It includes the `optuna` and libraries from the `viz` module.
80
80
81
81
```bash
82
-
$ python3 -m pip install oracle-ads[optuna]
82
+
python3 -m pip install 'oracle-ads[optuna]'
83
83
```
84
84
85
85
Install the `tensorflow` module to include `tensorflow` and libraries from the `viz` module.
86
86
87
87
```bash
88
-
$ python3 -m pip install oracle-ads[tensorflow]
88
+
python3 -m pip install 'oracle-ads[tensorflow]'
89
89
```
90
90
91
91
For text related tasks, install the `text` module. This will include the `wordcloud`, `spacy` libraries.
92
92
93
93
```bash
94
-
$ python3 -m pip install oracle-ads[text]
94
+
python3 -m pip install 'oracle-ads[text]'
95
95
```
96
96
97
97
Install the `torch` module to include `pytorch` and libraries from the `viz` module.
98
98
99
99
```bash
100
-
$ python3 -m pip install oracle-ads[torch]
100
+
python3 -m pip install 'oracle-ads[torch]'
101
101
```
102
102
103
103
Install the `viz` module to include libraries for visualization tasks. Some of the key packages are `bokeh`, `folium`, `seaborn` and related packages.
104
104
105
105
```bash
106
-
$ python3 -m pip install oracle-ads[viz]
106
+
python3 -m pip install 'oracle-ads[viz]'
107
107
```
108
108
109
109
**Note**
110
110
111
111
Multiple extra dependencies can be installed together. For example:
@@ -166,7 +166,7 @@ This example uses SQL injection safe binding variables.
166
166
167
167
## Contributing
168
168
169
-
This project welcomes contributions from the community. Before submitting a pull request, please review our contribution guide[CONTRIBUTING.md](https://github.com/oracle/accelerated-data-science/blob/main/CONTRIBUTING.md).
169
+
This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md)
170
170
171
171
Find Getting Started instructions for developers in [README-development.md](https://github.com/oracle/accelerated-data-science/blob/main/README-development.md)
0 commit comments