diff --git a/docs/README.md b/docs/README.md index d5e0c22f5..edeb4ec25 100644 --- a/docs/README.md +++ b/docs/README.md @@ -72,7 +72,7 @@ Meanwhile, you need to ensure the `sidebars.json` is updated such that it contai ### 🧹 Doc Testing -Every documentation is tested to ensure it works well. You need to add the following line to the top of your file and replace `$command` with the actual command. Do note that the markdown will be converted into a Python file. Assuming you have a `demo.md` file, the test file generated will be `demo.py`. Therefore, you should use `demo.py` in your command, e.g. `python demo.py`. +Every documentation is tested to ensure it works well. You need to add the following line to the **bottom of your file** and replace `$command` with the actual command. Do note that the markdown will be converted into a Python file. Assuming you have a `demo.md` file, the test file generated will be `demo.py`. Therefore, you should use `demo.py` in your command, e.g. `python demo.py`. ```markdown diff --git a/docs/source/en/features/nvme_offload.md b/docs/source/en/features/nvme_offload.md index 68c422116..2933c3db6 100644 --- a/docs/source/en/features/nvme_offload.md +++ b/docs/source/en/features/nvme_offload.md @@ -1,4 +1,3 @@ - # NVMe offload Author: Hongxin Liu @@ -259,3 +258,6 @@ NVME offload saves about 294 MB memory. Note that enabling `pin_memory` of Gemin {{ autodoc:colossalai.nn.optimizer.HybridAdam }} {{ autodoc:colossalai.nn.optimizer.CPUAdam }} + + + diff --git a/docs/source/en/get_started/installation.md b/docs/source/en/get_started/installation.md index c1c34b411..672fd8ae0 100644 --- a/docs/source/en/get_started/installation.md +++ b/docs/source/en/get_started/installation.md @@ -1,12 +1,10 @@ - - # Setup Requirements: - PyTorch >= 1.11 (PyTorch 2.x in progress) - Python >= 3.7 - CUDA >= 11.0 - + If you encounter any problem about installation, you may want to raise an [issue](https://github.com/hpcaitech/ColossalAI/issues/new/choose) in this repository. @@ -47,3 +45,6 @@ If you don't want to install and enable CUDA kernel fusion (compulsory installat ```shell CUDA_EXT=1 pip install . ``` + + + diff --git a/docs/source/zh-Hans/features/nvme_offload.md b/docs/source/zh-Hans/features/nvme_offload.md index f8ecdab42..f33474efa 100644 --- a/docs/source/zh-Hans/features/nvme_offload.md +++ b/docs/source/zh-Hans/features/nvme_offload.md @@ -1,4 +1,3 @@ - # NVMe offload 作者: Hongxin Liu @@ -247,3 +246,6 @@ NVME 卸载节省了大约 294 MB 内存。注意使用 Gemini 的 `pin_memory` {{ autodoc:colossalai.nn.optimizer.HybridAdam }} {{ autodoc:colossalai.nn.optimizer.CPUAdam }} + + + diff --git a/docs/source/zh-Hans/get_started/installation.md b/docs/source/zh-Hans/get_started/installation.md index fb79fc676..7a9b20255 100755 --- a/docs/source/zh-Hans/get_started/installation.md +++ b/docs/source/zh-Hans/get_started/installation.md @@ -5,7 +5,7 @@ - PyTorch >= 1.11 (PyTorch 2.x 正在适配中) - Python >= 3.7 - CUDA >= 11.0 - + 如果你遇到安装问题,可以向本项目 [反馈](https://github.com/hpcaitech/ColossalAI/issues/new/choose)。 ## 从PyPI上安装 @@ -44,3 +44,5 @@ pip install . ```shell NO_CUDA_EXT=1 pip install . ``` + +