added additional install instructions

sandrlom · Aug 10, 2020 · 495d221 · 495d221
1 parent 21fb84a
commit 495d221
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -39,6 +39,7 @@ Learn more about EagerPy in the `documentation <https://eagerpy.jonasrauber.de>`
 
    pip install eagerpy
 
+EagerPy requires Python 3.6 or newer. Besides that, all essential dependencies are automatically installed. To use it with PyTorch, TensorFlow, JAX, or NumPy, the respective framework needs to be installed separately. These frameworks are not declared as dependencies because not everyone wants to use and thus install all of them and because some of these packages have different builds for different architectures and CUDA\footnote{\url{https://developer.nvidia.com/cuda-zone}} versions.
 
 🎉 Example
 -----------

diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md
@@ -8,6 +8,8 @@ You can install the latest release from [PyPI](https://pypi.org/project/eagerpy/
 python3 -m pip install eagerpy
 ```
 
+EagerPy requires Python 3.6 or newer. Besides that, all essential dependencies are automatically installed. To use it with PyTorch, TensorFlow, JAX, or NumPy, the respective framework needs to be installed separately. These frameworks are not declared as dependencies because not everyone wants to use and thus install all of them and because some of these packages have different builds for different architectures and CUDA\footnote{\url{https://developer.nvidia.com/cuda-zone}} versions.
+
 ::: warning NOTE
 EagerPy requires Python 3.6 or newer.
 :::
-Original file line number
+Diff line change
@@ Expand Up @@
        pip install eagerpy
+    EagerPy requires Python 3.6 or newer. Besides that, all essential dependencies are automatically installed. To use it with PyTorch, TensorFlow, JAX, or NumPy, the respective framework needs to be installed separately. These frameworks are not declared as dependencies because not everyone wants to use and thus install all of them and because some of these packages have different builds for different architectures and CUDA\footnote{\url{https://developer.nvidia.com/cuda-zone}} versions.
     🎉 Example
     -----------
@@ Expand Down @@