nteract/papermill

parameters comment instead of tag

Offen

#395 geöffnet am 05.07.2019

Auf GitHub ansehenContributor Guide
 (7 Kommentare) (4 Reaktionen) (0 zugewiesene Personen)Python (402 Forks)batch import
enhancementhelp wantedidea

Repository-Metriken

Stars
 (5.381 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Untersuche die bestehende Parameter Injektionslogik in papermill, insbesondere wie das `parameters` Tag verwendet wird. Das Issue verweist darauf, dass, wenn kein Tag gefunden wird, die Injektion am Anfang des Notebooks erfolgt. Um diese Funktion zu implementieren, ändere die Logik so, dass auch die erste Zelle auf einen `#parameters` Kommentar überprüft wird. Der relevante Code befindet sich wahrscheinlich in den Dateien `execute.py` oder `inject.py`. Überprüfe die verknüpften Issues #192 und #328 für zusätzlichen Kontext. Beginne damit, herauszufinden, wo die Tag Erkennung stattfindet, und erweitere sie, um den kommentarbasierten Ansatz zu unterstützen.
Tech Stack
python
Domain
data
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
PythonJupyter
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80