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.

Sign up for GitHub

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

Jump to bottom

[ENH] detection notebook - move data loading for examples to functions in the datasets module #7286

Open
fkiraly opened this issue Oct 17, 2024 · 5 comments · May be fixed by #7319
Open

[ENH] detection notebook - move data loading for examples to functions in the datasets module #7286

fkiraly opened this issue Oct 17, 2024 · 5 comments · May be fixed by #7319
Assignees
@Kabiirk
Labels
enhancement Adding new functionality good first issue Good for newcomers module:datasets&loaders data sets and data loaders module:detection detectors module: outliers, change points, segmentation

Comments

@fkiraly
Copy link
Collaborator

fkiraly commented Oct 17, 2024

In the detection notebook 7 (added in #7284), @Alex-JG3 has used a couple common toy data sets to demonstrate the detectors.

The data is loaded manually, but it would be nice to have a load_datasetname function for each, and proper documentation.

As a recipe:

  1. look at every block in the notebook 7, where a csv is loaded
  2. try to turn this into a function load_dataname(param1, param2). Possibly with a return_mtype argument that allows the user to specify the format, using convert from datatypes, but this is optional.
  3. obtain the description of the dataset from this readme https://github.com/sktime/sktime-tutorial-ODSC-Europe-2024/blob/main/data/README.md and include it in the docstring
  4. put the function in the appropriate location in the datasets module
@fkiraly fkiraly added good first issue Good for newcomers module:detection detectors module: outliers, change points, segmentation enhancement Adding new functionality module:datasets&loaders data sets and data loaders labels Oct 17, 2024
@fkiraly fkiraly changed the title [ENH] [ENH] detection notebook - move data loading for examplesc to functions in the datasets module Oct 17, 2024
@Kabiirk
Copy link

Kabiirk commented Oct 18, 2024

Hi @fkiraly !

Can you please assign this issue to me ?

As per my understanding, I need to rewrite the data-loading logic in Notebook 7 by abstracting it away into a function. Do correct if required.

@fkiraly
Copy link
Collaborator Author

fkiraly commented Oct 18, 2024

Yes, that's it!

And, the functions should behave similar, and be documented similarly to, current data loader functions.

@fkiraly fkiraly changed the title [ENH] detection notebook - move data loading for examplesc to functions in the datasets module [ENH] detection notebook - move data loading for examples to functions in the datasets module Oct 18, 2024
@Kabiirk
Copy link

Kabiirk commented Oct 18, 2024

Understood, I also went through the documentation for dataloader functions in this library. For my clarity.

You want a separate function similar to [1] dataloader functions already mentioned in your doc. From what I understand, these loader functions are model/library specific, & you are looking for something simpler which is model/library agnostic, which can simply load the data into a dataframe. Do correct if required.

I'll get started & share something soon !

@fkiraly
Copy link
Collaborator Author

fkiraly commented Oct 19, 2024

Yes, that´s it! Thanks.

@Kabiirk
Copy link

Kabiirk commented Oct 21, 2024

Hi !
Just a Sit Rep: I'm still working on this, will make a PR in some time.

@VectorNd VectorNd linked a pull request Oct 21, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Kabiirk Kabiirk

Labels
enhancement Adding new functionality good first issue Good for newcomers module:datasets&loaders data sets and data loaders module:detection detectors module: outliers, change points, segmentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[ENH] data loaders for detection toy data VectorNd/sktime
2 participants
@fkiraly @Kabiirk