はじめに
Jupyter Notebookや、Jupyter Lab上で作成したデータ分析結果を、チームの他のメンバーに共有したいことがあるかと思います。
Jupyterを立ち上げて、そのURLを共有することもできますが、共有した相手に誤ってコードを編集されることを避けたい場合もあるでしょう。
また、共有したい分析結果が非インタラクティブな形式で出力されるものであれば、分析結果をキャプチャして配布してしまえば良いのですが、
ipywidgetsを利用したインタラクティブな出力結果を共有したい場合、ツールを検討することすることになるかと思います。
この記事では、上記の課題を解決するツールとして、Voilaを紹介します。
インストール方法
$ pip install voila
これだけです。
動作確認
ここでは、Voilaの動作確認を行うまでの手順を残しておきます。
注意事項
再現性を高めるため、Dockerコンテナを利用しています。
Dockerを利用しない場合は該当箇所を適宜読み替えてください。
手順1. 動作確認をする.ipynbファイルの用意
$ git clone https://github.com/voila-dashboards/voila.git
親切なことに、VoilaのGithubリポジトリにipywidgetsを利用したインタラクティブな動作を確認できる.ipynbファイルを用意してくれているので、今回はこれを使います。
ご用意があれば他の.ipynbファイルでも良いです。
手順2. Dockerイメージのダウンロードと実行
Dockerイメージのダウンロード
$ docker image pull python:3.7-slim-buster
Alpineを使っていない理由は以下の記事をご参照ください。
Using Alpine can make Python Docker builds 50× slower
Dockerイメージの実行
$ docker run -it --rm -v $(pwd)/voila/notebooks:/workspace -w /workspace -p 8888:8866 python:3.7-slim-buster bash
手順1で落としてきたVoilaリポジトリのnotebooksディレクトリをマウントします。
手順3. Voilaとその他可視化に必要なパッケージのインストール
# pip install voila ipywidgets bqplot
手順1で紹介した.ipynbファイルで動作確認をする場合は、上記のパッケージだけで良いです。
他でご用意されたファイルで動作確認する場合は、適宜必要なパッケージをインストールしてください。
手順4. Voilaの起動
# voila .
手順5. ブラウザから動作確認
ブラウザから、http://localhost:8888 にアクセスすると、以下のようなページが表示されるかと思います。
(なお、Voilaはデフォルトでは8866番ポートで起動します。)
試しに、最上部のbasics.ipnybのリンクをクリックすると、
以下のように、コードは隠蔽された状態で、出力部分のインタラクティブな動作を確認できます。
他には、dashboard.ipnybを実行すると、以下のように動作が確認できます。
上記以外にも、例えばプルダウンで選択されたものによって出力結果を変えたり、ipywidgetsで再現できるインタラクティブな動作は実現が可能です。
共有方法
ローカルPCで起動したVoilaをさくっと共有したい場合は、ngrokのようなトンネリングツールを利用するのがおすすめです。
クラウドや、プライベートサーバーで起動して共有する場合には、手順例が公式ドキュメントにあるので、そちらをご参照ください。
まとめ
以下のような場合には、Voilaを使うとラク。
・ Jupyter 上で作成したデータ分析結果をチームの他のメンバーに共有したい
・ でも、誤ってコードを編集されたくない
・ さらに、インタラクティブな出力結果を共有したい
Appendix
Jupyter系ダッシュボード作成ツールの調査結果
※ 下記の調査内容は、2020年9月24日時点のものです。
※ あくまでも参考程度にしてください。
| ツール名 | Voila | Panel | PixieDust |
|---|---|---|---|
| 調査時点の最新コミット日 | 19hours ago | yesterday | 6hours ago |
| GitHubリポジトリのStar数 | 2.7k | 0.8k | 0.9k |
| 最新バージョン | 0.2.4 | 0.9.7 | 1.1.8 |
| 提供元 | OSS | OSS | OSS |
| 特徴 | Jupyterで動作すれば、Voilaでも動作する。 インタラクティブ部分にはipywidgetsが使える。 |
地図系の可視化に強い。 インタラクティブ部分にはBokehが使える。 |
csvファイルから3行程度の実装でダッシュボードが作成できる。 チャートの種類や、x軸/y軸の設定等はUI上でインタラクティブに操作をする。 |
| コメント(使い分け) | ipywidgetsベースで動いているものがあるならこれ | Bokehベースで動いているものがあるならこれを試しても良いかも | １から分析ダッシュボード作るならこれ |