From 4dd7296bd014fc3631aa81bd0bb7b26feaa597ed Mon Sep 17 00:00:00 2001 From: edward-io <53842584+edward-io@users.noreply.github.com> Date: Fri, 28 Oct 2022 15:17:58 -0700 Subject: [PATCH] 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. Pull Request resolved: https://github.com/pytorch/torchsnapshot/pull/126 Test Plan: Fixes #{issue number} Reviewed By: ananthsub Differential Revision: D40818661 Pulled By: edward-io fbshipit-source-id: b1a3590530b587abc5c52dc2e9a14d5095ded6df --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8918c9d..ecfa6f8 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# torchsnapshot +# TorchSnapshot (Beta Release)

build status @@ -8,8 +8,6 @@ bsd license -**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. @@ -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