Skip to content

Commit 7f5c3b6

Browse files
authored
added badges for pip and conda, and explicit installation instructions (#1390)
Fixes #1389
1 parent 2764a77 commit 7f5c3b6

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,12 @@
66

77
[![integration tests](https://github.com/pytorch/torchtitan/actions/workflows/integration_test_8gpu.yaml/badge.svg?branch=main)](https://github.com/pytorch/torchtitan/actions/workflows/integration_test_8gpu.yaml?query=branch%3Amain)
88
[![arXiv](https://img.shields.io/badge/arXiv-2410.06511-b31b1b.svg)](https://arxiv.org/abs/2410.06511)
9-
[![ICLR](https://img.shields.io/badge/ICLR-2025-blue.svg)](https://iclr.cc/virtual/2025/poster/29620)
9+
[![ICLR](https://img.shields.io/badge/ICLR-2025-violet.svg)](https://iclr.cc/virtual/2025/poster/29620)
1010
[![forum](https://img.shields.io/badge/pytorch-forum-DE3412.svg)](https://discuss.pytorch.org/c/distributed/torchtitan/44)
1111
[![license](https://img.shields.io/badge/license-BSD_3--Clause-lightgrey.svg)](./LICENSE)
12+
[![pip](https://img.shields.io/pypi/v/torchtitan?color=blue)](https://pypi.org/project/torchtitan/)
13+
[![conda](https://img.shields.io/conda/vn/conda-forge/torchtitan?color=green)](https://anaconda.org/conda-forge/torchtitan)
14+
1215

1316
</div>
1417

@@ -86,6 +89,22 @@ You may want to see how the model is defined or how parallelism techniques are a
8689

8790
## Installation
8891

92+
### Nightly
93+
94+
Coming soon.
95+
96+
### Stable
97+
98+
Via pip:
99+
```sh
100+
pip install torchtitan
101+
```
102+
Or via conda:
103+
```sh
104+
conda install conda-forge::torchtitan
105+
```
106+
### Sources
107+
89108
```bash
90109
git clone https://github.com/pytorch/torchtitan
91110
cd torchtitan

0 commit comments

Comments
 (0)