[chore] 0.3.1 release (#504)

* [chore] 0.3.1 release

- mainly because vissl needs the new version
- added a doc on release steps

* Update CHANGELOG.md
Co-authored-by: anj-s <32556631+anj-s@users.noreply.github.com>

* review comments
Co-authored-by: anj-s <32556631+anj-s@users.noreply.github.com>

.gitignore

+# Editor
 *~
 *.swp
 
+# Testing
 *.pyc
 *.pyo
-
 .mypy_cache/
 *.egg-info/
 
+# Build and release
 build/
 dist/
+.eggs/
 
 # Pytest verbose output
 test-results/

CHANGELOG.md

@@ -6,8 +6,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## NEXT - TBD
 
+### Added
+
+### Fixed
+
+## [0.3.1] - 2021-03-09
+### Added
+- FSDP docs ([#455](https://github.com/facebookresearch/fairscale/issues/455))
+- enable\_wrap and auto\_wrap APIs ([#446](https://github.com/facebookresearch/fairscale/issues/446))
+- Added experimental.nn.OffloadModel API for training large models on a single GPU.([#432](https://github.com/facebookresearch/fairscale/issues/432))
+
 ### Fixed
-- ShardedDDP auto catch trailing buckets (TBD)
+- OSS: fix a broken state dict when using non contiguous param groups
+- Several SDP fixes around performance and corner cases
+- Many FSDP fixes
+- AdaScale & SDP/FSDP test added but not officially supported
 
 ## [0.3.0] - 2021-02-22
 ### Added
@@ -17,7 +30,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 - Catch corner case when the model is too small with respect to the world size, and shards are empty ([#406](https://github.com/facebookresearch/fairscale/pull/406))
-- Memory leak in checkpoint_wrapper ([#412](https://github.com/facebookresearch/fairscale/pull/412))
+- Memory leak in checkpoint\_wrapper ([#412](https://github.com/facebookresearch/fairscale/pull/412))
 
 ## [0.1.7] - 2021-02-19
 ### Fixed

RELEASE.md

+## Steps to do a release
+
+- Update the CHANGELOG.md
+- Update `fairscale/__init__.py` and `docs/source/conf.py` for the new version number
+- git commit the change with title like "[chore] 0.3.1 release"
+- make a tag, like `git tag v0.3.1`
+- git push --tags origin [your/branch]
+- `python3 setup.py sdist` to build a new package (will be in dist/)
+- `python3 -m twine upload --repository pypi dist/*` to upload to pypi

docs/source/conf.py

@@ -29,7 +29,7 @@ copyright = "2020-2021, Facebook AI Research"
 author = "Facebook AI Research"
 
 # The full version, including alpha/beta/rc tags
-release = "0.3.0"
+release = "0.3.1"
 
 
 # -- General configuration ---------------------------------------------------

fairscale/__init__.py

@@ -4,7 +4,7 @@
 # LICENSE file in the root directory of this source tree.
 
 # Please update the doc version in docs/source/conf.py as well.
-__version__ = "0.3.0"
+__version__ = "0.3.1"
 
 ################################################################################
 # Import most common subpackages