Model selection api rendering #571
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
FBruzzesi
commented
Jul 18, 2023
| timegapsplit.ipynb | ||
| crossvalidation.ipynb |
There was a problem hiding this comment.
While rendering I found that the page was no longer rendering due to the mismatch between the notebook name and the pointer in the docs index.
I took the liberty to change it in the index.
FBruzzesi
commented
Jul 18, 2023
| @@ -17,36 +17,42 @@ class TimeGapSplit: | |||
| """ | |||
| Provides train/test indices to split time series data samples. | |||
| This cross-validation object is a variation of TimeSeriesSplit with the following differences: | |||
|
|
|||
There was a problem hiding this comment.
Overall I tried to keep the consistent behaviour of not refering to self in the docstring
MBrouns
approved these changes
Sep 20, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The goal of this PR is to fix the "broken" rendering of some section of the model selection api documentation.
It addresses issue #568
Type of change
Documentation from docstrings
Additional remarks
Notice that all changes in the code, that are not docstrings, are due to pre-commit hooks (black formatting).