Skip to content

Update README.md for 0.1.0 release #126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Update README.md for 0.1.0 release #126

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
beca837
Update README.md for 0.1.0 release
edward-io Oct 28, 2022
2c10afe
Update README.md
edward-io Oct 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# torchsnapshot
# TorchSnapshot (Beta Release)

<p align="center">
<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>
Expand All @@ -8,8 +8,6 @@
<a href="https://github.com/pytorch/torchsnapshot/blob/main/LICENSE"><img src="https://img.shields.io/pypi/l/torchsnapshot" alt="bsd license"></a>
</div>

**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.**

A performant, memory-efficient checkpointing library for PyTorch applications, designed with large, complex distributed workloads in mind.


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

```bash
# Stable
pip install torchsnapshot

# Nightly
pip install --pre torchsnapshot-nightly
```


From source:

```bash
Expand Down