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

Doc: add download link and script in orca installation. (#6750)

Browse source 
* feat: add download orca in installation.

* fix: fix wording.

* fix: fix typo.

* fix: fix wording.

* fix: fix link and add scripts.

* fix: fix wording.

* fix: fix wording.

* fix: add empty check for env variables.

* fix: fix echo.

* fix: update download link

* fix: fix style.

* fix: fix style.

* fix: fix wording and style.

* fix: fix style.

* fix: fix style.

* fix: fix style.
This commit is contained in:
Cengguang Zhang 2022-11-24 16:40:57 +08:00 committed by GitHub
parent 988bdc18cf
commit ebe75782dd
2 changed files with 13 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -44,6 +44,8 @@ conda activate py37
--- ---
## Install BigDL Orca ## Install BigDL Orca
This section demonstrates how to install BigDL Orca via `pip`, which is the most recommended way.
### To use basic Orca features ### 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: You can install Orca in your created conda environment for distributed data processing, training and inference with the following command:
```bash ```bash
@ -121,3 +123,13 @@ pip uninstall bigdl-orca-spark3 bigdl-dllib-spark3 bigdl-tf bigdl-math bigdl-cor
``` ```
__Note__: If necessary, you need to manually uninstall `pyspark` and other [dependencies](https://github.com/intel-analytics/BigDL/tree/main/python/requirements/orca) introduced by Orca. __Note__: If necessary, you need to manually uninstall `pyspark` and other [dependencies](https://github.com/intel-analytics/BigDL/tree/main/python/requirements/orca) introduced by Orca.
---
## Download BigDL Orca
You can also download the BigDL package via the download links below. Besides, you can use the [script](https://github.com/intel-analytics/BigDL/blob/main/scripts/download-bigdl.sh) to download.
| | BigDL 2.1.0 | BigDL 2.2.0-SNAPSHOT nightly |
| :-------: | :---------: | :--------------------------: |
| Spark 2.4 | [download](https://repo1.maven.org/maven2/com/intel/analytics/bigdl/bigdl-assembly-spark_2.4.6/2.1.0/bigdl-assembly-spark_2.4.6-2.1.0-fat-jars.zip) | [download](https://oss.sonatype.org/content/repositories/snapshots/com/intel/analytics/bigdl/bigdl-assembly-spark_2.4.6/2.2.0-SNAPSHOT/) |
| Spark 3.1 | [download](https://repo1.maven.org/maven2/com/intel/analytics/bigdl/bigdl-assembly-spark_3.1.2/2.1.0/bigdl-assembly-spark_3.1.2-2.1.0-fat-jars.zip) | [download](https://oss.sonatype.org/content/repositories/snapshots/com/intel/analytics/bigdl/bigdl-assembly-spark_3.1.3/2.2.0-SNAPSHOT/) |

2
docs/readthedocs/source/doc/Orca/Tutorial/yarn.md
View file

@ -309,7 +309,7 @@ On the __Client Node__:
export SPARK_HOME=/path/to/spark # the folder path where you extract the Spark package export SPARK_HOME=/path/to/spark # the folder path where you extract the Spark package
export SPARK_VERSION="downloaded spark version" export SPARK_VERSION="downloaded spark version"
``` ```
2. Download and unzip a BigDL assembly package from [BigDL Assembly Spark 2.4.6](https://repo1.maven.org/maven2/com/intel/analytics/bigdl/bigdl-assembly-spark_2.4.6/2.1.0/bigdl-assembly-spark_2.4.6-2.1.0-fat-jars.zip) or [BigDL Assembly Spark 3.1.2](https://repo1.maven.org/maven2/com/intel/analytics/bigdl/bigdl-assembly-spark_3.1.2/2.1.0/bigdl-assembly-spark_3.1.2-2.1.0-fat-jars.zip) (according to your Spark version), then setup the environment variables `${BIGDL_HOME}` and `${BIGDL_VERSION}`. 2. Refer to [here](../Overview/install.html#download-bigdl-orca) to download and unzip a BigDL assembly package. Make sure the Spark version of your downloaded BigDL matches your downloaded Spark. Then setup the environment variables `${BIGDL_HOME}` and `${BIGDL_VERSION}`.
```bash ```bash
export BIGDL_HOME=/path/to/unzipped_BigDL export BIGDL_HOME=/path/to/unzipped_BigDL
export BIGDL_VERSION="downloaded BigDL version" export BIGDL_VERSION="downloaded BigDL version"