From eb3fda4c28785486eb8c395490916588306f82e4 Mon Sep 17 00:00:00 2001 From: Frank Lee Date: Mon, 14 Feb 2022 17:22:48 +0800 Subject: [PATCH] updated readme and change log (#224) --- CHANGE_LOG.md | 3 ++- README.md | 10 ++++++++-- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/CHANGE_LOG.md b/CHANGE_LOG.md index a7370abcd..ea69b301d 100644 --- a/CHANGE_LOG.md +++ b/CHANGE_LOG.md @@ -2,7 +2,7 @@ All notable changes to this project will be documented in this file. -## [Unreleased] v0.0.2 | 2022-02 +## v0.0.2 | 2022-02 ### Added @@ -18,6 +18,7 @@ All notable changes to this project will be documented in this file. - refactored utilities for tensor parallel and pipeline parallel - Separated benchmarks and examples as independent repositories - Updated pipeline parallelism to support non-interleaved and interleaved versions +- refactored installation scripts for convenience ### Fixed diff --git a/README.md b/README.md index 89ccc9d16..93282185f 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,9 @@ Documentation | Examples | Forum | - Blog - + Blog +
+ [![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) @@ -69,6 +70,11 @@ Run the following command to start the docker container in interactive mode. docker run -ti --gpus all --rm --ipc=host colossalai bash ``` +## Contributing + +If you wish to contribute to this project, you can follow the guideline in [Contributing](./CONTRIBUTING.md) + + ## Quick View ### Start Distributed Training in Lines