nteract/papermill

parameters comment instead of tag

オープン

#395 opened on 2019/07/05

GitHub で見るコントリビューターガイド
 (7 件のコメント) (4 件のリアクション) (0 人の担当者)Python (402 件のフォーク)batch import
enhancementhelp wantedidea

Repository metrics

Stars
 (5,381 個のスター)
PR merge metrics
 (30d に merged PR はありません)

説明

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

コントリビューターガイド

調査方針
papermillの既存のパラメータ注入ロジック、特に`parameters`タグの使用方法を調査してください。この問題では、タグが見つからない場合、注入はノートブックの先頭で行われると述べられています。この機能を実装するには、最初のセルに`#parameters`コメントがあるかどうかもチェックするようにロジックを修正する必要があります。関連するコードは`execute.py`または`inject.py`ファイルにある可能性があります。追加の背景情報については、リンクされているIssue #192と#328を確認してください。まず、タグ検出が行われる場所を特定し、コメントベースのアプローチをサポートするように拡張します。
技術スタック
python
領域
data
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
PythonJupyter
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
80