Repository navigation
[DOC] Fill in and align the experiment function docstrings - #572
Merged
MatthewMiddlehurst merged 1 commit intoNov 20, 2026
Conversation
Replace the todo placeholders for ignore_custom_train_estimate, attribute_file_path and att_max_shape in the run_* and cross-validation functions, and document write_attributes and att_max_shape where they were missing. Use the same wording for parameters shared by the run_*, load_and_run_* and cross-validation functions, and correct descriptions that did not match the code (build_test_file, build_train_file, resample_id in run_*).
Contributor
Thank you for contributing to
|
MatthewMiddlehurst
merged commit Nov 20, 2026
9c75b6e
into
time-series-machine-learning:main
19 of 21 checks passed
This file contains hidden or 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
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.
Reference Issues/PRs
Follow-up to #534, which left the
tododocstrings for a separate pass.What does this implement/fix? Explain your changes
Docstring-only changes to
tsml_eval/experiments/experiments.pyandtsml_eval/experiments/cross_validation.py.todoplaceholders forignore_custom_train_estimate,attribute_file_pathandatt_max_shapein therun_classification_experiment/run_regression_experimentand cross-validation functions.attribute_file_path/att_max_shapein the clustering and forecastingrun_*functions, andwrite_attributes/att_max_shapein all fourload_and_run_*functions. These were missing.run_*,load_and_run_*and cross-validation functions (build_train_file,transform_train_only,results_path,overwrite,n_clusters). Differences are left only where the behaviour differs:build_test_filehad a sentence about train probabilities;build_train_filesaid 10-fold, but the inner CV uses up to 10 folds;resample_idinrun_*said it seeds resampling, but these functions do not resample.combine_train_test_split :.