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

The API docs should document the openml config options #901

Closed
joaquinvanschoren opened this issue Feb 15, 2020 · 1 comment · Fixed by #931
Closed

The API docs should document the openml config options #901

joaquinvanschoren opened this issue Feb 15, 2020 · 1 comment · Fixed by #931
Assignees
Labels
Documentation Good First Issue Issues suitable for people new to contributing to openml-python!

Comments

@joaquinvanschoren
Copy link
Contributor

Description

The API Docs: http://openml.github.io/openml-python/master/api.html
do not cover the API config options, such as 'server, api_key, verbosity,...'

Could this be added?

Steps/Code to Reproduce

Try to look up the OpenML-Python config options on
http://openml.github.io/openml-python/master/api.html

Expected Results

Maybe a section 'Configuration' next to 'Top level Classes', 'Extensions' and 'Modules'?

Actual Results

Nothing there.

Versions

Irrelevant

@PGijsbers
Copy link
Collaborator

I noticed that not only programmatic configuration, but also configuration through the configuration file is missing.

@PGijsbers PGijsbers added Documentation Good First Issue Issues suitable for people new to contributing to openml-python! labels Apr 20, 2020
@marcoslbueno marcoslbueno self-assigned this Jul 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Good First Issue Issues suitable for people new to contributing to openml-python!
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants