Pythonの勉強をしていると、Jupyter Notebookを使う手順を多くお見受けします。Jupyter Notebookは、コードの断片を実行したり、printを書かなくても表示したい変数を参照できる点などが非常に便利と感じます。その一方で、Pythonコード(.py)のまとまりを実行してデバッグするのであればVisual Studio CodeのPython拡張機能の方が私的には便利です。
そこで、両方を使えるようにVSCodeからJupyterを呼び出す方法を調べてみました。またPythonですからconda activateを含めた仮想環境の使い方も併せてまとめておきます。今回はサンプルとして PyTorchを含む仮想環境にアクセスしました。手順はMacBook Pro上で実行したものです。
事前準備
以下記事を進めていることを前提に書いています。
- Homebrewをインストールする
- Anacondaをインストールする
- Miniforgeをインストトールする
Visual Stutio Codeには下記の拡張機能をインストールしています。
- Python
- Pythonのコード拡張
- Japanese Language Pack
- 日本語表記の手順を紹介します
- Remote Development
- 今回は特に出番ありませんがリモートの仮想環境を使うなら必要です
作業ディレクトリを作成して仮想環境を整える
まず作業ディレクトリを作成し、仮想環境も作成します。
$ cd ~
$ mkdir jupyterbox
# jupyterboxという作業ディレクトリを作成する
$ cd ./jupyterbox
# 仮想環境を作る
$ conda create --prefix ./env python=3.8
# 仮想環境に入ってPyTorchをインストールする
$ conda activate ./env
(env) $ conda install pytorch::pytorch torchvision torchaudio -c pytorch
一旦この状態でPyTorchが使えるか確認しておきましょう。
(env) $ python
>>> import torch
# 特にエラーが出なければOK
Visual Studio Code上での操作
それでは、Visual Studio Codeを触っていきましょう。Visual Studio Codeのインストールが未だの方は、下記手順を参照してください。
拡張機能Jupyterをインストールする
Visual Studio Codeの拡張機能を開き、Jupyterをインストールしましょう。
作業ディレクトリを開き、仮想環境にJupyterをインストールする
ファイルタブから「フォルダを開く」を選択して、前手順で作成した作業ディレクトリを開きます。作業ディレクトリを開いた後は、ターミナルにアクセスし、仮想環境に入り、Jupyterをインストールします。
仮想環境へJupyterとipykernelをインストールし、有効化する
Jupyterを使う前準備します。
(base) $ ls
env
# 仮想環境にログインします
(base) $ conda activate ./env
# Jupyter拡張をインストールします
(env) $ pip install jupyter
# Jupyter Notebook 用の Python カーネルをインストールします
(env) $ pip install ipykernel
# ipykernelを有効化します
(env) $ python -m ipykernel install --user
Jupyterを使ってみましょう
作業用ファイルを作成する
Visual Studio Codeの「新しいファイル」でtest.ipynbをカレントディレクトリ内に作成します。.ipynbはJupyter Notebook用の作業ファイルです。
仮想環境を有効化する
続いてtest.ipynbを実行する仮想環境を選択します。右上の「カーネルの選択」をクリックし「Python環境」から、前手順で作成した仮想環境フォルダ「env」を選択してください（conda createした仮想環境名と合わせてください）。
Pythonコードを実行してみましょう！
これで準備が整いました。最後に左上の「＋コード」をクリックし、実行したいPythonコードを実行し、コード左にある再生ボタンをクリックすると、コードが実行されます。今回はPyTorchにバンドルされているニューラルネットワークの一覧を表示する以下のコードを実行してみました。 正しく仮想環境が選択できていればPyTorchにアクセスできるはずです。
import torch
from torchvision import models
dir(models)
これで、Visual Studio CodeとJupyter Notebookを連携させることができました。
それでは良いPythonライフを！