Skip to content

Commit

Permalink
Merge 56afe81 into 46f90fe
Browse files Browse the repository at this point in the history
  • Loading branch information
rvlb committed Apr 26, 2021
2 parents 46f90fe + 56afe81 commit c8bc501
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 5 deletions.
14 changes: 9 additions & 5 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
-----------------------
Expand Down
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

```
Expand Down

0 comments on commit c8bc501

Please sign in to comment.