Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update installation.rst #306

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

bananenpampe
Copy link
Contributor

@bananenpampe bananenpampe commented May 29, 2024

Adds updated rascaline-torch installation instructions


📚 Documentation preview 📚: https://rascaline--306.org.readthedocs.build/en/306/

Adds updated rascaline-torch installation instructions
@@ -124,7 +124,7 @@ Building from source:
pip install --upgrade pip

# alternatively, the same thing in a single command
pip install git+https://github.com/luthaf/rascaline#subdirectory=python/rascaline-torch
pip install --extra-index-url https://download.pytorch.org/whl/cpu git+https://github.com/luthaf/rascaline#subdirectory=python/rascaline-torch
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not always necessary, and some people might want to install the cuda version of torch. A better solution here would be to do something like the metatensor docs: https://docs.metatensor.org/latest/installation.html#install-torch (the paragraph starting with "By default, PyTorch is installed with CUDA …")

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

okay, sure, but as is this recommended install will fail on all machines that do not have CUDA installed which is usually the case

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mean, people should be able to read 4 lines of text before blindly copy/pasting an installation command =). This will also be less of an issue when we do a full release on PyPI.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants