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.

Sign up for GitHub

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

Jump to bottom

[DOC] qualx related tool lacks of the doc to list required dependencies #1321

Open
wjxiz1992 opened this issue Aug 30, 2024 · 1 comment
Open

[DOC] qualx related tool lacks of the doc to list required dependencies #1321

wjxiz1992 opened this issue Aug 30, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation user_tools Scope the wrapper module running CSP, QualX, and reports (python)

Comments

@wjxiz1992
Copy link
Collaborator

Report incorrect documentation

Location of incorrect documentation
The qualx doc says refer to Get started doc to install required dependencies, but it seems there is not such lines that tells users what to install. E.g. Optuna is required, but it's not listed out.

Suggested fix for documentation
Just a section like

pip install optuna, xgboost etc...
@wjxiz1992 wjxiz1992 added ? - Needs Triage documentation Improvements or additions to documentation labels Aug 30, 2024
@amahussein amahussein added the user_tools Scope the wrapper module running CSP, QualX, and reports (python) label Aug 30, 2024
@amahussein
Copy link
Collaborator

Thanks @wjxiz1992
It is an optional installation pip install -e.[qualx]
If you want to install packages related to tests as well. pip install -e.[qualx,test]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation user_tools Scope the wrapper module running CSP, QualX, and reports (python)
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@wjxiz1992 @amahussein