sktime/sktime

[DOC] in `make_reduction`, document properly how exogeneous data and transformers are used

Open

#4.516 aberto em 27 de abr. de 2023

Ver no GitHub
 (2 comments) (0 reactions) (0 assignees)Python (1.192 forks)batch import
documentationgood first issue

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 make_reduction docstring, it should be documented properly (and with formal precision) how exogeneous data and transformers are used.

The experimental RecursiveReductionForecaster and DirectReductionForecaster have this documented and can be used as templates.

Related: https://github.com/sktime/sktime/issues/4511

Guia do colaborador

Direção de pesquisa
Examine os docstrings de `RecursiveReductionForecaster` e `DirectReductionForecaster` na base de código do sktime para entender o formato e o nível de detalhe esperados. Revise também a issue relacionada #4511 para obter contexto adicional. Em seguida, atualize o docstring de `make reduction` para documentar de forma semelhante como os dados exógenos e os transformadores são usados, garantindo precisão formal.
Pilha de tecnologia
python
Domain
backenddata
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.
1-3 horas
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
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80