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

Improve conda + pip build instructions in README.md and Sphinx documentation. #127

Open
ma595 opened this issue Dec 2, 2023 · 0 comments
Assignees
Labels
build documentation Improvements or additions to documentation

Comments

@ma595
Copy link
Collaborator

ma595 commented Dec 2, 2023

Deploying detectron2 easily across all systems is still not well documented. I propose a combined conda + pip approach as below:

conda install -c conda-forge gdal
conda install pytorch torchvision torchaudio pytorch-cuda=<cuda-version> -c pytorch -c nvidia
pip install .[ci] 

The first line ensures that the project can be installed on systems lacking the GDAL headers. The second conda line does the same, but for CUDA. pytorch binaries shipped with pip also come with their own CUDA runtime (pip install torch defaults to 12.1 as of 02/12/23). The only requirement for the latter to work is that global CUDA is >= 9.0.

Investigate whether including pytorch dependencies in setup.py or pyproject.toml is the right approach, or whether it is best to defer to the user. Either way, this needs to be commented, as we are relying on the outdated detectron2 instructions

@ma595 ma595 self-assigned this Dec 2, 2023
@ma595 ma595 added documentation Improvements or additions to documentation build labels Dec 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant