GitHubでページを編集 (EN)

Ultralyticsをインストール

Ultralyticsは、pip、conda、Dockerなど、多様なインストール方法を提供しています。YOLOは、最新の安定リリース向けにultralytics pipパッケージをインストールするか、Ultralytics GitHubリポジトリをクローンして最新バージョンを取得することでインストールできます。Dockerを利用して独立したコンテナ内でパッケージを実行することも可能で、これによりローカル環境へのインストールを回避できます。



Watch: Ultralytics YOLO Quick Start Guide
インストール

PyPI - Python Version

Install or update the ultralytics package using pip by running pip install -U ultralytics. For more details on the ultralytics package, visit the Python Package Index (PyPI).

PyPI - Version Downloads

# Install or upgrade the ultralytics package from PyPI
pip install -U ultralytics

ultralyticsは、Ultralytics GitHubリポジトリから直接インストールすることも可能です。これは、最新の開発バージョンが必要な場合に便利です。Gitコマンドラインツールがインストールされていることを確認した上で、以下のコマンドを実行してください。

# Install the ultralytics package from GitHub
pip install git+https://github.com/ultralytics/ultralytics.git@main

依存関係のリストについては、ultralyticsのpyproject.tomlファイルを参照してください。上記のすべての例は必要な依存関係をすべてインストールすることに注意してください。

ヒント

PyTorchの要件はOSやCUDA要件によって異なるため、PyTorchの手順に従って先にPyTorchをインストールしてください。

PyTorch installation selector for different platforms

ヘッドレスサーバーへのインストール

For server environments without a display (e.g., cloud VMs, Docker containers, CI/CD pipelines), use the ultralytics-opencv-headless package. This is identical to the standard ultralytics package but depends on opencv-python-headless instead of opencv-python, avoiding unnecessary GUI dependencies and potential libGL errors.

ヘッドレスインストール
pip install ultralytics-opencv-headless

どちらのパッケージも同じ機能とAPIを提供します。ヘッドレスバリアントは、ディスプレイライブラリを必要とするOpenCVのGUIコンポーネントを除外するだけです。

高度なインストール

標準的なインストール方法でほとんどのユースケースに対応できますが、開発やカスタム設定のために、より調整されたセットアップが必要になる場合があります。

高度な方法

永続的なカスタム変更が必要な場合は、Ultralyticsリポジトリをフォークし、pyproject.tomlやその他のコードに変更を加えてから、フォークからインストールすることができます。

  1. Ultralytics GitHubリポジトリを自分のGitHubアカウントにフォークします。
  2. 自分のフォークをローカルにクローンします: 
    git clone https://github.com/YOUR_USERNAME/ultralytics.git
cd ultralytics
  3. 変更のために新しいブランチを作成します: 
    git checkout -b my-custom-branch
  4. pyproject.tomlやその他のファイルを必要に応じて修正します。
  5. 変更をコミットしてプッシュします: 
    git add .
git commit -m "My custom changes"
git push origin my-custom-branch
  6. ブランチを指定し、git+https構文を使用してpipでインストールします: 
    pip install git+https://github.com/YOUR_USERNAME/ultralytics.git@my-custom-branch

CLIでUltralyticsを使用する

Ultralyticsのコマンドラインインターフェース（CLI）を使用すると、Python環境を必要とせず、シンプルな一行のコマンドで実行できます。CLIにはカスタマイズやPythonコードは不要で、ターミナルからyoloコマンドですべてのタスクを実行できます。コマンドラインからのYOLOの使用については、CLIガイドをご覧ください。

例

Ultralyticsのyoloコマンドは、以下の構文を使用します:

yolo TASK MODE ARGS

すべてのARGSについては、完全な構成ガイドを参照するか、yolo cfg CLIコマンドを実行してください。

警告

引数は arg=value ペアとして渡し、等号 = で区切り、スペースで分割する必要があります。-- 引数プレフィックスや、引数間のカンマ , は使用しないでください。

  • yolo predict model=yolo26n.pt imgsz=640 conf=0.25 ✅
  • yolo predict model yolo26n.pt imgsz 640 conf 0.25 ❌ (=がありません)
  • yolo predict model=yolo26n.pt, imgsz=640, conf=0.25 ❌ (カンマ , を使用しないでください)
  • yolo predict --model yolo26n.pt --imgsz 640 --conf 0.25 ❌ (--を使用しないでください)
  • yolo solution model=yolo26n.pt imgsz=640 conf=0.25 ❌ (use solutions, not solution)

CLIガイド

PythonでUltralyticsを使用する

Ultralytics YOLO Pythonインターフェースは、Pythonプロジェクトへのシームレスな統合を提供し、モデルのロード、実行、出力を簡単に処理できるようにします。シンプルさを追求した設計により、物体検出、セグメンテーション、分類を迅速に実装できます。これにより、YOLO Pythonインターフェースは、これらの機能をプロジェクトに組み込むための非常に価値のあるツールとなります。

例えば、モデルのロード、学習、パフォーマンスの評価、そしてONNX形式へのエクスポートを数行のコードで実行できます。Pythonプロジェクト内でのYOLOの使用について詳しくは、Pythonガイドをご覧ください。

例
from ultralytics import YOLO

# Create a new YOLO model from scratch
model = YOLO("yolo26n.yaml")

# Load a pretrained YOLO model (recommended for training)
model = YOLO("yolo26n.pt")

# Train the model using the 'coco8.yaml' dataset for 3 epochs
results = model.train(data="coco8.yaml", epochs=3)

# Evaluate the model's performance on the validation set
results = model.val()

# Perform object detection on an image using the model
results = model("https://ultralytics.com/images/bus.jpg")

# Export the model to ONNX format
success = model.export(format="onnx")

Pythonガイド

Ultralytics設定

Ultralyticsライブラリには、実験を細かく制御するための SettingsManager が含まれており、ユーザーは設定に簡単にアクセスして変更できます。これらの設定は環境のユーザー設定ディレクトリ内のJSONファイルに保存され、Python環境内やコマンドラインインターフェース（CLI）経由で表示・変更できます。

設定の確認

現在の設定構成を表示するには、以下を実行します:

設定を表示

Use Python to view your settings by importing the settings object from the ultralytics module. Print and return settings with these commands:

from ultralytics import settings

# View all settings
print(settings)

# Return a specific setting
value = settings["runs_dir"]

設定の変更

Ultralyticsでは、以下の方法で簡単に設定を変更できます。

設定の更新

In Python, use the update method on the settings object:

from ultralytics import settings

# Update a setting
settings.update({"runs_dir": "/path/to/runs"})

# Update multiple settings
settings.update({"runs_dir": "/path/to/runs", "tensorboard": False})

# Reset settings to default values
settings.reset()

設定の理解

以下の表は、Ultralytics内の調整可能な設定の概要であり、設定値の例、データ型、および説明を示しています。

名前設定値の例データ型説明
settings_version'0.0.4'strUltralytics settings version (distinct from the Ultralytics pip version)
datasets_dir'/path/to/datasets'strデータセットが保存されるディレクトリ
weights_dir'/path/to/weights'strモデルの重みが保存されるディレクトリ
runs_dir'/path/to/runs'str実験の実行結果が保存されるディレクトリ
uuid'a1b2c3d4'str現在の設定の一意の識別子
syncTrueboolOption to sync analytics and crashes to Ultralytics Platform
api_key''strUltralytics Platform API Key
clearmlTrueboolOption to use ClearML logging
cometTrueboolOption to use Comet ML for experiment tracking and visualization
dvcTrueboolOption to use DVC for experiment tracking and version control
hubTrueboolOption to use Ultralytics Platform integration
mlflowTrueboolOption to use MLFlow for experiment tracking
neptuneTrueboolOption to use Neptune for experiment tracking
raytuneTrueboolOption to use Ray Tune for hyperparameter tuning
tensorboardTrueboolOption to use TensorBoard for visualization
wandbTrueboolOption to use Weights & Biases logging
vscode_msgTrueboolWhen a VS Code terminal is detected, enables a prompt to download the Ultralytics-Snippets extension.

プロジェクトや実験を進める中で、最適な構成を維持するためにこれらの設定を適宜見直してください。

FAQ

pipを使用してUltralyticsをインストールするには？

pipを使用してUltralyticsをインストールするには、次のコマンドを実行します：

pip install -U ultralytics

This installs the latest stable release of the ultralytics package from PyPI. To install the development version directly from GitHub:

pip install git+https://github.com/ultralytics/ultralytics.git

Gitコマンドラインツールがシステムにインストールされていることを確認してください。

condaを使用してUltralytics YOLOをインストールできますか？

はい、condaを使用してUltralytics YOLOをインストールするには、次のコマンドを実行します：

conda install -c conda-forge ultralytics

この方法はpipの優れた代替手段であり、他のパッケージとの互換性を確保します。CUDA環境では、競合を解決するためにultralytics、pytorch、およびpytorch-cudaを一緒にインストールしてください：

conda install -c pytorch -c nvidia -c conda-forge pytorch torchvision pytorch-cuda=11.8 ultralytics

詳細な手順については、Conda quickstart guideを参照してください。

Dockerを使用してUltralytics YOLOを実行する利点は何ですか？

DockerはUltralytics YOLOに対して分離された一貫性のある環境を提供し、システム間での円滑なパフォーマンスを保証して、ローカルインストール時の複雑さを回避します。公式のDockerイメージはDocker Hubで入手可能で、GPU、CPU、ARM64、NVIDIA Jetson、Conda向けのバリエーションがあります。最新のイメージを取得して実行するには：

# Pull the latest ultralytics image from Docker Hub
sudo docker pull ultralytics/ultralytics:latest

# Run the ultralytics image in a container with GPU support
sudo docker run -it --ipc=host --runtime=nvidia --gpus all ultralytics/ultralytics:latest

Dockerの詳細な手順については、Docker quickstart guideを参照してください。

開発のためにUltralyticsリポジトリをクローンするにはどうすればよいですか？

次のコマンドを使用して、Ultralyticsリポジトリをクローンし、開発環境をセットアップします：

# Clone the ultralytics repository
git clone https://github.com/ultralytics/ultralytics

# Navigate to the cloned directory
cd ultralytics

# Install the package in editable mode for development
pip install -e .

これにより、プロジェクトへの貢献や最新のソースコードを用いた実験が可能になります。詳細は、Ultralytics GitHub repositoryをご覧ください。

Ultralytics YOLO CLIを使用すべき理由は何ですか？

Ultralytics YOLO CLIは、Pythonコードなしで物体検出タスクを実行することを簡略化し、ターミナルから直接、トレーニング、検証、予測を行うための1行コマンドを可能にします。基本的な構文は以下の通りです：

yolo TASK MODE ARGS

例えば、検出モデルをトレーニングするには：

yolo train data=coco8.yaml model=yolo26n.pt epochs=10 lr0=0.01

その他のコマンドや使用例については、完全なCLI Guideをご覧ください。

Contributors
GitHubでページを編集 (EN)
GLglenn-jocher29RIRizwanMunawar6LALaughing-q3PDpderrenger3BUBurhan-Q3ONonuralpszr2JKjk4e2FCfcakyon1LAlakshanthad1PIpicsalex1LEleonnil1MAMatthewNoyce1

コメント