Skip to content

Commit d6b48fb

Browse files
committed
add installation section to readme
1 parent 752c210 commit d6b48fb

File tree

3 files changed

+39
-9
lines changed

3 files changed

+39
-9
lines changed

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44
</picture>
55
<h1>TrainCheck: Invariant Checking & Observability for AI Training</h1>
66

7-
[![format and types](https://github.com/OrderLab/traincheck/actions/workflows/pre-commit-checks.yml/badge.svg)](https://github.com/OrderLab/traincheck/actions/workflows/pre-commit-checks.yml)
8-
[![format and types](https://github.com/OrderLab/traincheck/actions/workflows/correctness_checks.yml/badge.svg)](https://github.com/OrderLab/traincheck/actions/workflows/correctness_checks.yml)
97
[![Chat on Discord](https://img.shields.io/badge/Discord-Join%20us-5865F2?logo=discord&logoColor=white)](https://discord.gg/ZvYewjsQ9D)
108
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/OrderLab/TrainCheck)
119

@@ -31,6 +29,16 @@ No manual tests required. TrainCheck automatically learns the invariants of your
3129
Drop-in support for PyTorch, Hugging Face, and industry-class workloads using DeepSpeed/Megatron and more.
3230

3331
---
32+
## Installation
33+
34+
Install TrainCheck in the Python environment where you will run your training script:
35+
36+
```bash
37+
pip3 install traincheck
38+
```
39+
40+
For detailed setup (CUDA configuration, UV, conda environments), see the [Installation Guide](https://orderlab.io/TrainCheck/installation-guide/).
41+
3442

3543
### How It Works
3644

@@ -49,14 +57,13 @@ Work through [5‑Minute Experience with TrainCheck](./docs/5-min-tutorial.md).
4957

5058
## Documentation
5159

52-
- **[Installation Guide](./docs/installation-guide.md)**
53-
- **[Usage Guide: Scenarios and Limitations](./docs/usage-guide.md)**
54-
- **[TrainCheck Technical Doc](./docs/technical-doc.md)**
55-
- **[TrainCheck Dev RoadMap](./ROADMAP.md)**
60+
- **[Installation Guide](https://orderlab.io/TrainCheck/installation-guide/)**
61+
- **[Usage Guide: Scenarios and Limitations](https://orderlab.io/TrainCheck/usage-guide/)**
62+
- **[TrainCheck Technical Doc](https://orderlab.io/TrainCheck/technical-doc/)**
5663

5764
## Status
5865

59-
TrainCheck is under active development. Please join our 💬 [Discord server](https://discord.gg/VwxpJDvB) or file a GitHub issue for support.
66+
TrainCheck is under active development. Please join our 💬 [Discord server](https://discord.gg/VwxpJDvB) or file a GitHub issue for support. You can also reach the team at [traincheck@umich.edu](mailto:traincheck@umich.edu).
6067
We welcome feedback and contributions from early adopters.
6168

6269
## Contributing

docs/installation-guide.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
1+
## Quick Install
2+
3+
Install TrainCheck in the Python environment where you will run your training script:
4+
5+
```bash
6+
pip3 install traincheck
7+
```
8+
9+
> **Note:** Install PyTorch separately first (see step 3 below) to ensure the right CUDA version is selected. If you already have PyTorch installed, the command above is all you need.
10+
11+
For UV users:
12+
13+
```bash
14+
uv pip install traincheck
15+
```
16+
17+
---
18+
119
## Compatibility
220

321
- **Python**: 3.10+ (due to reliance on type annotations)
@@ -47,7 +65,12 @@
4765
conda install cudatoolkit
4866
```
4967
50-
5. **Clone & install TrainCheck**
68+
5. **Install TrainCheck**
69+
```bash
70+
pip3 install traincheck
71+
```
72+
73+
If you prefer to install from source:
5174
```bash
5275
git clone https://github.com/OrderLab/TrainCheck.git
5376
cd TrainCheck

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ include = ["traincheck", "traincheck.*"]
1212
[project]
1313
requires-python = ">= 3.10"
1414
name = "traincheck"
15-
version = "0.1.0"
15+
version = "0.1.2"
1616
description = "Training with Confidence: Catching Silent DL Training Bugs with Automated Proactive Checks"
1717
authors = [
1818
{ name = "Yuxuan Jiang", email = "jyuxuan@umich.edu" },

0 commit comments

Comments
 (0)