docs: improve installation instructions #452
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 7 commits
June 27, 2023 12:34
This was
linked to
issues
Jun 27, 2023
Closed
gcroci2
approved these changes
Jul 4, 2023
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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