diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index da46026..f3f2024 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -59,17 +59,21 @@ Now, here's how to set up `entity-embed` for local development. $ cd entity-embed/ $ python setup.py develop -4. Install dev requirements:: +4. If you're using Conda instead of virtualenv, you must install PyTorch beforehand to have CUDA support:: + + $ conda install pytorch torchvision torchaudio cudatoolkit=11.1 -c pytorch -c conda-forge + +5. Install dev requirements (either on virtualenv or Conda):: $ pip install -r requirements-dev.txt -5. Create a branch for local development:: +6. Create a branch for local development:: $ git checkout -b name-of-your-bugfix-or-feature Now you can make your changes locally. -6. When you're done making changes, check that your changes pass flake8 and the +7. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:: $ flake8 entity-embed tests @@ -78,13 +82,13 @@ Now, here's how to set up `entity-embed` for local development. To get flake8 and tox, just pip install them into your virtualenv. -7. Commit your changes and push your branch to GitHub:: +8. Commit your changes and push your branch to GitHub:: $ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature -8. Submit a Pull Request through the GitHub website. +9. Submit a Pull Request through the GitHub website. Pull Request Guidelines ----------------------- diff --git a/README.md b/README.md index 9c1b4b1..a24e2df 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,14 @@ https://entity-embed.readthedocs.io And others, see [requirements.txt](/requirements.txt). +## For Conda users + +If you're using Conda, you must install PyTorch beforehand to have proper CUDA support. Inside the Conda environment, please run the following command **before** installing other packages using `pip`: +``` +conda install pytorch torchvision torchaudio cudatoolkit=11.1 -c pytorch -c conda-forge +``` +After doing so, you can proceed with installing other packages as usual. + ## Installation ```