Repolode
nteract

nteract/papermill

Jupyter notebookをCLIまたはPython APIからパラメーター付きで実行・分析できるPythonツール。

スター
6,498
フォーク
465
未解決の Issue
198
最終コミット
先月

これは何?

Papermillは、実行時に指定したパラメーターを使ってJupyter notebookを実行します。`parameters`タグをセルに付けてデフォルト値を定義すると、Papermillが指定値を含む新しいセルを挿入します。同じnotebookでも入力を変えて異なる出力を生成できるため、たとえば日付を変えて月次レポートを実行できます。

notebookは、Python APIの`execute_notebook`または`papermill`コマンドラインから実行できます。パラメーターは文字列、型付きの値、YAMLファイル、base64エンコードされたYAMLで渡せます。入力元と出力先には、ローカルファイル、HTTP(S) URL、AWS S3、Azure Data LakeまたはBlob Storage、Google Cloud Storageを指定できます。

実行をスクリプト化できるため、あるnotebookの結果に応じて次に実行するnotebookを決めるデータパイプラインに組み込めます。`s3`や`azure`などのオプションのextrasをインストールするとストレージ用の依存関係が追加され、`black` extraを使うと挿入したパラメーターをフォーマットできます。

主な機能

  • 01タグ付きセルにパラメーターを挿入し、同じnotebookを異なる入力で実行できます。
  • 02Python APIまたはpapermillコマンドラインからnotebookを実行できます。
  • 03型付きの値、文字列、YAMLファイル、YAML文字列でパラメーターを渡せます。
  • 04ローカルディスク、HTTP(S)、S3、Azure、Google Cloud Storage上のnotebookを読み書きできます。
  • 05挿入したパラメーターをBlackでフォーマットするオプションを利用できます。

ユースケース

  • 同じ財務レポートや分析レポートを、日付や設定を変えて実行する。
  • あるnotebookの出力に応じて次の処理を決めるデータパイプラインで、複数のnotebookを連携させる。
  • スケジュールされたジョブの一環として、クラウドのオブジェクトストレージに保存されたnotebookをまとめて実行する。

クイックスタート

  1. 1

    PyPIからpapermillをインストールする

    pip install papermill
  2. 2

    ノートブックのセルに「parameters」タグを付け、CLIからパラメーターを指定して実行する

    papermill local/input.ipynb local/output.ipynb -p alpha 0.6 -p l1_ratio 0.1

使う前に知っておきたいこと

  • Python 3.10以降のみをサポートしています。

トピック

#jupyter#notebook#data-pipeline#parameters#python#automation#julia#notebook-generator#notebooks#nteract

よくある質問

papermill とは?
Jupyter notebookをCLIまたはPython APIからパラメーター付きで実行・分析できるPythonツール。 Papermillは、実行時に指定したパラメーターを使ってJupyter notebookを実行します。`parameters`タグをセルに付けてデフォルト値を定義すると、Papermillが指定値を含む新しいセルを挿入します。同じnotebookでも入力を変えて異なる出力を生成できるため、たとえば日付を変えて月次レポートを実行できます。
papermill は無料で使えますか?ライセンスは?
papermill は BSD-3-Clause ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
papermill は今もメンテナンスされていますか?
半年以内に更新あり。papermill の最終コミットは 2026年10月5日 です。
papermill は何に使えますか?
同じ財務レポートや分析レポートを、日付や設定を変えて実行する。 あるnotebookの出力に応じて次の処理を決めるデータパイプラインで、複数のnotebookを連携させる。 スケジュールされたジョブの一環として、クラウドのオブジェクトストレージに保存されたnotebookをまとめて実行する。
papermill のインストール方法は?
PyPIからpapermillをインストールする: pip install papermill ノートブックのセルに「parameters」タグを付け、CLIからパラメーターを指定して実行する: papermill local/input.ipynb local/output.ipynb -p alpha 0.6 -p l1_ratio 0.1
papermill はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/nteract/papermill

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト

依存セルを自動で再実行し、ノートブックをプレーンな .py ファイルとして保存して、スクリプトやデプロイ済みアプリとして実行できるリアクティブなPythonノートブック。

2.3万+81 今週1375PythonApache-2.0活発にメンテナンス更新 7 時間前