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

Test dependencies installation instructions #564

Open
magdalenafuentes opened this issue Nov 9, 2022 · 1 comment
Open

Test dependencies installation instructions #564

magdalenafuentes opened this issue Nov 9, 2022 · 1 comment
Labels
docs Updates/fixes to Docs tests changes to tests

Comments

@magdalenafuentes
Copy link
Collaborator

Following the instructions in the contributing guidelines I tried to install the tests dependencies as

pip install .[tests]

but it wouldn't work unless I do pip install ."[tests]". Same happens with [docs ].

It seems to be a terminal issue, that we should skip special caracters [ ] (see here).

A potential solution is to change the docs to be pip install ."[tests]", sounds good?

Also right now we're listing all the optional dependencies in the docs (e.g. pip install .[dali] pip install .[haydn_op20]), and that's unsustainable. Ideas on what to do here?

@guillemcortes
Copy link
Collaborator

Hi @magdalenafuentes , a fix for the installation of optional dependencies has been merged in #600 , should we close the issue or leave it open for the follow-up question on dataset specific optional dependencies? Maybe I would suggest not adding all the dataset specific dependencies install instructions to the docs, and doing it in the docstring of each particular dataset loader, for instance. In the docs we could change it to a more general description like:

To install dataset specific dependencies, check the docstring of the particular dataset loader. It should be something similar to pip install ."[<dataset_name>]".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Updates/fixes to Docs tests changes to tests
Projects
None yet
Development

No branches or pull requests

2 participants