PyTorch HubからのYOLOv5のロード

📚 本ガイドでは、PyTorch Hub (https://pytorch.org/hub/ultralytics_yolov5) からYOLOv5 🚀 をロードする方法を説明します。

始める前に

Install requirements.txt in a Python>=3.8.0 environment, including PyTorch>=1.8. Models and datasets download automatically from the latest YOLOv5 release.

pip install -r https://raw.githubusercontent.com/ultralytics/yolov5/master/requirements.txt
ヒント

ultralytics/yolov5 をクローンする必要はありません。PyTorch Hubが自動的にコードを取得します。

PyTorch HubでYOLOv5をロードする

簡単な例

この例では、事前学習済みのYOLOv5sモデルをPyTorch Hubから model としてロードし、推論用に画像を渡しています。'yolov5s' は最も軽量で高速なYOLOv5モデルです。利用可能なすべてのモデルの詳細については、README を参照してください。

import torch

# Model
model = torch.hub.load("ultralytics/yolov5", "yolov5s")

# Image
im = "https://ultralytics.com/images/zidane.jpg"

# Inference
results = model(im)

results.pandas().xyxy[0]
#      xmin    ymin    xmax   ymax  confidence  class    name
# 0  749.50   43.50  1148.0  704.5    0.874023      0  person
# 1  433.50  433.50   517.5  714.5    0.687988     27     tie
# 2  114.75  195.75  1095.0  708.0    0.624512      0  person
# 3  986.00  304.00  1028.0  420.0    0.286865     27     tie

詳細な例

この例では、PIL および OpenCV 画像ソースを使用したバッチ推論を示しています。results はコンソールへの出力runs/hub への保存、サポートされている環境での画面表示が可能であり、テンソルまたは pandas データフレームとして返されます。

import cv2
import torch
from PIL import Image

# Model
model = torch.hub.load("ultralytics/yolov5", "yolov5s")

# Images
for f in "zidane.jpg", "bus.jpg":
    torch.hub.download_url_to_file("https://ultralytics.com/images/" + f, f)  # download 2 images
im1 = Image.open("zidane.jpg")  # PIL image
im2 = cv2.imread("bus.jpg")[..., ::-1]  # OpenCV image (BGR to RGB)

# Inference
results = model([im1, im2], size=640)  # batch of images

# Results
results.print()
results.save()  # or .show()

results.xyxy[0]  # im1 predictions (tensor)
results.pandas().xyxy[0]  # im1 predictions (pandas)
#      xmin    ymin    xmax   ymax  confidence  class    name
# 0  749.50   43.50  1148.0  704.5    0.874023      0  person
# 1  433.50  433.50   517.5  714.5    0.687988     27     tie
# 2  114.75  195.75  1095.0  708.0    0.624512      0  person
# 3  986.00  304.00  1028.0  420.0    0.286865     27     tie
YOLO inference results on zidane.jpg YOLO inference results on bus.jpg

すべての推論オプションについては、YOLOv5 AutoShape() forward メソッドを参照してください。

推論設定

YOLOv5モデルには、信頼度しきい値(confidence threshold)、**IoUしきい値(IoU threshold)**などのさまざまな推論属性が含まれており、以下のように設定できます:

model.conf = 0.25  # NMS confidence threshold
model.iou = 0.45  # NMS IoU threshold
model.agnostic = False  # NMS class-agnostic
model.multi_label = False  # NMS multiple labels per box
model.classes = None  # (optional list) filter by class, i.e. = [0, 15, 16] for COCO persons, cats and dogs
model.max_det = 1000  # maximum number of detections per image
model.amp = False  # Automatic Mixed Precision (AMP) inference

results = model(im, size=320)  # custom inference size

デバイス

モデルは作成後に任意のデバイスへ転送できます:

model.cpu()  # CPU
model.cuda()  # GPU
model.to(device)  # i.e. device=torch.device(0)

モデルは任意の device 上で直接作成することも可能です:

model = torch.hub.load("ultralytics/yolov5", "yolov5s", device="cpu")  # load on CPU
ヒント

入力画像は、推論前に正しいモデルデバイスへ自動的に転送されます。

出力をサイレントにする

モデルは _verbose=False を指定することで、出力を抑えてロードできます:

model = torch.hub.load("ultralytics/yolov5", "yolov5s", _verbose=False)  # load silently

入力チャネル

デフォルトの3ではなく4つの入力チャネルで事前学習済みYOLOv5sモデルをロードするには:

model = torch.hub.load("ultralytics/yolov5", "yolov5s", channels=4)

この場合、モデルは最初の入力層以外は事前学習済みの重みで構成されます。入力層は事前学習済みのものと形状が異なるため、ランダムな重みで初期化された状態のままになります。

クラス数

デフォルトの80ではなく10の出力クラスで事前学習済みYOLOv5sモデルをロードするには:

model = torch.hub.load("ultralytics/yolov5", "yolov5s", classes=10)

この場合、モデルは出力層以外は事前学習済みの重みで構成されます。出力層は事前学習済みのものと形状が異なるため、ランダムな重みで初期化された状態のままになります。

強制リロード

上記の手順で問題が発生した場合は、force_reload=True を設定すると、既存のキャッシュを破棄してPyTorch Hubから最新のYOLOv5バージョンを強制的に再ダウンロードできるため、解決する可能性があります。キャッシュされたコピーは ~/.cache/torch/hub に保存されており、そのフォルダーを削除しても同じ効果が得られます。

model = torch.hub.load("ultralytics/yolov5", "yolov5s", force_reload=True)  # force reload

スクリーンショット推論

デスクトップ画面で推論を実行するには:

import torch
from PIL import ImageGrab

# Model
model = torch.hub.load("ultralytics/yolov5", "yolov5s")

# Image
im = ImageGrab.grab()  # take a screenshot

# Inference
results = model(im)

マルチGPU推論

YOLOv5モデルは、スレッド推論を使用して複数のGPUに並列でロードできます:

import threading

import torch

def run(model, im):
    """Performs inference on an image using a given model and saves the output; model must support `.save()` method."""
    results = model(im)
    results.save()

# Models
model0 = torch.hub.load("ultralytics/yolov5", "yolov5s", device=0)
model1 = torch.hub.load("ultralytics/yolov5", "yolov5s", device=1)

# Inference
threading.Thread(target=run, args=[model0, "https://ultralytics.com/images/zidane.jpg"], daemon=True).start()
threading.Thread(target=run, args=[model1, "https://ultralytics.com/images/bus.jpg"], daemon=True).start()

学習

推論ではなくトレーニング用にYOLOv5モデルをロードする場合は、autoshape=False を設定してください。ランダムに初期化された重みでモデルをロードする(ゼロからトレーニングする)には pretrained=False を使用します。この場合、独自のトレーニングスクリプトを提供する必要があります。あるいは、モデルトレーニングについては、YOLOv5 カスタムデータ学習チュートリアルを参照してください。

import torch

model = torch.hub.load("ultralytics/yolov5", "yolov5s", autoshape=False)  # load pretrained
model = torch.hub.load("ultralytics/yolov5", "yolov5s", autoshape=False, pretrained=False)  # load scratch

Base64結果

APIサービスで使用する場合。詳細は Flask REST API の例を参照してください。

import base64
from io import BytesIO

from PIL import Image

results = model(im)  # inference

results.ims  # array of original images (as np array) passed to model for inference
results.render()  # updates results.ims with boxes and labels
for im in results.ims:
    buffered = BytesIO()
    im_base64 = Image.fromarray(im)
    im_base64.save(buffered, format="JPEG")
    print(base64.b64encode(buffered.getvalue()).decode("utf-8"))  # base64 encoded image with results

クロップされた結果

結果は検出クロップとして取得および保存できます:

results = model(im)  # inference
crops = results.crop(save=True)  # cropped detections dictionary

Pandasの結果

結果は Pandas DataFrames として取得できます:

results = model(im)  # inference
results.pandas().xyxy[0]  # Pandas DataFrame
Pandas Output (click to expand)
print(results.pandas().xyxy[0])
#      xmin    ymin    xmax   ymax  confidence  class    name
# 0  749.50   43.50  1148.0  704.5    0.874023      0  person
# 1  433.50  433.50   517.5  714.5    0.687988     27     tie
# 2  114.75  195.75  1095.0  708.0    0.624512      0  person
# 3  986.00  304.00  1028.0  420.0    0.286865     27     tie

並び替えられた結果

結果は列ごとに並び替えることができます。例えば、ナンバープレートの数字検出を左から右へ(x軸)並び替えるには:

results = model(im)  # inference
results.pandas().xyxy[0].sort_values("xmin")  # sorted left-right

JSONの結果

結果は .pandas() データフレームに変換した後、.to_json() メソッドを使用してJSON形式で取得できます。JSON形式は orient 引数を使用して変更可能です。詳細については pandas の .to_json() ドキュメント を参照してください。

results = model(ims)  # inference
results.pandas().xyxy[0].to_json(orient="records")  # JSON img1 predictions
JSON Output (click to expand)
[
    {
        "xmin": 749.5,
        "ymin": 43.5,
        "xmax": 1148.0,
        "ymax": 704.5,
        "confidence": 0.8740234375,
        "class": 0,
        "name": "person"
    },
    {
        "xmin": 433.5,
        "ymin": 433.5,
        "xmax": 517.5,
        "ymax": 714.5,
        "confidence": 0.6879882812,
        "class": 27,
        "name": "tie"
    },
    {
        "xmin": 115.25,
        "ymin": 195.75,
        "xmax": 1096.0,
        "ymax": 708.0,
        "confidence": 0.6254882812,
        "class": 0,
        "name": "person"
    },
    {
        "xmin": 986.0,
        "ymin": 304.0,
        "xmax": 1028.0,
        "ymax": 420.0,
        "confidence": 0.2873535156,
        "class": 27,
        "name": "tie"
    }
]

カスタムモデル

この例では、カスタムの20クラス VOC 学習済みYOLOv5sモデル 'best.pt' をPyTorch Hubでロードします。

import torch

model = torch.hub.load("ultralytics/yolov5", "custom", path="path/to/best.pt")  # local model
model = torch.hub.load("path/to/yolov5", "custom", path="path/to/best.pt", source="local")  # local repo

TensorRT、ONNX、OpenVINOモデル

PyTorch Hubは、カスタム学習済みモデルを含むほとんどのYOLOv5エクスポート形式での推論をサポートしています。モデルのエクスポートに関する詳細については、TFLite、ONNX、CoreML、TensorRTエクスポートチュートリアルを参照してください。

ヒント
  • TensorRT は、GPUベンチマークにおいてPyTorchより2〜5倍高速になる場合があります。
  • ONNX および OpenVINO は、CPUベンチマークにおいてPyTorchより2〜3倍高速になる場合があります。
import torch

model = torch.hub.load("ultralytics/yolov5", "custom", path="yolov5s.pt")  # PyTorch
model = torch.hub.load("ultralytics/yolov5", "custom", path="yolov5s.torchscript")  # TorchScript
model = torch.hub.load("ultralytics/yolov5", "custom", path="yolov5s.onnx")  # ONNX
model = torch.hub.load("ultralytics/yolov5", "custom", path="yolov5s_openvino_model/")  # OpenVINO
model = torch.hub.load("ultralytics/yolov5", "custom", path="yolov5s.engine")  # TensorRT
model = torch.hub.load("ultralytics/yolov5", "custom", path="yolov5s.mlmodel")  # CoreML (macOS-only)
model = torch.hub.load("ultralytics/yolov5", "custom", path="yolov5s.tflite")  # TFLite
model = torch.hub.load("ultralytics/yolov5", "custom", path="yolov5s_paddle_model/")  # PaddlePaddle

サポートされている環境

Ultralyticsは、プロジェクトを迅速に開始できるよう、CUDACUDNNPythonPyTorch といった必須の依存関係がプリインストールされた、すぐに使える環境を幅広く提供しています。

プロジェクトステータス

YOLOv5 CI

このバッジは、すべてのYOLOv5 GitHub Actions継続的インテグレーション(CI)テストが正常に通過していることを示しています。これらのCIテストは、学習検証推論エクスポート、およびベンチマークといったYOLOv5のさまざまな主要な側面について、機能とパフォーマンスを厳密にチェックします。macOS、Windows、Ubuntuにおいて一貫した信頼性の高い動作を保証しており、テストは24時間ごとおよび新しいコミットごとに実施されます。

コメント