diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 3bdc1ea60..bb6c942cd 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,10 @@ blank_issues_enabled: true contact_links: - - name: "😊 Discussions" - url: https://github.com/hpcaitech/ColossalAI/discussions - about: Ask questions and discuss with other Colossal-AI community members in our forum + - name: ❓ Simple question - Slack Chat + url: https://join.slack.com/t/colossalaiworkspace/shared_invite/zt-z7b26eeb-CBp7jouvu~r0~lcFzX832w + about: This issue tracker is not for technical support. Please use our Slack chat, and ask the community for help. + - name: ❓ Simple question - WeChat + url: https://github.com/hpcaitech/ColossalAI/blob/main/docs/images/WeChat.png + about: This issue tracker is not for technical support. Please use WeChat, and ask the community for help. + - name: 😊 Advanced question - GitHub Discussions + url: https://github.com/hpcaitech/ColossalAI/discussions \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/proposal.yml b/.github/ISSUE_TEMPLATE/proposal.yml new file mode 100644 index 000000000..bb0683f1b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/proposal.yml @@ -0,0 +1,44 @@ +name: 💥 Proposal +description: Propose a non-trivial change to Colossal-AI + +body: + - type: markdown + attributes: + value: | + Common reasons for proposals include: + + - Altering the infrastructure; + - Bumping a critical dependency's major version; + - A significant improvement in user-friendliness; + - Significant refactor; + - ... + + Please note this is not for feature request or bug template; such action could make us identify the issue wrongly and close it without doing anything. + + We give you maximum freedom to write an elaborated proposal illustrating why you think the change is beneficial for us, and what steps we should take to turn this into reality. + + + - type: textarea + attributes: + label: Proposal + description: A clear and concise description of what the proposal is. + validations: + required: true + + - type: checkboxes + attributes: + label: Self-service + description: | + If you feel like you could contribute to this issue, please check the box below. This would tell us and other people looking for contributions that someone's working on it. + If you do check this box, please send a pull request within 7 days after a maintainer's approval so we can still delegate this to someone else. + + Proposals usually involve significant code changes, so please reach consensus with the maintainers before rushing to implement it, and make sure you follow the [Contributing Guidelines](https://github.com/hpcaitech/ColossalAI/blob/main/CONTRIBUTING.md). + This ensures that you don't waste your time and we don't waste ours reading the large diffs. + options: + - label: I'd be willing to do some initial work on this proposal myself. + + +- type: markdown + attributes: + value: > + Thanks for contributing 🎉! \ No newline at end of file diff --git a/README-zh-Hans.md b/README-zh-Hans.md index d952a5279..7b6efa462 100644 --- a/README-zh-Hans.md +++ b/README-zh-Hans.md @@ -34,30 +34,24 @@ Colossal-AI为您提供了一系列并行训练组件。我们的目标是让您 ## 样例 ### ViT - + - -- 14倍批大小 -- 5倍训练速度 +- 14倍批大小和5倍训练速度(张量并行=64) ### GPT-3 - + - - -- GPT-3:释放 50% GPU 资源占用, 或 10.7% 加速 +- 释放 50% GPU 资源占用, 或 10.7% 加速 ### GPT-2 - + -- GPT-2:降低11倍GPU显存占用,或超线性扩展 +- 降低11倍GPU显存占用,或超线性扩展 ### BERT - + - -- 2倍训练速度 -- 1.5倍序列长度 +- 2倍训练速度,或1.5倍序列长度 请访问我们的[文档和教程](https://www.colossalai.org/)以了解详情。 @@ -201,6 +195,13 @@ class MLP_2D(nn.Module): ``` +## 社区 +欢迎通过[论坛](https://github.com/hpcaitech/ColossalAI/discussions) +[Slack](https://join.slack.com/t/colossalaiworkspace/shared_invite/zt-z7b26eeb-CBp7jouvu~r0~lcFzX832w) +或 [微信](./docs/images/WeChat.png "qrcode") +加入Colossal-AI社区,与我们分享你的建议和问题。 + + ## 引用 ``` diff --git a/README.md b/README.md index 1b59dda77..4512b695f 100644 --- a/README.md +++ b/README.md @@ -37,30 +37,25 @@ distributed training in a few lines. ## Examples ### ViT - + -- 14x larger batch size -- 5x faster training +- 14x larger batch size, and 5x faster training for Tensor Parallel = 64 ### GPT-3 - + -- Free 50% GPU resources, or 10.7% acceleration for GPT-3 +- Free 50% GPU resources, or 10.7% acceleration ### GPT-2 - - -- 11x lower GPU RAM, or superlinear scaling for GPT-2 - + +- 11x lower GPU RAM, or superlinear scaling ### BERT - + - -- 2x faster training -- 50% longer sequence length +- 2x faster training, or 50% longer sequence length Please visit our [documentation and tutorials](https://www.colossalai.org/) for more details. @@ -206,6 +201,12 @@ class MLP_2D(nn.Module): ``` +## Community + +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](./docs/images/WeChat.png "qrcode") to share your suggestions, advice, and questions with our engineering team. + ## Cite Us diff --git a/docs/images/allinone/BERT_allin1.png b/docs/images/BERT.png similarity index 100% rename from docs/images/allinone/BERT_allin1.png rename to docs/images/BERT.png diff --git a/docs/images/BERT_seq.png b/docs/images/BERT_seq.png deleted file mode 100644 index 1cdf78269..000000000 Binary files a/docs/images/BERT_seq.png and /dev/null differ diff --git a/docs/images/allinone/GPT2_allin1.png b/docs/images/GPT2.png similarity index 100% rename from docs/images/allinone/GPT2_allin1.png rename to docs/images/GPT2.png diff --git a/docs/images/allinone/GPT3_allin1.png b/docs/images/GPT3.png similarity index 100% rename from docs/images/allinone/GPT3_allin1.png rename to docs/images/GPT3.png diff --git a/docs/images/GPT3Table.png b/docs/images/GPT3Table.png deleted file mode 100644 index 1754aa0b5..000000000 Binary files a/docs/images/GPT3Table.png and /dev/null differ diff --git a/docs/images/GPT_2_3.png b/docs/images/GPT_2_3.png deleted file mode 100644 index 08181c29d..000000000 Binary files a/docs/images/GPT_2_3.png and /dev/null differ diff --git a/docs/images/update/vit.png b/docs/images/ViT.png similarity index 100% rename from docs/images/update/vit.png rename to docs/images/ViT.png diff --git a/docs/images/ViT_TP.png b/docs/images/ViT_TP.png deleted file mode 100644 index f142cfefd..000000000 Binary files a/docs/images/ViT_TP.png and /dev/null differ diff --git a/docs/images/WeChat.png b/docs/images/WeChat.png new file mode 100644 index 000000000..2a6af7faa Binary files /dev/null and b/docs/images/WeChat.png differ