Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

Tveten
Copy link
Contributor

@Tveten Tveten commented Dec 10, 2024

Reference Issues/PRs

Fixes #7323. See also NorskRegnesentral/skchange#44 and NorskRegnesentral/skchange#49

What does this implement/fix? Explain your changes.

  • Adds the tag "capability:variable_identification" for detectors.

What should a reviewer concentrate their feedback on?

Did you add any tests for the change?

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.

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.

Nice!

Some comments:

  • the PR does not contain all changes mentioned in the preamble. Still WiP?
  • There is a similar tag to capability:variable_identification which already exists, capability:feature_importance, already - formally, the root cause or variable identification function is a 0/1 feature importance. We could therefore consider using that?

@fkiraly fkiraly added module:detection detectors module: outliers, change points, segmentation enhancement Adding new functionality labels Dec 11, 2024
@Tveten
Copy link
Contributor Author

Tveten commented Dec 11, 2024

  • the PR does not contain all changes mentioned in the preamble. Still WiP?

Yes, still work in progress.

  • There is a similar tag to capability:variable_identification which already exists, capability:feature_importance, already - formally, the root cause or variable identification function is a 0/1 feature importance. We could therefore consider using that?

The nice thing about having a separate tag is that you can specify exactly what it means for detectors: That the output of predict will have an additional column named icolumns and that transform will have the same number of columns as the input, with a particular naming format. If that's not so important, it's nice to reuse the feature_importance tag I guess.

@fkiraly
Copy link
Collaborator

fkiraly commented Dec 11, 2024

The nice thing about having a separate tag is that you can specify exactly what it means for detectors

You can still do this if you use the same tag - by tests or docstring, no?

But I do agree that it actually means something different for detectors, since we have feature importances per time index. A separate tag makes sense (I am now increasingly convinced of that) - although I wonder whether it can be shortened.

@Tveten
Copy link
Contributor Author

Tveten commented Dec 12, 2024

But I do agree that it actually means something different for detectors, since we have feature importances per time index. A separate tag makes sense (I am now increasingly convinced of that) - although I wonder whether it can be shortened.

  • capability:subset_identification?
  • capability:affected_components? (I've used this before.)

@fkiraly
Copy link
Collaborator

fkiraly commented Dec 13, 2024

not much shorter...

capability:variable_attribution might be clearer than all the options?

@Tveten
Copy link
Contributor Author

Tveten commented Apr 24, 2025

Sorry, I forgot about following up this.

I think all our options here are pretty long, so therefore I'd go with the most self-explanatory name. I still think this is capability:variable_identification. If I was going to explain in a sentence what this capability means for a detector, I would write something like: "The detector identifies which variables are affected by the change/anomaly", rather than "The detector attributes the change/anomaly to a set of variables." If I have to use the "identify" term to explain the "attribution" term in the name, then I'd rather go with "identify" in the name.

What about capability:identify_variables?

@fkiraly
Copy link
Collaborator

fkiraly commented Apr 27, 2025

What about capability:identify_variables?

I think the noun variant, i.e., capability:variable_identification, is slightly clearer.

@Tveten
Copy link
Contributor Author

Tveten commented May 14, 2025

Alright. Then I think this PR is ready.

@Tveten Tveten marked this pull request as ready for review May 14, 2025 08:38
@fkiraly fkiraly merged commit 4c6f4ed into sktime:main May 19, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Adding new functionality module:detection detectors module: outliers, change points, segmentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[ENH] skchange - sktime base class homogenization - todos
2 participants