sktime/sktime

[DOC] detection notebook - move plotting functions to `detection.plotting`

Open

#7.285 aberto em 17 de out. de 2024

Ver no GitHub
 (10 comments) (1 reaction) (0 assignees)Python (1.192 forks)batch import
documentationgood first issuemodule:detectionmodule:utilities&plotting

Métricas do repositório

Stars
 (7.162 stars)
Métricas de merge de PR
 (Mesclagem média 26d 10h) (86 fundiu PRs em 30d)

Description

In the detection notebook 7 (added in https://github.com/sktime/sktime/pull/7284), @alex-jg3 has created a number of plotting functions that would be nice to have generally.

I think we should refactor the plotting functions and move them to annotation.plotting. There are also some existing functions in the latter, it might be useful to see if they can be merged.

As a recipe:

  1. look at every block in the notebook 7, where matplotlib is used and something plotted
  2. try to turn this into a function plot_something(param1, param2, ax=None) (where if ax is passed, no new ax is created but that is used)
  3. put the function in annotation.plotting, and have the notebook import it from there instead of defining the plot in the notebook.

Guia do colaborador

Direção de pesquisa
Examine o notebook 7 para identificar funções de plotagem, refatore as para o módulo `detection.plotting`, garantindo que aceitem um parâmetro `ax`. Verifique as funções existentes em `annotation.plotting` para possível mesclagem.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Pythonmatplotlib
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75