diff --git a/README.md b/README.md index 165fa31d..8447584e 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ --- -BigDL makes it easy for data scientists and data engineers to build end-to-end, distributed AI applications. The **BigDL 2.0** release combines the original [BigDL](https://github.com/intel-analytics/BigDL/tree/branch-0.14) and [Analytics Zoo](https://github.com/intel-analytics/analytics-zoo) projects, providing the following features: +BigDL makes it easy for data scientists and data engineers to build end-to-end, distributed AI applications. The **BigDL 2.0** release combines the [original BigDL](https://github.com/intel-analytics/BigDL/tree/branch-0.14) and [Analytics Zoo](https://github.com/intel-analytics/analytics-zoo) projects, providing the following features: * [DLlib](#getting-started-with-dllib): distributed deep learning library for Apache Spark *(i.e., the original BigDL framework with Keras-style API and Spark ML pipeline support)* diff --git a/docs/readthedocs/source/doc/DLlib/Overview/dllib.md b/docs/readthedocs/source/doc/DLlib/Overview/dllib.md index a43c9eb2..beb7fbef 100644 --- a/docs/readthedocs/source/doc/DLlib/Overview/dllib.md +++ b/docs/readthedocs/source/doc/DLlib/Overview/dllib.md @@ -1,8 +1,26 @@ # DLlib User Guide +## 1. Overview + DLlib is a distributed deep learning library for Apache Spark; with DLlib, users can write their deep learning applications as standard Spark programs (using either Scala or Python APIs). -It includes the functionalities of the original [BigDL](https://github.com/intel-analytics/BigDL/tree/branch-0.14) project, and provides following high-level APIs for distributed deep learning on Spark: +It includes the functionalities of the [original BigDL](https://github.com/intel-analytics/BigDL/tree/branch-0.14) project, and provides following high-level APIs for distributed deep learning on Spark: * [Keras-like API](keras-api.md) * [Spark ML pipeline support](nnframes.md) + +## 2. Scala user guide + +### 2.1 Install + +### 2.2 Run + +### 2.3 Get started (example) + +## 3. Python user guide + +### 3.1 Install + +### 3.2 Run + +### 3.3 Get started (example) diff --git a/docs/readthedocs/source/index.rst b/docs/readthedocs/source/index.rst index e9a402b6..1c0f9410 100644 --- a/docs/readthedocs/source/index.rst +++ b/docs/readthedocs/source/index.rst @@ -3,7 +3,7 @@ BigDL Documentation ------ -`BigDL `_ makes it easy for data scientists and data engineers to build end-to-end, distributed AI applications. The **BigDL 2.0** release combines the original `BigDL `_ and `Analytics Zoo `_ projects, providing the following features: +`BigDL `_ makes it easy for data scientists and data engineers to build end-to-end, distributed AI applications. The **BigDL 2.0** release combines the `original BigDL `_ and `Analytics Zoo `_ projects, providing the following features: * `DLlib `_: distributed deep learning library for Apache Spark * `Orca `_: seamlessly scale out TensorFlow and PyTorch pipelines for distributed Big Data