インストール
この文書は AI によって翻訳されています。内容に不正確な点や改善すべき点がございましたら、文書下部のコメント欄または以下の Issue ページにてご報告ください。
https://github.com/Seeed-Studio/wiki-documents/issues
インストール
SSCMA の実行環境は PyTorch と OpenMMLab のさまざまなサードパーティライブラリに依存しています。GitHub で SSCMA のコードを見つけることができます。始めるには、こちら の指示に従ってローカルに PyTorch をインストールし、必要な OpenMMLab ライブラリを取得してください。
- MMCV: OpenMMLab コンピュータビジョン基盤ライブラリ。
- MMClassification: OpenMMLab 画像分類ツールキットとベンチマーク。分類タスクに加えて、さまざまなバックボーンネットワークを提供します。
- MMDetection: OpenMMLab 検出ツールボックスとベンチマーク。
- MMPose: OpenMMLab 検査ツールボックスとベンチマーク。
- MIM: MIM は OpenMMLab プロジェクトとその拡張機能を開始およびインストールし、OpenMMLab モデルライブラリを管理するための統一インターフェースを提供します。
前提条件
SSCMA は Linux、Windows、macOS で動作します。Python パッケージを管理するために Miniconda を使用することを強くお勧めします。 以下の手順に従って環境を準備してください。
Miniconda は conda の無料の最小インストーラーであり、Miniconda公式ウェブサイト から Miniconda3 をダウンロードしてインストールできます。
ステップ 0 - Git リポジトリをクローンする
まず、SSCMA ソースコード をローカルにクローンする必要があります。Git を使用して管理し、GitHub にホストしています。以下にクローンするための 2 つの異なる方法を提供しています(どちらかを選択してください)。Git がインストールされていない場合は、Git ドキュメント を参照してコンピュータに Git を設定してください。
- HTTPS
- SSH
git clone https://github.com/Seeed-Studio/ModelAssistant.git --depth 1 && \
cd ModelAssistant
git clone [email protected]:Seeed-Studio/ModelAssistant.git --depth 1 && \
cd ModelAssistant
ステップ 1 - 仮想環境を作成する
conda がインストールされていると仮定して、conda 仮想環境を作成してアクティブ化します。
conda create --name sscma python=3.8 -y && \
conda activate sscma
ステップ 2 - PyTorch をインストールする
SSCMA は PyTorch に依存しています。以下のコードを実行する前に、先ほど作成した仮想環境をアクティブ化していることを再度確認してください。
GPU (CUDA) を搭載したデバイスの場合、GPU アクセラレーションをサポートする依存関係をインストールすることをお勧めします。以下に 2 つの異なるケースで選択できる構成オプションを記載しています。ハードウェア環境に応じて手動で選択してください。
- CPU のみのプラットフォーム:
- conda
- pip
conda install pytorch torchvision torchaudio cpuonly -c pytorch
pip3 install torch torchvision torchaudio
- GPU (CUDA) プラットフォーム:
- conda
- pip
conda install pytorch torchvision torchaudio pytorch-cuda=11.7 cudatoolkit=11.7 -c pytorch -c nvidia
pip3 install torch torchvision torchaudio --extra-index-url https://download.pytorch.org/whl/cu117
NVIDIA GPU 用の CUDA がプラットフォームにインストールされていない場合は、NVIDIA CUDA Toolkit Archive Website で CUDA インストーラーを見つけることができます。ホスト環境で CUDA 11.7 以上を使用することをお勧めします。他のプラットフォームで PyTorch をインストールする方法については、PyTorch公式ウェブサイト を参照してください。
ステップ 3 - 必須依存関係をインストールする
仮想環境をアクティブ化し、SSCMA ソースコードのメイン作業ディレクトリにいることを確認してください。 次に、以下のコードを実行して基本的な依存関係の構成を完了します。
- SSCMA の依存関係をインストール
pip3 install -r requirements/base.txt && \
mim install -r requirements/mmlab.txt && \
mim install -e .
ステップ 4 - 追加依存関係をインストールする (オプション)
モデル変換や推論テストを実行する必要がある場合は、以下の追加依存関係もインストールする必要があります。
pip3 install -r requirements/inference.txt -r requirements/export.txt
SSCMA に変更を加えてそれを提出したい場合は、以下のコマンドを実行することをお勧めします。これにより、コミット時にコードをチェックしやすくなります。
pip3 install -r requirements/tests.txt
pre-commit install
その他の方法
SSCMA 環境の設定は、Linux(Ubuntu 20.04~22.10 でテスト済み)上で Conda をセットアップしている場合、シェルスクリプトを使用して自動的に行うことができます。
bash scripts/setup_linux.sh
または、Conda の設定ファイルを使用して手動で設定することもできます。
- CPU
- GPU (CUDA)
conda env create -n sscma -f environment.yml && \
conda activate sscma && \
pip3 install -r requirements/inference.txt -r requirements/export.txt -r requirements/tests.txt && \
mim install -r requirements/mmlab.txt && \
mim install -e .
conda env create -n sscma -f environment_cuda.yml && \
conda activate sscma && \
pip3 install -r requirements/inference.txt -r requirements/export.txt -r requirements/tests.txt && \
mim install -r requirements/mmlab.txt && \
mim install -e .
注意事項
Miniconda のインストールを完了し、SSCMA を Conda で設定した後、sscma
という名前の Conda 仮想環境を作成し、その仮想環境内に依存関係をインストールしました。以降の SSCMA に関連する設定や開発を行う際は、SSCMA 仮想環境内にいることを確認してください。以下のコマンドで仮想環境を有効化できます。
conda activate sscma
SSCMA 仮想環境を再設定または削除したい場合は、以下のコマンドを実行してください。
conda env remove -n sscma