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

Polish pipeline and selectors API #168

Open
1 of 7 tasks
kachayev opened this issue Apr 22, 2024 · 1 comment
Open
1 of 7 tasks

Polish pipeline and selectors API #168

kachayev opened this issue Apr 22, 2024 · 1 comment
Labels
domain-aware api enhancement New feature or request

Comments

@kachayev
Copy link
Collaborator

kachayev commented Apr 22, 2024

After adding a few new selectors in addition to the most basic Shared one, it became apparent that reorganization of the code would be beneficial. There are quite a few improvements that are desirable, ultimately they could be summarized into the following areas:

  • Move selectors to a separate module (rather than keeping them in skada.base).
  • The code for branching the execution flow (i.e. splitting/merging) is scattered, duplicated across different methods and, mostly, purely tested. It would be nice to come with more generic concepts/blocks, requires proper design work (thankfully we have quite a few examples of the functionality now).
  • Make sure that all methods are covered with a proper docstrings.
  • There are multiple scenarios that we want to test against all available selectors. Would be nice to find a way to organize tests accordingly to this.
  • Documentation and examples to explain the inner workings of the pipeline/selectors.
  • In the beginning of the work we made a few shortcuts for naming conventions and parametrization to avoid Shared selector being 'visible' in the pipeline. It's time to re-evaluate those choice in the light of new functionality introduced.
  • Update implementation so we don't need to duplicate logic for container wrapping in each fit and fit_transform
@kachayev kachayev added enhancement New feature or request domain-aware api labels Apr 22, 2024
@kachayev
Copy link
Collaborator Author

kachayev commented May 2, 2024

Note that this was partially covered in #184

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain-aware api enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant