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] Fixes Time Series Segmentation with sktime and ClaSP notebook example #7283

Merged
merged 3 commits into from
Oct 17, 2024

Conversation

RobotPsychologist
Copy link
Contributor

Reference Issues/PRs

Fixes #7282

What does this implement/fix? Explain your changes.

This fixes minor documentation issues with the ClaSP Segmentation notebook.

Does your contribution introduce a new dependency? If yes, which one?

No.

What should a reviewer concentrate their feedback on?

Making sure the changes to the Output Format section are appropriate.

Did you add any tests for the change?

No tests required. This is a minor documentation fix.

Any other comments?

PR checklist

For all contributions
  • I've added myself to the list of contributors with any new badges I've earned :-)
    How to: add yourself to the all-contributors file in the sktime root directory (not the CONTRIBUTORS.md). Common badges: code - fixing a bug, or adding code logic. doc - writing or improving documentation or docstrings. bug - reporting or diagnosing a bug (get this plus code if you also fixed the bug in the PR).maintenance - CI, test framework, release.
    See here for full badge reference
  • Optionally, for added estimators: I've added myself and possibly to the maintainers tag - do this if you want to become the owner or maintainer of an estimator you added.
    See here for further details on the algorithm maintainer role.
  • The PR title starts with either [ENH], [MNT], [DOC], or [BUG]. [BUG] - bugfix, [MNT] - CI, test framework, [ENH] - adding or improving code, [DOC] - writing or improving documentation or docstrings.
For new estimators
  • I've added the estimator to the API reference - in docs/source/api_reference/taskname.rst, follow the pattern.
  • I've added one or more illustrative usage examples to the docstring, in a pydocstyle compliant Examples section.
  • If the estimator relies on a soft dependency, I've set the python_dependencies tag and ensured
    dependency isolation, see the estimator dependencies guide.

… to api changes. It is no long possible to specify output formats, they are replaced with dense_to_sparse and sparse to dense methods. I replaced the examples near the end of the notebook to show how to use the methods, and removed all fmt parameters from the code cells.
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Copy link
Collaborator

@fkiraly fkiraly left a comment

Choose a reason for hiding this comment

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

Thanks! This reminds me, we should also add the notebook from ODSC. @Alex-JG3 was on it but might be busy, so I will copy it over. Reviews appreciated! (separate PR)

Copy link
Collaborator

@fkiraly fkiraly left a comment

Choose a reason for hiding this comment

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

The linter complains, code formatting, see below.

For notebooks, this might be not as straightforward as usual, here is the guide:
https://www.sktime.net/en/latest/developer_guide/coding_standards.html#setting-up-local-code-quality-checks

Copy link
Collaborator

@fkiraly fkiraly left a comment

Choose a reason for hiding this comment

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

I fixed the formatting issue to make this ready for the release

@fkiraly fkiraly added documentation Documentation & tutorials module:detection detectors module: outliers, change points, segmentation bugfix Fixes a known bug or removes unintended behavior labels Oct 17, 2024
@fkiraly fkiraly merged commit 6c69dee into sktime:main Oct 17, 2024
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bugfix Fixes a known bug or removes unintended behavior documentation Documentation & tutorials module:detection detectors module: outliers, change points, segmentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Time Series Segmentation with sktime and ClaSP Notebook Example Contains Bug
2 participants