You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-7Lines changed: 14 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,8 +4,6 @@
4
4
</picture>
5
5
<h1>TrainCheck: Invariant Checking & Observability for AI Training</h1>
6
6
7
-
[](https://github.com/OrderLab/traincheck/actions/workflows/pre-commit-checks.yml)
8
-
[](https://github.com/OrderLab/traincheck/actions/workflows/correctness_checks.yml)
9
7
[](https://discord.gg/ZvYewjsQ9D)
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).
60
67
We welcome feedback and contributions from early adopters.
Copy file name to clipboardExpand all lines: docs/installation-guide.md
+24-1Lines changed: 24 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff 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
+
1
19
## Compatibility
2
20
3
21
-**Python**: 3.10+ (due to reliance on type annotations)
0 commit comments