Pynote

Python、機械学習、画像処理について

Python - Jupyter Notebook の後継、Jupyter Lab のインストールと使い方


Jupyter Lab とは

jupyterlab.readthedocs.io

JupyterLabは Jupyter Notebook の後継として開発されているブラウザ上で動作する統合開発環境である。
Jupyter Notebook の使い勝手を引き継ぎつつ、以下の点で機能強化が図られている。

テーマの公式対応

Jupyter Notebook でも jupyter-themes というモジュールでテーマの変更ができたが、テーマの変更機能について公式に対応しており、JupyterLab 画面上の操作で変更できる。


Visual Studio Code ライクな設定画面

左側にデフォルト設定、右側にカスタマイズする設定を書くという Visual Studio Code ライクな設定画面。
JupyterLab 画面上の操作で細かい設定が行える。


拡張機能の公式対応

拡張機能に公式対応しているため、デフォルト機能で不十分な点は拡張で補完できる。

タブ機能

Jupyter Notebook では notebook ごとにブラウザの1つのタブが開かれる形式になっていたが、JupyterLab ではタブで複数の開いているドキュメントを1つの画面で表示できる。

分割表示機能

メインワークエリアというドキュメントを表示する領域を分割して、表示できる。


インストール

pip コマンドでインストールできる。

pip install jupyterlab

起動及びブラウザからのアクセス

以下のコマンドを実行すると、Jupyter Lab が起動し、ブラウザで開かれる。

jupyter lab

JupyterLab の UI

Jupyter Lab の画面構成

JupyterLab の画面は次の3つのエリアからなる。

  • Menu Bar (メニューバー)
  • Left Sidebar (左サイドバー)
  • Main Work Area (メインワークエリア)


左サイドバー

次のいずれかの方法で左サイドバーを折りたたむかどうかの切り替えが行える。

  • [左サイドバー] タブをクリックする。
  • [メニューバー] 「View→Show Left Silder」を選択する。
  • [キーボード] 「Ctrl + B」を押す。

タブは上から次の通りである。

  • ファイルブラウザ
  • 起動中のカーネル一覧
  • コマンドパレット
  • セルインスペクタ
  • タブパネル


タブ

左サイドバーの「タブパネル」でメインワークエリアで現在開いているドキュメントやアクティビティの一覧を確認できる。

同じ情報は、メニューバーの「Tabs」でも確認できる。

「Single-Document Mode」を有効にすると、タブを非表示にできる。
このモードを有効にするかどうかは、メニューバーの「View」より切り替えが行える。

ランチャー

ランチャーからドキュメントやアクティビティを新規作成できる。
ランチャーは次の2通りの方法で開ける。

  • [左サイドバー] ファイルブラウザの「ランチャー」ボタンをクリックする。
  • [メニューバー] 「File→New Launcher」を選択する。
  • [キーボード] Ctrl + Shift + L を押す。
  • ドキュメントまたはアクティビティをなにも開いていない状態だとランチャーが表示される。


ファイルブラウザ

次の4つのボタンがある。

  • ランチャー
  • フォルダ新規作成
  • アップロード
  • 更新

フォルダをダブルクリックすることで階層を辿ることができる。
現在いる階層は上に表示されているパンくずリストで確認でき、またその階層をクリックすることで上位の階層に移動できる。


コンテキストメニュー

notebook、テキストファイル、コンソール、タブなど多くの部分で右クリックでコンテキストメニューが表示できる。
ブラウザのコンテキストメニューは Shift を押しながら、右クリックすることで表示できる。


ファイル操作

  • ファイルをデフォルトのビューアーで開く。
    • [左サイドバー] ファイルブラウザ上でファイルを選択してダブルクリックする。
    • [左サイドバー] ファイルブラウザ上でファイルを選択してメインワークエリアにドラッグアンドドロップする。
    • [左サイドバー] ファイルブラウザ上でファイルを選択して右クリックし、コンテキストメニューから「Open」を選択する。を選択すると、ファイルを直線ブラウザで開ける。(画像や動画ファイルなど)

同じファイルを複数開いた場合は、内容は同期される。(一方を編集したら、もう一方にも反映される。)

  • ファイルを指定したビューアーで開く。
    • [左サイドバー] ファイルブラウザ上でファイルを選択して右クリックし、コンテキストメニューから「Open With」よりビューアーを選択する。


  • ファイルをブラウザで開く。

新しいドキュメントやアクティビティを作成する。

次のいずれかの方法で新しいドキュメントやアクティビティを作成できる。

  • ランチャーから選択する。
  • メニューバーより「File→New」より選択する。

リネームする。

次のいずれかの方法でドキュメン及びフォルダをリネームできる。

    • [左サイドバー] ファイルブラウザ上でファイルを選択して右クリックし、コンテキストメニューから「Rename」を選択する。
    • [メニューバー] 「File→Rename Notebook」を選択する。
    • [タブ] タブを右クリックし、コンテキストメニューから「Rename」を選択する。

削除する。

  • 左サイドバーのファイルブラウザ上でファイルを選択して右クリックし、コンテキストメニューから「Delete」を選択する。

ファイルの切り取り、コピー、複製、貼り付け

  • 左サイドバーのファイルブラウザ上でファイルを選択して右クリックし、コンテキストメニューから切り取り、コピー、複製、貼り付けが行える。
    • Cut: 選択したファイルをカットする。
    • Copy: 選択したファイルをコピーする。
    • Duplicate: 選択したファイルを複製する。
    • Paste: 現在、切り取りまたはコピーしているファイルを貼り付ける。

ダウンロード

次の方法でドキュメントをダウンロードできる。

アップロード

次のいずれかの方法でホスト側からブラウザ経由で Jupyter Lab のワーキングディレクトリ上にファイルをアップロードできる。

  • ファイルブラウザ上にファイルをドラッグアンドドロップする。
  • ファイルブラウザのアップロードボタンをクリックして、アップロードするファイルを選択する。

保存する。

  • 開いているファイルを上書き保存する。
    • [メニューバー] 「File→Save Notebook」を選択する。
    • [キーボード] Ctrl + S を押す。
  • 開いているファイルを表示状態を保持した状態で上書き保存する。
    • [メニューバー] 「File→Save Notebook with View State」を選択する。
  • 開いているファイルを表示状態を保持した状態で別名保存する。
    • [メニューバー] 「File→Save Notebook As」を選択する。
    • [キーボード] Ctrl + Shift + S を押す。
  • 開いているファイルをすべて保存する。
    • [メニューバー] 「File→Save All」を選択する。

再読込みする。

  • 最後に保存したチェックポイントから復元する。
    • [メニューバー] 「File→Revert Notebook to Checkpoint」を選択する。
  • ファイルを再読込みする。
    • [メニューバー] 「File→Reload Notebook from Disk」を選択する。

閉じる。

  • すべてのドキュメントを閉じる。
    • [メニューバー] 「File→Close All」を選択する。
  • アクティブになっているドキュメントを閉じる。
    • [メニューバー] 「File→Close Notebook」を選択する。
    • [キーボード] Ctrl + Q を押す。
  • アクティブになっているドキュメントをシャットダウンして閉じる。
    • [メニューバー] 「File→Close and Shutdown Notebook」を選択する。
  • アクティブになっているドキュメント以外を閉じる。
  • アクティブになっているドキュメントより右側のドキュメントをすべて閉じる。

カーネルの操作

カーネルの中断

  • [メニューバー] 「Kernel→Interrupt Kernel」を選択する。
  • [ツールバー] ボタンをクリックする。
  • [キーボード] I を2回押す。

カーネルのシャットダウン

  • 現在開いているカーネルをシャットダウンする。
    • [左サイドバー] カーネル一覧で、シャットダウンする notebook の右の「SHUTDOWN」を選択する。
    • [メニューバー] 「Kernel→Shutdown Kernel」を選択する。
  • すべてのカーネルをシャットダウンする。
    • [左サイドバー] カーネル一覧で、「KERNEL SESSIONS」の右の × ボタンをクリックする。
    • [メニューバー] 「Kernel→Shutdown All Kernels」を選択する。

カーネルの再起動

  • 現在開いているカーネルを再起動する。
    • [メニューバー] 「Kernel→Restart Kernel」を選択する。
    • [コンテキストメニュー] 「Restart Kernel」を選択する。
    • [キーボード] 0 を2回押す。
  • カーネルの再起動し、出力をすべてクリアする。
    • [メニューバー] 「Kernel→Restart Kernel and Clear All Outputs」を選択する、
  • 現在開いているカーネルを再起動後、実行する。
    • [メニューバー] 「Kernel→Restart Kernel and Run All Cells」を選択する。
    • [メニューバー] 「Run→Restart Kernel and Run All Cells」を選択する。
    • [ツールバー] ボタンをクリックする。

セルの操作

セルの実行

  • 選択中のセルを実行し、1つ下のセルを選択する。1つ下のセルがない場合は新しいセルを挿入する。
    • [メニューバー] 「Run→Run Selected Cells」を選択する。
    • [ツールバー] ボタンをクリックする。
    • [キーボード] Shift + Enter を押す。
  • 選択中のセルを実行し、下に新しいセルを挿入する。
    • [メニューバー] 「Run→Run Selected Cells and Insert Below」を選択する。
    • [キーボード] Alt + Enter を押す。
  • 選択中のセルを実行するが、新しいセルを挿入しない。
    • [メニューバー] 「Run→Run Selected Cells and Don't Advance」を選択する。
    • [キーボード] Ctrl + Enter を押す。
  • 選択中のセルより上のすべてのセルを実行する。
    • [メニューバー] 「Run→Run All Above Selected Cell」を選択する。
  • 選択中のセル及びそれより下のすべてのセルを実行する。
    • [メニューバー] 「Run→Run Selected Cell and All Below」を選択する。
  • すべてのセルを実行する。
    • [メニューバー] 「Run→Run All Cells」を選択する。

セルの操作の Undo / Redo

  • 直前に行ったセル操作をもとに戻す。
    • [メニューバー] 「Edit→Undo Cell Operation」を選択する。
    • [コンテキストメニュー] 「Undo Cell Operation」を選択する。
    • [キーボード] Shift + Z を押す。
  • 直前に Undo したセル操作を再実行する。

セルの移動

  • 選択中のセルを1つ上に移動する。
    • [メニューバー] 「Edit→Move Cells Up」を選択する。
    • [マウス] セルを選択し、ドラッグで移動する。
  • 選択中のセルを1つ下に移動する。
    • [メニューバー] 「Edit→Move Cells Down」を選択する。
    • [マウス] セルを選択し、ドラッグで移動する。

セルの切り取り、コピー、貼り付け

  • 選択中のセルの切り取り
  • 選択中のセルのコピー
  • 選択中のセルの1つ下に切り取りまたはコピーしたセルを挿入する。
    • [メニューバー] 「Edit→Paste Cells Below」を選択する。
    • [ツールバー] ボタンをクリックする。
    • [コンテキストメニュー] 「Paste Cells Below」を選択する。
    • [キーボード] V を押す。
  • 選択中のセルの1つ上に切り取りまたはコピーしたセルを貼り付ける。
    • メニューバーの「Edit→Paste Cells Above」を選択する。
  • 選択中のセルをコピーしたセルで置き換える。
    • メニューバーの「Edit→Paste Cells And Replace」を選択する。
  • 選択中のセルの削除
    • [メニューバー] 「Edit→Delete Cells」を選択する。
    • [コンテキストメニュー] 「Delete Cells」を選択する。
    • [キーボード] D を2回押す。

画面を分割している場合にある notebook から別の notebook にセルをドラッグアンドドロップすることでコピーできる。


セルの選択

  • すべてのセルを選択する。
    • [メニューバー] 「Edit→Select All Cells」を選択する。
    • [キーボード] Ctrl + A を押す。
  • 複数のセルを選択する。
    • Shift を押しながら、セルの左側の部分をマウスでクリックして選択することで複数のセルを選択できる。
  • 1つ上のセルを選択する。
    • [キーボード] ↑矢印キーまたは K を押す。
    • [キーボード] Shift を押しながら、↑矢印キーまたは K を押すことで連続選択できる。
  • 1つ下のセルを選択する。
    • [キーボード] ↓矢印キーまたは J を押す。
    • [キーボード] Shift を押しながら、↓矢印キーまたは J を押すことで連続選択できる。
  • すべての選択を解除する。
    • [メニューバー] 「Edit→Deselect All Cells」を選択する。

セルの分割

  • 選択中のセルをカーソルの位置で2つのセルに分割する。
    • [メニューバー] 「Edit→Split Cell」を選択する。
    • [コンテキストメニュー] 「Split Cell」を選択する。
    • [キーボード] Ctrl + Shift + - を押す。

セルの統合

  • 選択中の2つ以上のセルを1つに統合する。
    • [メニューバー] 「Edit→Merge Selected Cells Cell」を選択する。
    • [キーボード] Shift + M を押す。

新しいセルの挿入

  • 選択中のセルの1つ上に新しいセルを挿入する。
    • [キーボード] A を押す。
  • 選択中のセルの1つ下に新しいセルを挿入する。
    • [ツールバー] ボタンをクリックする。
    • [キーボード] B を押す。

出力をクリアする。

  • 選択中の出力をクリアする。
    • [メニューバー] 「Edit→Clear Outputs」を選択する。
  • すべての出力をクリアする。

セルの折りたたみ

セル及びその出力は左側のバーをクリックすることで折りたたむことができる。


  • メニューバーの「View」からも操作できる。
    • Collapse Selected Code: 選択したセルを折りたたむ。
    • Collapse Selected Outputs: 選択した出力を折りたたむ。
    • Collapse All Code: すべてのセルを折りたたむ。
    • Collapse All Outputs: すべての出力を折りたたむ。
    • Expand Selected Code: 選択したセルを展開する。
    • Expand Selected Outputs: 選択した出力を展開する。
    • Expand All Code: すべてのセルを展開する。
    • Expand All Outputs: すべての出力を展開する。

セルの出力のスクロールを有効にする。

セルの出力のスクロールを有効にすることで、長い出力によって notebook 全体が長くなってしまう現象を防止できる。
スクロールを有効にするかどうかはセルの出力を右クリックし、コンテキストメニューから選択できる。


Notebook の操作

入力補完

入力中にタブキーを押すと、候補が表示される。


Docstring 表示

関数名のところにカーソルがある状態で Shift + Tab キーを押すことで、Docstring が表示できる。

行番号の表示

メニューバーの「View→Show Line Numbers」を選択することで、行番号をするかどうかの切り替えが行える。

  • 選択中のセルの行番号の表示/非表示を切り替える。
    • [キーボード] L を押す。
  • すべてのセルの行番号の表示/非表示を切り替える。
    • [キーボード] Shift + L を押す。

同じ notebook を画面分割して開く。

1つの notebook を画面分割することで、参照しておきたいセルを見ながら編集作業が行える。


セルの出力を固定して表示する。

あるセルの出力を画面分割で表示しておくことで、参照しておきたい出力を見ながら編集作業が行える。


テーマの変更

メニューバーの「Settings→JupyterLab Theme」でテーマを変更できる。