-
Notifications
You must be signed in to change notification settings - Fork 508
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
Add optional install options with pip #627
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is nice.
I would like tu name the re quirement file requirements_all.txt instead of
opt. Also It shoudo be used/upadted in the github actions
Hello @SarahG-579462 , Thanks again for your contribution. We plan on doing a release is a few days. It would be nice to have merged this PR that will allow better installation. Could you have aquicl look at my comment and merge the conflcts with current setup.py? |
Co-authored-by: Rémi Flamary <[email protected]>
thanks @SarahG-579462 , we still need to change the requirement file name to |
Great, thanks for your help ! |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #627 +/- ##
==========================================
- Coverage 96.68% 96.66% -0.03%
==========================================
Files 85 85
Lines 16890 16898 +8
==========================================
+ Hits 16330 16334 +4
- Misses 560 564 +4 |
Types of changes
This PR allows users to install the optional dependencies found in
requirements.txt
withpip install POT[all]
, or specific requirements withpip install POT[backend-pytorch]
for example.Motivation and context / Related issue
This clarifies that
requirements.txt
are optional dependencies, and finds which modules are optional for specific parts of the code and adds them as an installation option.The specific install options are:
backend-jax, backend-tf, backend-torch, cvxopt, dr, gnn, all
.Using
all
installs all modules previously available in requirements.txt (which is renamed requirements_opt.txt)This solves the misunderstanding I had in #622, by clarifying that
cvxopt
is an optional dependency.How has this been tested (if it applies)
pip install .[subparts]
to ensure that the requested modules are installedPR checklist