sktime/sktime

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

Open

#7 286 ouverte le 17 oct. 2024

Voir sur GitHub
 (8 commentaires) (0 réactions) (1 assigné)Python (1 192 forks)batch import
enhancementgood first issuemodule:datasets&loadersmodule:detection

Métriques du dépôt

Stars
 (7 162 stars)
Métriques de merge PR
 (Merge moyen 26j 10h) (86 PRs mergées en 30 j)

Description

In the detection notebook 7 (added in https://github.com/sktime/sktime/pull/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

Guide contributeur