nteract/papermill

parameters comment instead of tag

Aperta

#395 aperta il 5 lug 2019

Vedi su GitHubGuida contributor
 (7 commenti) (4 reazioni) (0 assegnatari)Python (402 fork)batch import
enhancementhelp wantedidea

Metriche repository

Star
 (5381 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

  • 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.

Guida contributor

Direzione di ricerca
Indaga la logica esistente di iniezione dei parametri in papermill, in particolare come viene utilizzato il tag `parameters`. Il problema fa riferimento al fatto che, se non viene trovato alcun tag, l'iniezione avviene all'inizio del notebook. Per implementare questa funzionalità, modifica la logica per controllare anche la prima cella alla ricerca di un commento `#parameters`. Il codice rilevante si trova probabilmente nei file `execute.py` o `inject.py`. Rivedi i problemi collegati #192 e #328 per ulteriore contesto. Inizia individuando dove avviene il rilevamento del tag ed estendilo per supportare l'approccio basato sui commenti.
Tech stack
python
Dominio
data
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonJupyter
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80