sktime/sktime

[DOC] cover metrics' `multioutput` and `multilevel` parameters in forecasting tutorial and/or docstrings

Aberta

#5.008 aberto em 2 de ago. de 2023

Ver no GitHubGuia do colaborador
 (5 comentários) (0 reação) (0 responsável)Python (1.192 forks)batch import
documentationgood first issuemodule:forecasting

Métricas do repositório

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

Description

@yarnabrina recommended we should ensure the use of multioutput and multilevel parameters in forecasting metrics is properly explained throughout our documentation.

These two arguments control how (or whether) metrics are averaged across multiple variables (multioutput) or hierarchies of hierarchical data (multilevel).

I think @marrov created some content for ODSC/EuroPython 2023, in the notebooks. We could partially re-use that.

References:

A good first issue for documentation writers!

This arose from a request by @yarnabrina in a PR discussion: https://github.com/sktime/sktime/issues/4960#issuecomment-1651989758_

Guia do colaborador

Direção de pesquisa
Reveja o conteúdo existente sobre os parâmetros multioutput e multilevel no tutorial de previsão do sktime (examples/01 forecasting.ipynb) e no notebook da EuroPython 2023. Identifique seções relevantes que podem ser reutilizadas ou adaptadas. Determine onde no tutorial e nas docstrings essas explicações devem ser inseridas. Certifique se de que a documentação explique claramente como multioutput calcula a média entre múltiplas variáveis e como multilevel calcula a média entre hierarquias.
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.
1
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
PythonGitJupyter
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90