[ENH] Adds BinSeg Segmenter from Ruptures library

patrickzib commented 3 months ago

What does this implement/fix? Explain your changes.

This implements the BinSeg segmenter from the Ruptures library.

[Bai1997] Bai, J. (1997). Estimating multiple breaks one at a time.
Econometric Theory, 13(3), 315–352.

[Fryzlewicz2014] Fryzlewicz, P. (2014). Wild binary segmentation for multiple
change-point detection. The Annals of Statistics, 42(6), 2243–2281.

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

It adds a soft-dependency to ruptures.

For new estimators and functions

[x] I've added the estimator to the online API documentation.

aeon-actions-bot[bot] commented 3 months ago

Thank you for contributing to `aeon`

I would have added the following labels to this PR based on the changes made: [ $\color{#0e8a16}{\textsf{segmentation}}$ ], 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, any trivial fixes will automatically be pushed to your PR unless it is a draft.

Don't hesitate to ask questions on the aeon Slack channel if you have any.

PR CI actions

These checkboxes will add labels to enable/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
[ ] Run numba-disabled codecov tests
[ ] Stop automatic pre-commit fixes (always disabled for drafts)

patrickzib commented 3 months ago

nice, we use [1]_ rather than [Bai1997] for references but obvs not blocking

Thank you. I had to update the PR with latest changes from main, which removed your approval. Could you approve again? :)

I have made the change for reference styles, too.

aeon-toolkit / aeon