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

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

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

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

ヒント

PyTorch の要件はオペレーティングシステムや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環境を必要とせずに簡単な1行のコマンドを実行できます。CLIはカスタマイズやPythonコードを必要とせず、 yolo コマンドを使用してターミナルからすべてのタスクを実行します。コマンドラインからYOLOを使用する方法の詳細については、 CLIガイド を参照してください。

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

yolo TASK MODE ARGS

すべての ARGS は完全な 設定ガイド または yolo cfg CLIコマンドで確認できます。

警告

Arguments must be passed as arg=value pairs, split by an equals = sign and delimited by spaces. Do not use -- argument prefixes or commas , between arguments.

  • 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プロジェクトへのシームレスな統合を提供し、モデルのロード、実行、出力の処理を容易にします。シンプルさを重視して設計されたPythonインターフェースにより、ユーザーは 物体検出、セグメンテーション、分類を素早く実装できます。これにより、YOLO Pythonインターフェースは、これらの機能を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環境の場合は、ultralyticspytorchpytorch-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コードを使用せずにオブジェクト検出タスクの実行を簡素化し、トレーニング、検証、予測をターミナルから直接、単一行のコマンドで実行できるようにします。基本的な構文は次の通りです:

yolo TASK MODE ARGS

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

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

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

コメント