Skip to content

Update api documentation of function#357

Merged
mfeurer merged 1 commit intodevelopfrom
fix_api_docs
Oct 13, 2017
Merged

Update api documentation of function#357
mfeurer merged 1 commit intodevelopfrom
fix_api_docs

Conversation

@mfeurer
Copy link
Copy Markdown
Collaborator

@mfeurer mfeurer commented Oct 13, 2017

This PR just adds the missing functions to the API docs and fixes a few rendering bugs.

@amueller
Copy link
Copy Markdown
Contributor

wait did we both send the same PR?

Comment thread doc/api.rst Outdated
OpenMLDataset
OpenMLRun
OpenMLTask
OpenMLSplit
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you're missing Evaluation ;)

@mfeurer
Copy link
Copy Markdown
Collaborator Author

mfeurer commented Oct 13, 2017

Apparently we did ;) Let's just merge both, they're dissimilar enough. And I didn't have evaluations in there one purpose because I wanted to get the functions first.

@amueller
Copy link
Copy Markdown
Contributor

you need to resolve the merge...

@mfeurer
Copy link
Copy Markdown
Collaborator Author

mfeurer commented Oct 13, 2017

Done ;)

Comment thread doc/api.rst
get_datasets
list_datasets

:mod:`openml.evaluations`: Evaluation Functions
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this section is now duplicate?

@mfeurer mfeurer merged commit 50ffc21 into develop Oct 13, 2017
@mfeurer mfeurer deleted the fix_api_docs branch October 13, 2017 13:05
@codecov-io
Copy link
Copy Markdown

codecov-io commented Oct 13, 2017

Codecov Report

Merging #357 into develop will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           develop    #357   +/-   ##
=======================================
  Coverage     89.8%   89.8%           
=======================================
  Files           32      32           
  Lines         2571    2571           
=======================================
  Hits          2309    2309           
  Misses         262     262
Impacted Files Coverage Δ
openml/evaluations/functions.py 91.89% <ø> (ø) ⬆️
openml/flows/functions.py 92.47% <ø> (ø) ⬆️
openml/setups/functions.py 93.06% <ø> (ø) ⬆️
openml/runs/functions.py 87.5% <ø> (ø) ⬆️
openml/runs/run.py 92.6% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 08c9cf6...53ff7ee. Read the comment docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants