Skip to content

[DOC] Fill in and align the experiment function docstrings - #572

Merged
MatthewMiddlehurst merged 1 commit into
time-series-machine-learning:mainfrom
MatthewMiddlehurst:mm/experiment-docstrings
Nov 20, 2026
Merged

MatthewMiddlehurst merged 1 commit into
time-series-machine-learning:mainfrom
MatthewMiddlehurst:mm/experiment-docstrings

Conversation

@MatthewMiddlehurst

@MatthewMiddlehurst MatthewMiddlehurst commented Nov 20, 2026 •

Copy link
Copy Markdown
Member

Reference Issues/PRs

Follow-up to #534, which left the todo docstrings for a separate pass.

What does this implement/fix? Explain your changes

Docstring-only changes to tsml_eval/experiments/experiments.py and tsml_eval/experiments/cross_validation.py.

  • Replaces the todo placeholders for ignore_custom_train_estimate, attribute_file_path and att_max_shape in the run_classification_experiment/run_regression_experiment and cross-validation functions.
  • Documents attribute_file_path/att_max_shape in the clustering and forecasting run_* functions, and write_attributes/att_max_shape in all four load_and_run_* functions. These were missing.
  • Uses the same wording for parameters shared across the 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:
    • the CV functions run per fold;
    • clustering and forecasting always write attributes;
    • classification and regression only write attributes when the test file is built.
  • Corrects descriptions that did not match the code:
    • build_test_file had a sentence about train probabilities;
    • build_train_file said 10-fold, but the inner CV uses up to 10 folds;
    • resample_id in run_* said it seeds resampling, but these functions do not resample.
  • Fixes numpydoc formatting: stray colons after defaults, and a missing space in combine_train_test_split :.

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_*).
@MatthewMiddlehurst MatthewMiddlehurst added documentation Improvements or additions to documentation experiments Experiments package labels Nov 20, 2026
@tsml-actions-bot

Copy link
Copy Markdown
Contributor

Thank you for contributing to tsml-eval

I would have added the following labels to this PR based on the changes made: experiments, however some package labels are already present.

The Checks tab will show the status of our automated tests. You can click on individual test runs in the tab or "Details" in the panel below to see more information if there is a failure.

If our pre-commit code quality check fails, please run pre-commit locally and push the fixes to your PR branch.

PR CI actions

These checkboxes will add labels to enable or disable CI functionality for this PR. This may not take effect immediately, and a new commit may be required to run the new configuration.

  • Run pre-commit checks for all files
  • Run all pytest tests and configurations
  • Run all notebook example tests
  • Push an empty commit to re-run CI checks

@MatthewMiddlehurst
MatthewMiddlehurst merged commit 9c75b6e into time-series-machine-learning:main Nov 20, 2026
19 of 21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation experiments Experiments package

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant