colab-sshを使って、VS CodeからGoogle Colabに接続してみよう：Visual Studio Codeで快適Pythonライフ（1/2 ページ）
Google Colab上のノートブックにcolab-sshモジュールをインストールして、そこへVS CodeからSSH接続する方法を紹介します。
前回は、ColabCodeモジュールを使って、Google Colab上でVisual Studio Code（以下、VS Code）のサーバ版ともいえる「code-server」を実行する方法を見ました。今回は、colab-sshモジュールを使って、ローカル環境で実行しているVS CodeからGoogle ColabにSSH接続する方法を紹介します。
colab-ssh
インターネットを「vscode colab」などの語で検索すると、VS CodeからGoogle ColabにSSH接続するための情報が数多く見つかります（もちろん、colab-sshモジュールを使った方法も見つかります）。それらの情報の多くは少し手間がかかるものです。ここでは、なるべく手間がかからないように、colab-sshモジュールを使うことにしました。
colab-sshはGoogle ColabへのSSH接続を簡単に行えるようにするためのモジュールで、これとVS CodeのRemote - SSH拡張機能を組み合わせることで、VS CodeからGoogle ColabへのSSH接続を簡単に行うのが今回の目的です。なお、colab-sshモジュールではGoogle ColabにSSH接続する方法として大きく以下の2つがサポートされています。
- launch_ssh_cloudflared関数を使用する（cloudflaredをインストールする必要がある）
- launch_ssh関数を使用する（ngrokに登録して、認証コードを取得する必要がある）
本稿では前者の方法を紹介します。
launch_ssh_cloudflared関数を使う方法
まずはlaunch_ssh_cloudflared関数を使う方法を見てみましょう。大まかな手順は次の通りです。
- ローカルマシンへのcloudflaredのインストール
- Google Colabノートブックへのcolab-sshモジュールのインストール
- colab-sshモジュールが提供するlaunch_ssh_cloudflared関数を呼び出す
- VS CodeへのRemote - SSH拡張機能のインストール
- VS CodeからGoogle ColabへSSH接続する
上の手順でGoogle ColabへのSSH接続を行ってみましょう。
ローカルマシンへのcloudflaredのインストール
こちらの方法では、事前にcloudflaredをローカルマシンにダウンロードして、インストールしておく必要があります。ダウンロードリンクやインストール方法については、［Downloads］ページを参照してください。以下ではWindows版のcloudflaredをインストールしたものとします（Windows版のcloudflaredの場合、インストールといっても、ダウンロードしたファイルを適当なフォルダに移動するだけでした。ここでは「C:\cloudflared」フォルダを作成して、そこにファイルを移動しました）。
このとき、インストールしたcloudflaredの絶対パスを覚えておくようにしましょう（筆者の場合は「C:\cloudflared\cloudflared-windows-amd64.exe」です）。
Google Colabノートブックへのcolab-sshモジュールのインストール
次にGoogle Colabで新規にノートブックを作成します。前回のColabCodeモジュールと同じく、このノートブックはあくまでもVS CodeからGoogle Colabに接続するために使うことには注意してください。このとき、必要であれば（多くの場合はそうでしょう）、Google Colab環境でGPUを使うようにランタイムの設定を変更しておきます。
colab-sshモジュールをインストールするには、「!pip install colab_ssh --upgrade」コマンドを実行するだけです。
インストールできたら、まずは次のコードをセルで実行しましょう。
from google.colab import drive
drive.mount('./drive')
既に述べたように、今コードを記述しているノートブックはあくまでもVS CodeからGoogle ColabにSSH接続を可能にするためのものでしかありません。仮想マシンに置いたファイルやデータは、その削除時に一緒に削除されてしまいます（これは、前回に取り上げたColabCodeモジュールと同様です）。そのため、Google Driveを仮想マシンにマウントして、そこにあるファイルやノートブックを使うためにこれが必要になります。
このコードを仮想マシン上で始めて実行すると、次のように認証コードを入力するように促されるので、自分がログインしたことを確認した上で、認証コードを取得して、入力しましょう。
colab-sshモジュールが提供するlaunch_ssh_cloudflared関数を呼び出す
次に先ほどインポートしたcolab-sshモジュールからlaunch_ssh_cloudflared関数をインポートします。
from colab_ssh import launch_ssh_cloudflared
launch_ssh_cloudflared(password='……')
launch_ssh_cloudflared関数を呼び出すと、上の画像のようなメッセージが表示されます。これは「cloudflaredをダウンロードして、その絶対パスをコピーして」「画像内に示されている構成をSSHの構成ファイルに貼り付けろ」「VS CodeからはXXXを指定すれば接続できるよ」と書いてあります。
というわけで次ページでは、Google ColabにSSH接続できるように拡張機能をインストールしてみましょう。
連載一覧
- 第1回「Visual Studio Codeから「Hello Python」してみよう」
- 第2回「VS Codeでのファイルの作成と編集の第一歩：アクティビティーバーと［エクスプローラー］ビューを使ってみよう」
- 第3回「VS CodeでのPythonコーディングを快適にするエディタ機能の使い方」
- 第4回「コマンドパレットを駆使してVS Codeを使いこなそう！」
- 第5回「ショートカットキーを活用して、VS Codeをより快適に！」
- 第6回「ここから始めるVS Codeのカスタマイズ」
- 第7回「フォントからエディタ、改行文字まで、VS Codeを自分好みにカスタマイズ」
- 第8回「VS Codeの拡張機能でPythonの仮想環境構築からコード整形、Lintまでを体験してみよう」
- 第9回「VS Codeを使ってPythonコードをデバッグするための基礎知識」
- 第10回「VS CodeでPythonコードのデバッグ構成をしてみよう」
- 第11回「VS CodeでJupyterしてみよう」
- 第12回「Jupyter対話環境を使ってVS Codeでノートブックのデバッグ」
- 第13回「ColabCodeを使って、Google Colabの上でVS Codeを使ってみよう」
- 第14回「colab-sshを使って、VS CodeからGoogle Colabに接続してみよう」（本稿）
Copyright© Digital Advantage Corp. All Rights Reserved.