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

Doc: Adds documentation for the dataset compression argument from #1341 and #1250 #1386

Merged
merged 3 commits into from
Feb 3, 2022

Conversation

eddiebergman
Copy link
Contributor

@eddiebergman eddiebergman commented Feb 2, 2022

This adds some documentation to the manual and FAQ about how to use dataset_compression as well as update an example which used predefined splits. Here, uses should now about dataset_compression as this will invalidate predefined splits.

Also does some slight tidy of the arguments w.r.t. to how it shows in the online documentation. In general, it seems to many bold parts interfere with parameter definitions which also appear bold and at the same indent.

Also, recomments back in the "Manual" tab which was meant to be fixed some time prior as far as I recall.

Screenshot_2022-02-02_18-42-04
Screenshot_2022-02-02_18-43-25

@codecov
Copy link

codecov bot commented Feb 2, 2022

Codecov Report

Merging #1386 (03ac909) into development (bdebeca) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##           development    #1386   +/-   ##
============================================
  Coverage        88.42%   88.42%           
============================================
  Files              140      140           
  Lines            11090    11090           
============================================
  Hits              9806     9806           
  Misses            1284     1284           
Impacted Files Coverage Δ
autosklearn/estimators.py 93.80% <ø> (ø)

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 bdebeca...03ac909. Read the comment docs.

@mfeurer mfeurer merged commit 322cdf3 into development Feb 3, 2022
@mfeurer mfeurer deleted the doc_for_dataset_compression branch February 3, 2022 08:36
github-actions bot pushed a commit that referenced this pull request Feb 3, 2022
eddiebergman added a commit that referenced this pull request Aug 18, 2022
… and #1250 (#1386)

* Add: Doc for `dataset_compression`

* Fix: Shorten line

* Doc: Make more clear that the argument None still provides defaults
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.

[Doc] Accessible data reduction parameters
2 participants