docs: improve installation instructions#452
docs: improve installation instructions#452DaniBodor merged 16 commits into432_add_tutorials_ppi_gcroci2from
Conversation
gcroci2
left a comment
There was a problem hiding this comment.
Nice additions and improvements :) I added very minor comments
README.md
Outdated
| ## Documentation | ||
| ## Test installation | ||
|
|
||
| To check that all components were installed correctly, run either of the following commands and ensure that all tests pass. |
There was a problem hiding this comment.
This is possible if the user has cloned the repo only, otherwise, there will be no tests/ folder. I'd just move this paragraph below the installation using the cloned repo. Also theoretically if the user installs the package from the version deployed on pypi he/she shouldn't care about testing that the package works (because it should); I know I specified the testing part in the tutorials but indeed I was a bit uncertain about that
| - `python -c "import torch; print(torch.version.cuda)"` | ||
| - if this returns `None`, use `cpu` instead | ||
| - For example: `https://data.pyg.org/whl/torch-2.0.0+cpu.html` | ||
| * Check if gcc is installed: `gcc --version`. |
There was a problem hiding this comment.
Same comment as for the readme, in case you need to add info just to the same here
docs/installation.md
Outdated
|
|
||
| ## Test installation | ||
|
|
||
| To check that all components were installed correctly, run either of the following commands and ensure that all tests pass. |
There was a problem hiding this comment.
Same comment as for the readme, in case you need to add info just to the same here
Added some more details to installation instructions. This is mainly stuff that could go wrong for super fresh systems.
I made the PR point to #432, since you also made changes to README there, plus I am referring to the tutorials.
closes: #451 and #450