nteract/papermill

parameters comment instead of tag

Aberta

#395 aberto em 5 de jul. de 2019

Ver no GitHubGuia do colaborador
 (7 comentários) (4 reações) (0 responsável)Python (402 forks)batch import
enhancementhelp wantedidea

Métricas do repositório

Stars
 (5.381 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

  • What: support writing #parameters as a comment at the top of a cell as an alternative way to tag
  • Why: it's annoying to use the tags mechanism, especially if it's just for papermill (related: #192)

Paraphrasing https://papermill.readthedocs.io/en/latest/usage-parameterize.html#how-parameters-work (which I may have written :P):

  1. if multiple parameters tags are found, injection only occurs after the first one (related: #328)
  2. if none are found, injection is at the start of the notebook

proposed here: insert 2. if none are found, injection occurs after the first cell that starts with #parameters (possibly also variants such as """ PaRaMeTeRs""")

This will not break backward-compatibility.

Happy to implement this if there's support for it.

Guia do colaborador

Direção de pesquisa
Investigue a lógica existente de injeção de parâmetros no papermill, particularmente como a tag `parameters` é usada. A issue menciona que, se nenhuma tag for encontrada, a injeção ocorre no início do notebook. Para implementar esse recurso, modifique a lógica para também verificar a primeira célula em busca de um comentário `#parameters`. O código relevante provavelmente está nos arquivos `execute.py` ou `inject.py`. Revise as issues vinculadas #192 e #328 para obter contexto adicional. Comece localizando onde a detecção da tag acontece e estenda a para suportar a abordagem baseada em comentário.
Pilha de tecnologia
python
Domain
data
Tipo Issue
Funcionalidade
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
PythonJupyter
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80