nteract/papermill

parameters comment instead of tag

Ouverte

#395 ouverte le 5 juil. 2019

Voir sur GitHubGuide contributeur
 (7 commentaires) (4 réactions) (0 personne assignée)Python (402 forks)batch import
enhancementhelp wantedidea

Métriques du dépôt

Stars
 (5 381 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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.

Guide contributeur

Direction de recherche
Étudiez la logique d'injection de paramètres existante dans papermill, en particulier comment la balise `parameters` est utilisée. Le problème mentionne que si aucune balise n'est trouvée, l'injection se produit au début du notebook. Pour implémenter cette fonctionnalité, modifiez la logique pour vérifier également la première cellule à la recherche d'un commentaire `#parameters`. Le code pertinent se trouve probablement dans les fichiers `execute.py` ou `inject.py`. Consultez les problèmes liés #192 et #328 pour obtenir un contexte supplémentaire. Commencez par localiser où la détection de balise se produit et étendez la pour prendre en charge l'approche basée sur les commentaires.
Stack technique
python
Domaine
data
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonJupyter
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80