Skip to content

Commit

Permalink
Merge pull request #52 from HongW2019/doc
Browse files Browse the repository at this point in the history
[ML-23]Update the documentation for OAP 1.1.0
  • Loading branch information
zhixingheyi-tian authored Apr 30, 2021
2 parents 0158e96 + d7706ac commit c0d03ac
Show file tree
Hide file tree
Showing 11 changed files with 13,643 additions and 978 deletions.
285 changes: 284 additions & 1 deletion CHANGELOG.md

Large diffs are not rendered by default.

1,957 changes: 1,957 additions & 0 deletions LICENSE

Large diffs are not rendered by default.

201 changes: 0 additions & 201 deletions LICENSE.txt

This file was deleted.

16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ You can find the all the OAP MLlib documents on the [project web page](https://o

### Java/Scala Users Preferred

Use a pre-built OAP MLlib JAR to get started. You can firstly download OAP package from [OAP-JARs-Tarball](https://github.com/Intel-bigdata/OAP/releases/download/v1.1.0-spark-3.0.0/oap-1.1.0-bin-spark-3.0.0.tar.gz) and extract this Tarball to get `oap-mllib-x.x.x-with-spark-x.x.x.jar` under `oap-1.1.0-bin-spark-3.0.0/jars`.
Use a pre-built OAP MLlib JAR to get started. You can firstly download OAP package from [OAP-JARs-Tarball](https://github.com/oap-project/oap-tools/releases/download/v1.1.0-spark-3.0.0/oap-1.1.0-bin-spark-3.0.0.tar.gz) and extract this Tarball to get `oap-mllib-x.x.x.jar` under `oap-1.1.0-bin-spark-3.0.0/jars`.

Then you can refer to the following [Running](#running) section to try out.

### Python/PySpark Users Preferred

Use a pre-built JAR to get started. If you have finished [OAP-Installation-Guide](./docs/OAP-Installation-Guide.md), you can find compiled OAP MLlib JAR `oap-mllib-x.x.x-with-spark-x.x.x.jar` in `$HOME/miniconda2/envs/oapenv/oap_jars/`.
Use a pre-built JAR to get started. If you have finished [OAP-Installation-Guide](./docs/OAP-Installation-Guide.md), you can find compiled OAP MLlib JAR `oap-mllib-x.x.x.jar` in `$HOME/miniconda2/envs/oapenv/oap_jars/`.

Then you can refer to the following [Running](#running) section to try out.

Expand All @@ -49,11 +49,11 @@ Users usually run Spark application on __YARN__ with __client__ mode. In that ca

```
# absolute path of the jar for uploading
spark.files /path/to/oap-mllib-x.x.x-with-spark-x.x.x.jar
spark.files /path/to/oap-mllib-x.x.x.jar
# absolute path of the jar for driver class path
spark.driver.extraClassPath /path/to/oap-mllib-x.x.x-with-spark-x.x.x.jar
spark.driver.extraClassPath /path/to/oap-mllib-x.x.x.jar
# relative path to spark.files, just specify jar name in current dir
spark.executor.extraClassPath ./oap-mllib-x.x.x-with-spark-x.x.x.jar
spark.executor.extraClassPath ./oap-mllib-x.x.x.jar
```

### Sanity Check
Expand Down Expand Up @@ -103,10 +103,10 @@ Intel® oneAPI Toolkits and its components can be downloaded and install from [h

More details about oneAPI can be found [here](https://software.intel.com/content/www/us/en/develop/tools/oneapi.html).

You can refer to [this script](dev/install-build-deps-centos.sh) to install correct dependencies.

Scala and Java dependency descriptions are already included in Maven POM file.

***Note:*** You can refer to [this script](dev/install-build-deps-centos.sh) to install correct dependencies: DPC++/C++, oneDAL, oneTBB, oneCCL.

### Build

#### Building oneCCL
Expand Down Expand Up @@ -162,7 +162,7 @@ To build, run the following commands:
$ ./build.sh
```

The built JAR package will be placed in `target` directory with the name `oap-mllib-x.x.x-with-spark-x.x.x.jar`.
The built JAR package will be placed in `target` directory with the name `oap-mllib-x.x.x.jar`.

## Examples

Expand Down
Loading

0 comments on commit c0d03ac

Please sign in to comment.