Skip to content

Commit 4dd7296

Browse files
edward-iofacebook-github-bot
authored andcommitted
Update README.md for 0.1.0 release (#126)
Summary: Please read through our [contribution guide](https://github.com/pytorch/torchsnapshot/blob/main/CONTRIBUTING.md) prior to creating your pull request. <!-- Change Summary --> Pull Request resolved: #126 Test Plan: Fixes #{issue number} Reviewed By: ananthsub Differential Revision: D40818661 Pulled By: edward-io fbshipit-source-id: b1a3590530b587abc5c52dc2e9a14d5095ded6df
1 parent 0df6f81 commit 4dd7296

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# torchsnapshot
1+
# TorchSnapshot (Beta Release)
22

33
<p align="center">
44
<a href="https://github.com/pytorch/torchsnapshot/actions?query=branch%3Amain"><img src="https://img.shields.io/github/workflow/status/pytorch/torchsnapshot/Unit%20tests/main" alt="build status"></a>
@@ -8,8 +8,6 @@
88
<a href="https://github.com/pytorch/torchsnapshot/blob/main/LICENSE"><img src="https://img.shields.io/pypi/l/torchsnapshot" alt="bsd license"></a>
99
</div>
1010

11-
**This library is currently in Alpha and currently does not have a stable release. The API may change and may not be backward compatible. If you have suggestions for improvements, please open a GitHub issue. We'd love to hear your feedback.**
12-
1311
A performant, memory-efficient checkpointing library for PyTorch applications, designed with large, complex distributed workloads in mind.
1412

1513

@@ -20,9 +18,14 @@ Requires Python >= 3.7 and PyTorch >= 1.12
2018
From pip:
2119

2220
```bash
21+
# Stable
22+
pip install torchsnapshot
23+
24+
# Nightly
2325
pip install --pre torchsnapshot-nightly
2426
```
2527

28+
2629
From source:
2730

2831
```bash

0 commit comments

Comments
 (0)