WSL2とDockerとVSCodeのRemote Containersで最高の開発環境をつくる

こんにちは。現役エンジニアの”はやぶさ”@Cpp_Learningです。

WSL2 + Docker + VS Code の Remote – Containers のPython開発環境が最高だったので、構築方法と実践チュートリアルを紹介します。

Contents

1 いままでのPython開発環境
2 WSL2インストール
- 2.1 BIOS画面からCPUの仮想化を有効にする
- 2.2 Linux ディストリビューション：Ubuntu 20.04 LTSのインストール
3 Visual Studio Codeインストール
4 Docker Desktopインストール
5 VS Code 拡張機能：Remote – Containersインストール
6 実践 Dockerチュートリアル -Pythonで機械学習アプリ開発-
7 まとめ

いままでのPython開発環境

WSL + VS Code のPython開発環境については下記で紹介しました。

【WSL】Windows10とUbuntuとVSCodeで快適なプログラミング環境を構築Windows Subsystem for Linux(WSL)とVisual Studio Code(VSCode)で快適なプログラミング環境を構築する方法を説明します。C言語とC++とPythonなどのプログラミング言語を使う人にオススメの記事です。...

上記と本記事では以下の点が異なります。

WSL1 ⇒ WSL2 に移行
Docker 導入
VS Code の Remote – Containers 導入

各種のインストール手順を説明します。

WSL2インストール

Windows 10 用 Windows Subsystem for Linux のインストールガイド｜公式に従い、WSL2 をインストールします。最初に以下の注意点を確認しておきましょう。

Windows 10 のバージョンが WSL2 の実行に関する要件を満たしていること

BIOS画面からCPUの仮想化を有効にする

以下を参考にBIOS画面からCPUの仮想化を有効にします。

WSL2をインストールして使うときの注意点｜Qiita

BIOS画面の表示方法はPCによって異なります。私が使っている HP の場合、PC起動時にF10を連打すれば、BIOS画面が立ち上がります。

Linux ディストリビューション：Ubuntu 20.04 LTSのインストール

あとはインストールガイドの通りにやればOKです。手順6で任意のLinux ディストリビューションをインストールします。悩む人には Ubuntu 20.04 LTS をオススメしておきます。

以上で WSL2 のインストール完了です。

Visual Studio Codeインストール

Visual Studio Code（通称VS Code）を公式サイトからインストールします。

以下の手順で VS Code から WSL2 に接続できます。

VS Code左下の「><」をクリック
Remote-WSLを選択
左下が「>< WSL: Ubuntu」になったら、ターミナルを開く

問題なければ、下図のように表示されます。Windowsマシンで VS Code + Ubuntu ターミナルが使える時点で既に快適です。

Docker Desktopインストール

続いて Docker Desktop をインストールします。インストール途中で WSL2 を利用するか聞かれるので、チェックを入れます

先ほどのターミナルに docker -v と入力し、問題なければ下図のように Docker バージョンが表示されます。

この時点で WSL2 + Docker + VS Code の環境構築完了です。

WSL2 + VSCode + Docker 開発環境｜Qiita

VS Code 拡張機能：Remote – Containersインストール

最後に VS Code 拡張機能の Remote – Containers をインストールします。あと拡張機能の Docker も便利なので、インストール推奨です。

以下の手順で VS Code から Docker に接続できます。

プロジェクトフォルダにDockerfile または docker-compose.ymlを用意
プロジェクトフォルダをVS Codeから開く
VS Code左下の「><」をクリック
Reopen in Container を選択
From Dockerfile を選択
左下が「Dev Container: Existing Dockerfile」になったら接続成功

※次章の「チュートリアル」で詳しく説明します

Remote – Containers の使い方から後述するDockerfileの書き方まで、以下の記事が大変参考になりました。

DockerとRemote Containersでの開発環境が最高過ぎる｜Sweet Escape

実践 Dockerチュートリアル -Pythonで機械学習アプリ開発-

構築した開発環境を使って、簡単な機械学習サンプルコードを動かしてみます。

適当な場所に下記構成のプロジェクトフォルダ：docker-ml を作成します。

workspace
  └─docker-ml
      │──Dockerfile
      │──main.py
      │──pyproject.toml
      │
      └──model

workspace

└─docker-ml

│──Dockerfile

│──main.py

│──pyproject.toml

│

└──model

Dockerfile

Python公式イメージに依存関係管理ツールの Poetry を入れたDockerfileを作成します。

FROM python:3.8

RUN set -x && \
    curl -sSL https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py | python
ENV PATH /root/.poetry/bin:$PATH
RUN poetry config virtualenvs.create false

COPY pyproject.toml ./
RUN poetry install --no-root --no-dev

FROM python:3.8

RUN set -x && \

curl -sSL https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py | python

ENV PATH /root/.poetry/bin:$PATH

RUN poetry config virtualenvs.create false

COPY pyproject.toml ./

RUN poetry install --no-root --no-dev

下の2行を追加すれば、イメージのビルド時（コンテナ生成時）に pyproject.toml で定義した各パッケージを自動でインストールしてくれます。

pyproject.toml

pyproject.toml には main.py の動作に必要なパッケージをバージョン指定で定義します。

[tool.poetry]
name = "docker-test"
version = "0.1.0"
description = ""
authors = ["hayabusa <hayabusa@example.com>"]

[tool.poetry.dependencies]
python = ">=3.7.1"
numpy = "^1.19.5"
pandas = "^1.2.1"
scikit-learn = "^0.24.1"
palmerpenguins = "^0.1.4"

[tool.poetry.dev-dependencies]
pytest = "^6.2.2"

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

[tool.poetry]

name = "docker-test"

version = "0.1.0"

description = ""

authors = ["hayabusa <hayabusa@example.com>"]

[tool.poetry.dependencies]

python = ">=3.7.1"

numpy = "^1.19.5"

pandas = "^1.2.1"

scikit-learn = "^0.24.1"

palmerpenguins = "^0.1.4"

[tool.poetry.dev-dependencies]

pytest = "^6.2.2"

[build-system]

requires = ["poetry-core>=1.0.0"]

build-backend = "poetry.core.masonry.api"

(※) poetry init で pyproject.toml の雛形を作成できます

機械学習サンプルコード main.py

機械学習ソースコードを作成し、main.py という名で保存。モデル保存用フォルダ：modelも事前に作成します。

import numpy as np
import joblib
from palmerpenguins import load_penguins

from sklearn.model_selection import train_test_split
from sklearn.metrics import confusion_matrix
from sklearn.experimental import enable_iterative_imputer
from sklearn.tree import DecisionTreeClassifier
from sklearn.metrics import classification_report, accuracy_score


def train():
    # load dataset
    X, y = load_penguins(return_X_y=True, drop_na=True)

    # # check missing values
    # print(X.isnull().any())  # False
    # print(X.isnull().sum())  # 0

    # split dataset (train:valid = 7:3)
    X_train, X_valid, y_train, y_valid = train_test_split(
        X, y, test_size=0.3, random_state=42)

    # learn
    model = DecisionTreeClassifier()
    model.fit(X_train, y_train)

    # predict
    y_pred = model.predict(X_valid)

    # print precision, recall, f1-score, support
    print(classification_report(y_valid, y_pred))
    print("score:", accuracy_score(y_valid, y_pred))

    # save model
    name = "decisiontree_model"
    joblib.dump(model, f"model/{name}.pkl")
    print(f"save model: {name}")


def predict():
    # model name + path
    name = "decisiontree_model"
    saved_filename = (f"model/{name}.pkl")

    # test data
    x_test = np.array([[39.2, 17.7, 181, 3740]])

    # load model
    model = joblib.load(saved_filename)

    # predict
    y_pred = model.predict(x_test)
    print("predict:", y_pred)


if __name__ == "__main__":
    train()
    predict()

import numpy as np

import joblib

from palmerpenguins import load_penguins

from sklearn.model_selection import train_test_split

from sklearn.metrics import confusion_matrix

from sklearn.experimental import enable_iterative_imputer

from sklearn.tree import DecisionTreeClassifier

from sklearn.metrics import classification_report, accuracy_score

def train():

# load dataset

X, y = load_penguins(return_X_y=True, drop_na=True)

# # check missing values

# print(X.isnull().any()) # False

# print(X.isnull().sum()) # 0

# split dataset (train:valid = 7:3)

X_train, X_valid, y_train, y_valid = train_test_split(

X, y, test_size=0.3, random_state=42)

# learn

model = DecisionTreeClassifier()

model.fit(X_train, y_train)

# predict

y_pred = model.predict(X_valid)

# print precision, recall, f1-score, support

print(classification_report(y_valid, y_pred))

print("score:", accuracy_score(y_valid, y_pred))

# save model

name = "decisiontree_model"

joblib.dump(model, f"model/{name}.pkl")

print(f"save model: {name}")

def predict():

# model name + path

name = "decisiontree_model"

saved_filename = (f"model/{name}.pkl")

# test data

x_test = np.array([[39.2, 17.7, 181, 3740]])

# load model

model = joblib.load(saved_filename)

# predict

y_pred = model.predict(x_test)

print("predict:", y_pred)

if __name__ == "__main__":

train()

predict()

以上でプロジェクトフォルダ：docker-ml の中身を全て用意できました。

Dockerコンテナ内で機械学習

プロジェクトフォルダをVS Codeから開き、VS Code左下の「><」をクリック後、Reopen in Container を選択します。

From Dockerfile を選択すると、イメージのビルドが実行されます（初回のみ）。

左下が「Dev Container: Existing Dockerfile」になったら接続成功です。

ターミナルに以下のコマンドを入力し、main.pyを実行します。

poetry run python main.py

スコアレポートなどが表示され、学習済みモデルがmodel/decisiontree_model.pklに保存できればOKです。

以上で「実践 Dockerチュートリアル -Pythonで機械学習アプリ開発-」終了です。

【おまけ】チュートリアル後の次ステップ -オリジナル機械学習アプリをつくろう-

main.py 実行後に表示される predict: [‘Adeli’] というのは、predict() による「学習済みモデルで未知のデータを推論した結果」です。

はやぶさ

main.py の責務は訓練のみにする予定でした。つまり train() のみ作成する予定でしたが、サービスで predict() も作成しました。

本チュートリアルの次ステップとして、main.py から predict() を切り離し、推論専用のオリジナル機械学習アプリ app.py を作成してみましょう。

例えば、本記事の predict() では未知のデータ[39.2, 17.7, 181, 3740]をコード内にべた書きしてますが、外部から受け取るようにし、推論結果を返すような機械学習アプリを作るのはいかがですか？

はやぶさ

ぜひ自分のアイデアを形にしてみて下さい。

まとめ

WSL2 + Docker + VS Code の Remote – Containers のPython開発環境が最高だったので、構築方法と実践チュートリアルを紹介しました。

Docker入門や機械学習アプリ開発の勉強にもなると思うので、参考になれば嬉しいです。

【おまけ】に書いた「オリジナル機械学習アプリ開発」にも、ぜひ挑戦してみて下さい。

WSL2とDockerとVSCodeのRemote Containersで最高の開発環境をつくる

いままでのPython開発環境

WSL2インストール

BIOS画面からCPUの仮想化を有効にする

Linux ディストリビューション：Ubuntu 20.04 LTSのインストール

Visual Studio Codeインストール

Docker Desktopインストール

VS Code 拡張機能：Remote – Containersインストール

実践 Dockerチュートリアル -Pythonで機械学習アプリ開発-

Dockerfile

pyproject.toml

機械学習サンプルコード main.py

Dockerコンテナ内で機械学習

【おまけ】チュートリアル後の次ステップ -オリジナル機械学習アプリをつくろう-

まとめ

プライム感謝祭セールを完全攻略！事前準備やお得キャンペーンを徹底解説

【アマゾンプライムデー2023年】完全攻略！事前準備やお得キャンペーンを徹底解説

【2023年版】アマゾンプライム会員のメリット・デメリットを紹介！

Golang × WebAssembly（wasm）入門

【Python】最適化フレームワークのCodable Model Optimizerで回帰モデルのパラメータ調整を自動化する

【GitHub】シンプルなREADME.mdの書き方 -コピペで使えるテンプレート付き-

【Pyxel】Pythonでレトロゲームを作ろう！総集編 -まるっと1週間でゲーム開発入門-

【仕事効率化】Visual Studio Code で Markdown を使いこなす

【深層学習入門】画像処理の基礎(画素操作)からCNN設計まで

【Pyxel】Pythonでレトロゲームを作ろう！ Day 1 -画像の扱い方-

いままでのPython開発環境

WSL2インストール

BIOS画面からCPUの仮想化を有効にする

Linux ディストリビューション：Ubuntu 20.04 LTSのインストール

Visual Studio Codeインストール

Docker Desktopインストール

VS Code 拡張機能：Remote – Containersインストール

実践 Dockerチュートリアル -Pythonで機械学習アプリ開発-

Dockerfile

pyproject.toml

機械学習サンプルコード main.py

Dockerコンテナ内で機械学習

【おまけ】チュートリアル後の次ステップ -オリジナル機械学習アプリをつくろう-

まとめ

プライム感謝祭セールを完全攻略！事前準備やお得キャンペーンを徹底解説

【アマゾンプライムデー2023年】完全攻略！事前準備やお得キャンペーンを徹底解説

【2023年版】アマゾンプライム会員のメリット・デメリットを紹介！

Golang × WebAssembly（wasm）入門

【Python】最適化フレームワークのCodable Model Optimizerで回帰モデルのパラメータ調整を自動化する

【GitHub】シンプルなREADME.mdの書き方 -コピペで使えるテンプレート付き-

【Pyxel】Pythonでレトロゲームを作ろう！ 総集編 -まるっと1週間でゲーム開発入門-

【仕事効率化】Visual Studio Code で Markdown を使いこなす

【深層学習入門】画像処理の基礎(画素操作)からCNN設計まで

【Pyxel】Pythonでレトロゲームを作ろう！ Day 1 -画像の扱い方-

【Pyxel】Pythonでレトロゲームを作ろう！総集編 -まるっと1週間でゲーム開発入門-