Release v0.4.0

Co-authored-by: Lysandre Debut <lysandre@huggingface.co>

docs/source/conf.py

@@ -25,7 +25,7 @@ copyright = "2020, The Hugging Face Team, Licenced under the Apache License, Ver
 author = "huggingface"
 
 # The short X.Y version
-version = "0.4.0.dev0"
+version = "0.4.0"
 
 # -- General configuration ---------------------------------------------------
 

docs/source/index.rst

@@ -136,7 +136,7 @@ Supported integrations
 - multi-GPU on several nodes (machines)
 - TPU
 - FP16 with native AMP (apex on the roadmap)
-- DeepSpeed (experimental)
+- DeepSpeed (experimental support)
 
 .. toctree::
     :maxdepth: 2

docs/source/quicktour.rst

@@ -381,6 +381,22 @@ this:
         lr_scheduler.step()
 
 
+DeepSpeed
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+DeepSpeed support is experimental, so the underlying API will evolve in the near future and may have some slight
+breaking changes. In particular, 🤗 Accelerate does not support DeepSpeed config you have written yourself yet, this
+will be added in a next version.
+
+One main caveat for the DeepSpeed integration is that the DeepSpeed launcher always passes a ``local_rank`` variable to
+the training script, so your training script should accept it (whether you launch training with the DeepSpeed launcher
+or ``accelerate launch``).
+
+.. Warning::
+
+    The :func:`~accelerate.notebook_launcher` does not support the DeepSpeed integration yet.
+
+
 Internal mechanism
 -----------------------------------------------------------------------------------------------------------------------
 

setup.py

@@ -37,7 +37,7 @@ extras["sagemaker"] = [
 
 setup(
     name="accelerate",
-    version="0.4.0.dev0",
+    version="0.4.0",
     description="Accelerate",
     long_description=open("README.md", "r", encoding="utf-8").read(),
     long_description_content_type="text/markdown",

src/accelerate/__init__.py

@@ -2,7 +2,7 @@
 # There's no way to ignore "F401 '...' imported but unused" warnings in this
 # module, but to preserve other warnings. So, don't check this module at all.
 
-__version__ = "0.4.0.dev0"
+__version__ = "0.4.0"
 
 from .accelerator import Accelerator
 from .kwargs_handlers import DistributedDataParallelKwargs, GradScalerKwargs