ayo/ipex-llm
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Update Orca install guide (#6268)

Browse source 
* update install

* fix link

* minor
This commit is contained in:
Kai Huang 2022-10-24 18:49:12 +08:00 committed by GitHub
parent ea164651ee
commit b4d01ac706
1 changed files with 17 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
docs/readthedocs/source/doc/Orca/Overview/install.md
View file

@ -1,17 +1,20 @@
# Installation
## To use basic Orca features
We recommend using [conda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/) to prepare the Python environment.
We recommend using [conda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/) to prepare the Python environment. Install conda and create an environment for BigDL Orca:
```bash
conda create -n py37 python=3.7 # "py37" is conda environment name, you can use any name you like.
conda activate py37
pip install bigdl-orca
```
You can install bigdl-orca nightly build version using
## To use basic Orca features
You can install Orca in your created conda environment for distributed data processing, training and inference with the following command:
```bash
pip install --pre --upgrade bigdl-orca
pip install bigdl-orca # For the official release version
```
or for the nightly build version, use:
```bash
pip install --pre --upgrade bigdl-orca # For the latest nightly build version
```
## To additionally use RayOnSpark
@ -19,12 +22,12 @@ pip install --pre --upgrade bigdl-orca
If you wish to run [RayOnSpark](ray.md) or [sklearn-style Estimator APIs in Orca](distributed-training-inference.md) with "ray" backend, use the extra key `[ray]` during the installation above:
```bash
pip install bigdl-orca[ray]
pip install bigdl-orca[ray] # For the official release version
```
or for the nightly build version, use
or for the nightly build version, use:
```bash
pip install --pre --upgrade bigdl-orca[ray]
pip install --pre --upgrade bigdl-orca[ray] # For the latest nightly build version
```
Note that with the extra key of [ray], `pip` will automatically install the additional dependencies for RayOnSpark,
@ -35,17 +38,17 @@ including `ray[default]==1.9.2`, `aiohttp==3.8.1`, `async-timeout==4.0.1`, `aior
If you wish to run AutoML, use the extra key `[automl]` during the installation above:
```bash
pip install bigdl-orca[automl]
pip install bigdl-orca[automl] # For the official release version
````
or for the nightly build version, use
or for the nightly build version, use:
```bash
pip install --pre --upgrade bigdl-orca[automl]
pip install --pre --upgrade bigdl-orca[automl] # For the latest nightly build version
```
Note that with the extra key of [automl], `pip` will automatically install the additional dependencies for distributed hyper-parameter tuning,
including `ray[tune]==1.9.2`, `scikit-learn`, `tensorboard`, `xgboost` together with the dependencies given by the extra key [ray].
- To use [Pytorch Estimator](#pytorch-autoestimator), you need to install Pytorch with `pip install torch==1.8.1`.
- To use [Pytorch AutoEstimator](distributed-tuning.md#pytorch-autoestimator), you need to install Pytorch with `pip install torch==1.8.1`.
- To use [TensorFlow/Keras AutoEstimator](#tensorflow-keras-autoestimator), you need to install TensorFlow with `pip install tensorflow==1.15.0`.
- To use [TensorFlow/Keras AutoEstimator](distributed-tuning.md#tensorflow-keras-autoestimator), you need to install TensorFlow with `pip install tensorflow==1.15.0`.