sktime/sktime

[DOC] Improve documentation on multithreading and parallelization

Aberta

#6.174 aberto em 20 de mar. de 2024

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

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

Describe the issue linked to the documentation

Pull request https://github.com/sktime/sktime/pull/6002 deprecates setting n_jobs through object initialization. The docstring of deprecation shows how to do it, but

  1. With :
c22_mv = Catch22(catch24=catch24, col_names="short_str_feat")
c22_mv.set_config(backend="joblib", backend_params={"n_jobs": n_jobs})

I get a warning c22_mv.set_config is not callablePylint[E1102:not-callable]

  1. I cannot find anywhere in documentation how to set n_jobs, and how the set_config should work.

Once we remove the deprecation warning, it will become unclear (in my opinion) how to use multithreading at all.

Suggest a potential alternative/fix

Ideally, one of the pages in documentation should be dedicated to guide on multithreading.

Guia do colaborador

Direção de pesquisa
Explore o método set config na documentação e no código fonte do sktime. Entenda como definir n jobs e outros parâmetros de back end para paralelização. Em seguida, crie uma página dedicada na documentação explicando multithreading e paralelização com exemplos.
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
PythonGitsktime basics
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60