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

[Doc] Add collapsing functionality to the quicklink titles in landing page (#6225)

Browse source 
* Make sidebar titles in landing page collapsed

* Remove 'Slow PyTorch training with BF16' section in windows user guide
This commit is contained in:
Yuwen Hu 2022-10-24 10:52:47 +08:00 committed by GitHub
parent 9576d97187
commit f5ef76acf3
3 changed files with 84 additions and 60 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/readthedocs/source/_static/css/custom.css
View file

@ -60,10 +60,10 @@ code span.pre {
/* for landing page side bar */
.bigdl-quicklinks-section-nav {
padding-bottom: 0.5rem;
padding-left: 1rem;
}
.bigdl-quicklinks-section-title {
color: var(--pst-color-primary);
padding: 0.25rem 0rem;
}

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

@ -1,8 +1,14 @@
<nav class="bd-links">
<p class="bd-links__title">Quick Links</p>
<div class="navbar-nav">
<strong class="bigdl-quicklinks-section-title">Orca QuickStart</Q></strong>
<ul class="nav bigdl-quicklinks-section-nav">
<ul class="nav">
<li>
<strong class="bigdl-quicklinks-section-title">Orca QuickStart</strong>
<input id="quicklink-clsuter-orca" type="checkbox" class="toctree-checkbox" />
<label for="quicklink-clsuter-orca" class="toctree-toggle">
<i class="fa-solid fa-chevron-down"></i>
</label>
<ul class="bigdl-quicklinks-section-nav">
<li>
<a href="doc/UseCase/spark-dataframe.html">Use Spark Dataframe for Deep Learning</a>
</li>
@ -12,9 +18,14 @@
<li>
<a href="doc/Orca/QuickStart/orca-autoxgboost-quickstart.html">Use AutoXGBoost to tune XGBoost parameters automatically</a>
</li>
</ul>
</li>
<li>
<strong class="bigdl-quicklinks-section-title">Nano QuickStart</strong>
<input id="quicklink-clsuter-nano" type="checkbox" class="toctree-checkbox" />
<label for="quicklink-clsuter-nano" class="toctree-toggle">
<i class="fa-solid fa-chevron-down"></i>
</label>
<ul class="nav bigdl-quicklinks-section-nav">
<li>
<a href="doc/Nano/QuickStart/pytorch_train_quickstart.html">PyTorch Training Acceleration</a>
@ -32,7 +43,13 @@
<a href="doc/Nano/QuickStart/tensorflow_quantization_quickstart.html">Tensorflow Quantization Acceleration</a>
</li>
</ul>
</li>
<li>
<strong class="bigdl-quicklinks-section-title">DLlib QuickStart</strong>
<input id="quicklink-clsuter-dllib" type="checkbox" class="toctree-checkbox" />
<label for="quicklink-clsuter-dllib" class="toctree-toggle">
<i class="fa-solid fa-chevron-down"></i>
</label>
<ul class="nav bigdl-quicklinks-section-nav">
<li>
<a href="doc/DLlib/QuickStart/python-getting-started.html">Python QuickStart</a>
@ -41,7 +58,13 @@
<a href="doc/DLlib/QuickStart/scala-getting-started.html">Scala QuickStart</a>
</li>
</ul>
</li>
<li>
<strong class="bigdl-quicklinks-section-title">Chronos QuickStart</strong>
<input id="quicklink-clsuter-chronos" type="checkbox" class="toctree-checkbox" />
<label for="quicklink-clsuter-chronos" class="toctree-toggle">
<i class="fa-solid fa-chevron-down"></i>
</label>
<ul class="nav bigdl-quicklinks-section-nav">
<li>
<a href="doc/Chronos/QuickStart/chronos-tsdataset-forecaster-quickstart.html">Basic Forecasting</a>
@ -53,8 +76,13 @@
<a href="doc/Chronos/QuickStart/chronos-anomaly-detector.html">Anomaly Detection</a>
</li>
</ul>
</li>
<li>
<strong class="bigdl-quicklinks-section-title">PPML QuickStart</strong>
<input id="quicklink-clsuter-ppml" type="checkbox" class="toctree-checkbox" />
<label for="quicklink-clsuter-ppml" class="toctree-toggle">
<i class="fa-solid fa-chevron-down"></i>
</label>
<ul class="nav bigdl-quicklinks-section-nav">
<li>
<a href="doc/PPML/Overview/quicktour.html">Hello World Example</a>
@ -63,6 +91,7 @@
<a href="doc/PPML/QuickStart/end-to-end.html">End-to-End Example</a>
</li>
</ul>
</li>
</ul>
</div>
</nav>

9
docs/readthedocs/source/doc/UserGuide/win.md
View file

@ -94,12 +94,7 @@ This error may appear when you try to import torch. This is caused by Ubuntu 14.
sudo apt-get install libgomp1
```
### 2. Slow PyTorch training with BF16
Using BFloat16 mixed precision in PyTorch or PyTorch-Lightning training may be much slower than FP32.
### 3. ERROR: Could not build wheels for pycocotools, which is required to install pyproject.toml-based projects
### 2. ERROR: Could not build wheels for pycocotools, which is required to install pyproject.toml-based projects
pycocotools is a dependency of Intel neural-compressor which is used for inference quantization in BigDL-Nano. This error is usually caused by GCC library not installed in system. Just install gcc to resolve it:
@ -107,7 +102,7 @@ pycocotools is a dependency of Intel neural-compressor which is used for inferen
sudo apt-get install gcc
```
### 4. ValueError: After taking into account object store and redis memory usage, the amount of memory on this node available for tasks and actors is less than -75% of total.
### 3. ValueError: After taking into account object store and redis memory usage, the amount of memory on this node available for tasks and actors is less than -75% of total.
When running ray applications, you need to set the `memory` and `object_store_memory` properly according to your system memory capacity. This error indicates you have used too large memory configurations and you need to decrease them. For example on a laptop with 8G memory, you may set the memory configurations as below: