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

Doc: update sidebar and quickstarts order. (#6743)

Browse source 
* doc: update sidebar and quickstarts order.

* fix: adjust quickstart order.

* fix: fix typo.

* fix: fix typo.
This commit is contained in:
Cengguang Zhang 2022-11-23 18:57:11 +08:00 committed by GitHub
parent cd8d21dded
commit ca3b088522
3 changed files with 40 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/readthedocs/source/_templates/sidebar_quicklinks.html
View file

@ -10,13 +10,19 @@
</label> </label>
<ul class="bigdl-quicklinks-section-nav"> <ul class="bigdl-quicklinks-section-nav">
<li> <li>
<a href="doc/Orca/Howto/spark-dataframe.html">Use Spark DataFrames for Deep Learning</a> <a href="doc/Orca/QuickStart/orca-tf2keras-quickstart.html">TensorFlow 2 Quickstart</a>
</li> </li>
<li> <li>
<a href="doc/Orca/QuickStart/orca-pytorch-distributed-quickstart.html">Distributed PyTorch using Orca</a> <a href="doc/Orca/QuickStart/orca-pytorch-quickstart.html">PyTorch Quickstart</a>
</li> </li>
<li> <li>
<a href="doc/Orca/Howto/orca-autoxgboost-quickstart.html">Use AutoXGBoost to auto-tune XGBoost parameters</a> <a href="doc/Orca/QuickStart/ray-quickstart.html">RayOnSpark Quickstart</a>
</li>
<li>
<a href="doc/Orca/QuickStart/orca-tf-quickstart.html">TensorFlow 1.15 Quickstart</a>
</li>
<li>
<a href="doc/Orca/QuickStart/orca-keras-quickstart.html">Keras 2.3 Quickstart</a>
</li> </li>
</ul> </ul>
</li> </li>

4
docs/readthedocs/source/_toc.yml
View file

@ -42,11 +42,11 @@ subtrees:
title: "Quickstarts" title: "Quickstarts"
subtrees: subtrees:
- entries: - entries:
- file: doc/Orca/QuickStart/orca-tf-quickstart
- file: doc/Orca/QuickStart/orca-tf2keras-quickstart - file: doc/Orca/QuickStart/orca-tf2keras-quickstart
- file: doc/Orca/QuickStart/orca-keras-quickstart
- file: doc/Orca/QuickStart/orca-pytorch-quickstart - file: doc/Orca/QuickStart/orca-pytorch-quickstart
- file: doc/Orca/QuickStart/ray-quickstart - file: doc/Orca/QuickStart/ray-quickstart
- file: doc/Orca/QuickStart/orca-tf-quickstart
- file: doc/Orca/QuickStart/orca-keras-quickstart
- file: doc/Orca/Howto/index - file: doc/Orca/Howto/index
title: "How-to Guides" title: "How-to Guides"
subtrees: subtrees:

53
docs/readthedocs/source/doc/Orca/QuickStart/index.md
View file

@ -1,7 +1,31 @@
# Orca Quickstarts # Orca Quickstarts
- [**Orca TensorFlow 1.15 Quickstart**](./orca-tf-quickstart.html) - [**TensorFlow 2 Quickstart**](./orca-tf2keras-quickstart.html)
> ![](../../../../image/colab_logo_32px.png)[Run in Google Colab](https://colab.research.google.com/github/intel-analytics/BigDL/blob/main/python/orca/colab-notebook/quickstart/tf2_keras_lenet_mnist.ipynb) &nbsp;![](../../../../image/GitHub-Mark-32px.png)[View source on GitHub](https://github.com/intel-analytics/BigDL/blob/main/python/orca/colab-notebook/quickstart/tf2_keras_lenet_mnist.ipynb)
In this guide we will describe how to scale out TensorFlow 2 programs using Orca in 5 simple steps.
---------------------------
- [**PyTorch Quickstart**](./orca-pytorch-quickstart.html)
> ![](../../../../image/colab_logo_32px.png)[Run in Google Colab](https://colab.research.google.com/github/intel-analytics/BigDL/blob/main/python/orca/colab-notebook/quickstart/pytorch_lenet_mnist.ipynb) &nbsp;![](../../../../image/GitHub-Mark-32px.png)[View source on GitHub](https://github.com/intel-analytics/BigDL/blob/main/python/orca/colab-notebook/quickstart/pytorch_lenet_mnist.ipynb)
In this guide we will describe how to scale out PyTorch programs using Orca in 5 simple steps.
---------------------------
- [**RayOnSpark Quickstart**](./ray-quickstart.html)
> ![](../../../../image/colab_logo_32px.png)[Run in Google Colab](https://colab.research.google.com/github/intel-analytics/BigDL/blob/main/python/orca/colab-notebook/quickstart/ray_parameter_server.ipynb) &nbsp;![](../../../../image/GitHub-Mark-32px.png)[View source on GitHub](https://github.com/intel-analytics/BigDL/blob/main/python/orca/colab-notebook/quickstart/ray_parameter_server.ipynb)
In this guide we will describe how to use RayOnSpark to directly run Ray programs on Big Data clusters in 2 simple steps.
---------------------------
- [**TensorFlow 1.15 Quickstart**](./orca-tf-quickstart.html)
> ![](../../../../image/colab_logo_32px.png)[Run in Google Colab](https://colab.research.google.com/github/intel-analytics/BigDL/blob/main/python/orca/colab-notebook/quickstart/tf_lenet_mnist.ipynb) &nbsp;![](../../../../image/GitHub-Mark-32px.png)[View source on GitHub](https://github.com/intel-analytics/BigDL/blob/main/python/orca/colab-notebook/quickstart/tf_lenet_mnist.ipynb) > ![](../../../../image/colab_logo_32px.png)[Run in Google Colab](https://colab.research.google.com/github/intel-analytics/BigDL/blob/main/python/orca/colab-notebook/quickstart/tf_lenet_mnist.ipynb) &nbsp;![](../../../../image/GitHub-Mark-32px.png)[View source on GitHub](https://github.com/intel-analytics/BigDL/blob/main/python/orca/colab-notebook/quickstart/tf_lenet_mnist.ipynb)
@ -9,15 +33,7 @@
--------------------------- ---------------------------
- [**Orca TensorFlow 2 Quickstart**](./orca-tf2keras-quickstart.html) - [**Keras 2.3 Quickstart**](./orca-keras-quickstart.html)
> ![](../../../../image/colab_logo_32px.png)[Run in Google Colab](https://colab.research.google.com/github/intel-analytics/BigDL/blob/main/python/orca/colab-notebook/quickstart/tf2_keras_lenet_mnist.ipynb) &nbsp;![](../../../../image/GitHub-Mark-32px.png)[View source on GitHub](https://github.com/intel-analytics/BigDL/blob/main/python/orca/colab-notebook/quickstart/tf2_keras_lenet_mnist.ipynb)
In this guide we will describe how to to scale out TensorFlow 2 programs using Orca in 4 simple steps.
---------------------------
- [**Orca Keras 2.3 Quickstart**](./orca-keras-quickstart.html)
> ![](../../../../image/colab_logo_32px.png)[Run in Google Colab](https://colab.research.google.com/github/intel-analytics/BigDL/blob/main/python/orca/colab-notebook/quickstart/keras_lenet_mnist.ipynb) &nbsp;![](../../../../image/GitHub-Mark-32px.png)[View source on GitHub](https://github.com/intel-analytics/BigDL/blob/main/python/orca/colab-notebook/quickstart/keras_lenet_mnist.ipynb) > ![](../../../../image/colab_logo_32px.png)[Run in Google Colab](https://colab.research.google.com/github/intel-analytics/BigDL/blob/main/python/orca/colab-notebook/quickstart/keras_lenet_mnist.ipynb) &nbsp;![](../../../../image/GitHub-Mark-32px.png)[View source on GitHub](https://github.com/intel-analytics/BigDL/blob/main/python/orca/colab-notebook/quickstart/keras_lenet_mnist.ipynb)
@ -25,20 +41,3 @@
--------------------------- ---------------------------
- [**Orca PyTorch Quickstart**](./orca-pytorch-quickstart.html)
> ![](../../../../image/colab_logo_32px.png)[Run in Google Colab](https://colab.research.google.com/github/intel-analytics/BigDL/blob/main/python/orca/colab-notebook/quickstart/pytorch_lenet_mnist.ipynb) &nbsp;![](../../../../image/GitHub-Mark-32px.png)[View source on GitHub](https://github.com/intel-analytics/BigDL/blob/main/python/orca/colab-notebook/quickstart/pytorch_lenet_mnist.ipynb)
In this guide we will describe how to scale out PyTorch programs using Orca in 4 simple steps.
---------------------------
- [**Orca RayOnSpark Quickstart**](./ray-quickstart.html)
> ![](../../../../image/colab_logo_32px.png)[Run in Google Colab](https://colab.research.google.com/github/intel-analytics/BigDL/blob/main/python/orca/colab-notebook/quickstart/ray_parameter_server.ipynb) &nbsp;![](../../../../image/GitHub-Mark-32px.png)[View source on GitHub](https://github.com/intel-analytics/BigDL/blob/main/python/orca/colab-notebook/quickstart/ray_parameter_server.ipynb)
In this guide, we will describe how to use RayOnSpark to directly run Ray programs on Big Data clusters in 2 simple steps.
---------------------------