[doc] added titans to readme (#125)

* [doc] added titans to readme * polish readme * polish readme
hpcaitech · May 12, 2022 · 40a32f6 · 40a32f6
1 parent acb8b59
commit 40a32f6
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -6,16 +6,30 @@ This repository provides various examples for **Colossal-AI**. For each feature
 Colossal-AI, you can find a simple example in the `feature` folder and a corresponding tutorial in feature section of the [**documentation**](https://www.colossalai.org/). For more complex examples for domain-specific models, you can find them in this repository as well. Some of them are covered in the advanced tutorials 
 of the [**documentation**](https://www.colossalai.org/).
 
+This repository is built upon Colossal-AI and Titans.
+
+<div align="center">
+    <img src="https://raw.githubusercontent.com/hpcaitech/public_assets/main/examples/images/repo_relation.png" width="300" title="repo-architecture">
+</div>
+
+
 ### 🚀 Quick Links
 
 [**Colossal-AI**](https://github.com/hpcaitech/ColossalAI) | 
+[**Titans**](https://github.com/hpcaitech/Titans)
 [**Paper**](https://arxiv.org/abs/2110.14883) | 
 [**Documentation**](https://www.colossalai.org/) | 
 [**Forum**](https://github.com/hpcaitech/ColossalAI/discussions) | 
 [**Blog**](https://www.colossalai.org/) 
 
 ## Setup
 
+1. Install Colossal-AI
+
+You can download Colossal-AI [here](https://www.colossalai.org/download).
+
+2. Install dependencies
+
 ```
 pip install -r requirements.txt
 ```

diff --git a/requirements.txt b/requirements.txt
@@ -1,3 +1,4 @@
 torch >= 1.8.0
 torchvision
-colossalai
+colossalai
+titans