From b38ed3934a3b405e8d8707bcb8c0873aedd442aa Mon Sep 17 00:00:00 2001 From: binmakeswell Date: Fri, 4 Mar 2022 18:04:51 +0800 Subject: [PATCH] add badge and contributor list --- README-zh-Hans.md | 20 +++++++++++++++----- README.md | 24 ++++++++++++++++++------ 2 files changed, 33 insertions(+), 11 deletions(-) diff --git a/README-zh-Hans.md b/README-zh-Hans.md index 7b6efa462..9c116a956 100644 --- a/README-zh-Hans.md +++ b/README-zh-Hans.md @@ -13,6 +13,8 @@ [![Build](https://github.com/hpcaitech/ColossalAI/actions/workflows/PR_CI.yml/badge.svg)](https://github.com/hpcaitech/ColossalAI/actions/workflows/PR_CI.yml) [![Documentation](https://readthedocs.org/projects/colossalai/badge/?version=latest)](https://colossalai.readthedocs.io/en/latest/?badge=latest) [![codebeat badge](https://codebeat.co/badges/bfe8f98b-5d61-4256-8ad2-ccd34d9cc156)](https://codebeat.co/projects/github-com-hpcaitech-colossalai-main) + [![slack badge](https://img.shields.io/badge/Slack-join-blueviolet?logo=slack&)](https://join.slack.com/t/colossalaiworkspace/shared_invite/zt-z7b26eeb-CBp7jouvu~r0~lcFzX832w) + [![WeChat badge](https://img.shields.io/badge/微信-加入-green?logo=wechat&)](./docs/images/WeChat.png) | [English](README.md) | [中文](README-zh-Hans.md) | @@ -110,10 +112,23 @@ docker build -t colossalai ./docker docker run -ti --gpus all --rm --ipc=host colossalai bash ``` + +## 社区 +欢迎通过[论坛](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社区,与我们分享你的建议和问题。 + + ## 做出贡献 欢迎为该项目做出贡献,请参阅[贡献指南](./CONTRIBUTING.md)。 +真诚感谢所有贡献者! + + + +*贡献者头像的展示顺序是随机的。* + ## 快速预览 @@ -195,11 +210,6 @@ 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 4512b695f..8528ac2a8 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,8 @@ [![Build](https://github.com/hpcaitech/ColossalAI/actions/workflows/PR_CI.yml/badge.svg)](https://github.com/hpcaitech/ColossalAI/actions/workflows/PR_CI.yml) [![Documentation](https://readthedocs.org/projects/colossalai/badge/?version=latest)](https://colossalai.readthedocs.io/en/latest/?badge=latest) [![codebeat badge](https://codebeat.co/badges/bfe8f98b-5d61-4256-8ad2-ccd34d9cc156)](https://codebeat.co/projects/github-com-hpcaitech-colossalai-main) + [![slack badge](https://img.shields.io/badge/Slack-join-blueviolet?logo=slack&)](https://join.slack.com/t/colossalaiworkspace/shared_invite/zt-z7b26eeb-CBp7jouvu~r0~lcFzX832w) + [![WeChat badge](https://img.shields.io/badge/微信-加入-green?logo=wechat&)](./docs/images/WeChat.png) | [English](README.md) | [中文](README-zh-Hans.md) | @@ -99,6 +101,7 @@ If you don't want to install and enable CUDA kernel fusion (compulsory installat pip install --global-option="--no_cuda_ext" . ``` + ## Use Docker Run the following command to build a docker image from Dockerfile provided. @@ -114,10 +117,24 @@ Run the following command to start the docker container in interactive mode. docker run -ti --gpus all --rm --ipc=host colossalai bash ``` + +## 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. + + + ## Contributing -If you wish to contribute to this project, you can follow the guideline in [Contributing](./CONTRIBUTING.md) +If you wish to contribute to this project, please follow the guideline in [Contributing](./CONTRIBUTING.md). +Thanks so much to all of our amazing contributors! + + + +*The order of contributor avatars is randomly shuffled.* ## Quick View @@ -201,11 +218,6 @@ 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