From 8264cd7ef11d1b40d1fc6069bd8c1b20dc78bd08 Mon Sep 17 00:00:00 2001 From: binmakeswell Date: Tue, 28 Feb 2023 15:39:51 +0800 Subject: [PATCH] [doc] add env scope (#2933) --- README-zh-Hans.md | 5 ++++- README.md | 4 +++- applications/ChatGPT/README.md | 2 +- docs/source/en/get_started/installation.md | 3 +++ docs/source/zh-Hans/get_started/installation.md | 2 ++ 5 files changed, 13 insertions(+), 3 deletions(-) diff --git a/README-zh-Hans.md b/README-zh-Hans.md index 54d97af82..0451d8609 100644 --- a/README-zh-Hans.md +++ b/README-zh-Hans.md @@ -273,7 +273,10 @@ Colossal-AI 为您提供了一系列并行组件。我们的目标是让您的

(返回顶端)

## 安装 -> Colossal-AI 目前仅支持Linux操作系统，没有在其他操作系统如Windows和macOS进行测试 +> Colossal-AI 目前仅支持Linux操作系统，没有在其他操作系统如Windows和macOS进行测试。 +> +> 环境要求: PyTorch 1.10 ~ 1.12 (更新版本正在兼容中), Python >= 3.7, CUDA >= 11.0。如果你遇到安装问题，可以向本项目 [反馈](https://github.com/hpcaitech/ColossalAI/issues/new/choose)。 + ### 从PyPI安装 diff --git a/README.md b/README.md index bb1b0e216..536511bc3 100644 --- a/README.md +++ b/README.md @@ -276,6 +276,8 @@ Acceleration of [AlphaFold Protein Structure](https://alphafold.ebi.ac.uk/) ## Installation > Colossal-AI currently only supports the Linux operating system and has not been tested on other OS such as Windows and macOS. +> +> Environment Requirement: PyTorch 1.10 ~ 1.12 (WIP higher version), 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. ### Install from PyPI @@ -353,7 +355,7 @@ docker run -ti --gpus all --rm --ipc=host colossalai bash Join the Colossal-AI community on [Forum](https://github.com/hpcaitech/ColossalAI/discussions), [Slack](https://join.slack.com/t/colossalaiworkspace/shared_invite/zt-z7b26eeb-CBp7jouvu~r0~lcFzX832w), -and [WeChat](https://raw.githubusercontent.com/hpcaitech/public_assets/main/colossalai/img/WeChat.png "qrcode") to share your suggestions, feedback, and questions with our engineering team. +and [WeChat(微信)](https://raw.githubusercontent.com/hpcaitech/public_assets/main/colossalai/img/WeChat.png "qrcode") to share your suggestions, feedback, and questions with our engineering team. ## Contributing diff --git a/applications/ChatGPT/README.md b/applications/ChatGPT/README.md index 0516991de..dbd5eb770 100644 --- a/applications/ChatGPT/README.md +++ b/applications/ChatGPT/README.md @@ -144,7 +144,7 @@ You may contact us or participate in the following ways: 1. Posting an [issue](https://github.com/hpcaitech/ColossalAI/issues/new/choose) or submitting a [PR](https://github.com/hpcaitech/ColossalAI/pulls) on GitHub 2. Join the Colossal-AI community on [Slack](https://join.slack.com/t/colossalaiworkspace/shared_invite/zt-z7b26eeb-CBp7jouvu~r0~lcFzX832w), -and [WeChat](https://raw.githubusercontent.com/hpcaitech/public_assets/main/colossalai/img/WeChat.png "qrcode") to share your ideas. +and [WeChat(微信)](https://raw.githubusercontent.com/hpcaitech/public_assets/main/colossalai/img/WeChat.png "qrcode") to share your ideas. 3. Check out and fill in the [cooperation proposal](https://www.hpc-ai.tech/partners) 4. Send your proposal to email contact@hpcaitech.com diff --git a/docs/source/en/get_started/installation.md b/docs/source/en/get_started/installation.md index 0e114696d..68c2c6a9f 100644 --- a/docs/source/en/get_started/installation.md +++ b/docs/source/en/get_started/installation.md @@ -2,6 +2,9 @@ # Setup > Colossal-AI currently only supports the Linux operating system and has not been tested on other OS such as Windows and macOS. +> +> Environment Requirement: PyTorch 1.10 ~ 1.12 (WIP higher version), 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. + ## Download From PyPI diff --git a/docs/source/zh-Hans/get_started/installation.md b/docs/source/zh-Hans/get_started/installation.md index 5f2351ffe..2edeb6393 100755 --- a/docs/source/zh-Hans/get_started/installation.md +++ b/docs/source/zh-Hans/get_started/installation.md @@ -1,5 +1,7 @@ # 安装 > Colossal-AI 目前仅支持Linux操作系统，没有在其他操作系统如Windows和macOS进行测试 +> +> 环境要求: PyTorch 1.10 ~ 1.12 (更新版本正在兼容中), Python >= 3.7, CUDA >= 11.0。如果你遇到安装问题，可以向本项目 [反馈](https://github.com/hpcaitech/ColossalAI/issues/new/choose)。 ## 从PyPI上安装