From beca837247771d0c2c1e0b8b38c1211b6851af54 Mon Sep 17 00:00:00 2001 From: edward-io <53842584+edward-io@users.noreply.github.com> Date: Fri, 28 Oct 2022 14:44:03 -0700 Subject: [PATCH 1/2] Update README.md for 0.1.0 release --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8918c9d..d6e7d84 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# torchsnapshot +# torchsnapshotβ

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,11 @@ Requires Python >= 3.7 and PyTorch >= 1.12 From pip: ```bash -pip install --pre torchsnapshot-nightly +pip install torchsnapshot +# for nightly, pip install --pre torchsnapshot-nightly ``` + From source: ```bash From 2c10afe349181445d35cbbd7f501156d01bf0051 Mon Sep 17 00:00:00 2001 From: edward-io <53842584+edward-io@users.noreply.github.com> Date: Fri, 28 Oct 2022 14:52:38 -0700 Subject: [PATCH 2/2] Update README.md --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d6e7d84..ecfa6f8 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# torchsnapshotβ +# TorchSnapshot (Beta Release)

build status @@ -18,8 +18,11 @@ Requires Python >= 3.7 and PyTorch >= 1.12 From pip: ```bash +# Stable pip install torchsnapshot -# for nightly, pip install --pre torchsnapshot-nightly + +# Nightly +pip install --pre torchsnapshot-nightly ```