Ultralytics VS Code拡張機能
視聴: Ultralytics Visual Studio Code拡張機能の使用方法 | すぐに使えるコードスニペット | Ultralytics YOLO 🎉
機能とメリット#
✅ Ultralyticsを使ってコンピュータービジョンアプリケーションを開発しているデータサイエンティストまたは機械学習エンジニアですか?
✅ 同じコードブロックを何度も書くことにうんざりしていませんか?
✅ train、val、predict、export、trackメソッドの引数やデフォルト値をいつも忘れてしまいませんか?
✅ Ultralyticsを使い始めたいものの、コード例を参照したり実行したりするもっと簡単な方法があればと思いませんか?
✅ Ultralyticsを使った開発サイクルをスピードアップしたいですか?
Visual Studio Codeを使っていて、上記のいずれかに「はい」と答えた場合は、VS Code用のUltralytics-snippets拡張機能が役立ちます。以下のセクションでは、この拡張機能の機能、インストール方法、使い方を説明します。
Ultralytics YOLOのサンプルコードを20秒以内に実行できます。
Ultralyticsコミュニティから着想#
この拡張機能の開発は、Ultralytics Communityから着想を得ました。同様のトピックや例に関するCommunityからの質問が、このプロジェクトの開発を後押ししました。また、Ultralyticsチームの多くのメンバーが日々の業務でVS Codeを使用しています。
なぜVS Codeなのか?#
Visual Studio Codeは世界中の開発者に広く使用されており、Stack Overflow Developer Surveyで2021年、2022年、2023年、2024年に最も人気のある開発環境に選ばれました。その人気の理由は、高いカスタマイズ性、組み込み機能、幅広い互換性、拡張性にあります。開発者コミュニティ全体およびUltralyticsのDiscord、Discourse、Reddit、GitHubコミュニティでの人気を踏まえ、ワークフローの効率化に役立つVS Code拡張機能を開発するのは自然な選択でした。
コード開発に使用しているツールを共有するには、Discourseのコミュニティ投票にご参加ください。
拡張機能のインストール#
VS Code拡張機能をインストールできるコード環境であれば、Ultralytics-snippets拡張機能と互換性があるはずです。NeovimもVS Code拡張機能と互換性を持たせることができます。
VS Codeへのインストール#
-
VS Codeの拡張機能メニューを開くか、ショートカットCtrl+Shift ⇑+xを使用して、Ultralytics-snippetsを検索します。
-
Installボタンをクリックします。
VS Code Extension Marketplaceからインストールする#
-
VS Code Extension MarketplaceでUltralytics-snippetsを検索するか、VS Code Marketplaceの拡張機能ページに直接アクセスします。
-
Installボタンをクリックし、ブラウザーからVS Codeを起動できるようにします。
-
表示される指示に従って、拡張機能をインストールします。
Visual Studio Code拡張機能マーケットプレイスのUltralytics-Snippetsページ
Ultralytics-Snippets拡張機能の使い方#
-
インテリジェントなコード補完: Ultralytics APIに合わせた高度なコード補完候補を活用し、より速く正確にコードを記述できます。
-
開発速度の向上: 事前に用意されたコードブロックのスニペットを使い、繰り返しのコーディング作業をなくして時間を節約できます。
-
コード品質の向上: エラーを減らし、より読みやすく一貫性のあるコードを記述できます。
-
ワークフローの効率化: よくある作業を自動化し、プロジェクトの中核となるロジックに集中できます。
概要#
この拡張機能は、言語モードがPythonに設定されている場合にのみ動作します。これにより、他のファイル形式を編集しているときにスニペットが挿入されるのを防ぎます。すべてのスニペットにはultraで始まるプレフィックスがあります。拡張機能をインストールした後、エディターでultraと入力すると、使用可能なスニペットの一覧が表示されます。Ctrl+Shift ⇑+pを使ってVS Codeのコマンドパレットを開き、Snippets: Insert Snippetコマンドを実行することもできます。
コードスニペットのフィールド#
多くのスニペットには、デフォルトのプレースホルダー値や名前を持つ「フィールド」が含まれています。たとえば、predictメソッドの出力は、r、results、detections、predsなど、開発者が自由に選んだPython変数に保存できます。そのため、スニペットには「フィールド」が含まれています。スニペットを挿入した後にキーボードのTab ⇥を押すと、カーソルがフィールド間をすばやく移動します。フィールドを選択した状態で新しい変数名を入力すると、その箇所だけでなく、スニペット内の同じ変数のすべての箇所が変更されます。
スニペットを挿入した後、modelの名前をworld_modelに変更すると、すべての箇所が更新されます。Tab ⇥を押すと次のフィールドに移動し、ドロップダウンメニューが開いてモデルのスケールを選択できます。さらに次のフィールドに移動すると、別のドロップダウンが表示され、worldまたはworldv2のモデルバリアントを選択できます。
コードスニペットの補完#
スニペットのプレフィックスをすべて入力する必要はありません。また、スニペットの先頭から入力し始める必要もありません。下の画像の例をご覧ください。
スニペット名はできるだけ内容がわかりやすいものにしていますが、その分、入力に時間がかかり、作業を速めるという目的に反することもあります。幸い、VS Codeではultra.example-yolo-predict、example-yolo-predict、yolo-predict、さらにはex-yolo-pと入力しても、目的のスニペット候補にたどり着けます。目的のスニペットが実際にはultra.example-yolo-predict-kwordsの場合は、キーボードの矢印キー↑または↓で目的のスニペットを選択し、Enter ↵またはTab ⇥を押すと、正しいコードブロックが挿入されます。
ex-yolo-pと入力すると、それでも正しいスニペットが表示されます。
スニペットのカテゴリー#
以下は、Ultralytics-snippets拡張機能で現在利用できるスニペットのカテゴリです。今後さらに追加される予定ですので、更新を確認し、拡張機能の自動更新を有効にしてください。不足しているスニペットがあれば、追加をリクエストできます。
| カテゴリー | 開始プレフィックス | 説明 |
|---|---|---|
| 例 | ultra.examples | Ultralyticsの学習や使い始めに役立つコード例です。ドキュメントページのコードをそのまま、または一部変更して掲載しています。 |
| キーワード引数 | ultra.kwargs | train、val、predict、trackメソッドのすべてのキーワード引数とデフォルト値を含むスニペットを追加して、開発をスピードアップできます。 |
| インポート | ultra.imports | Ultralyticsでよく使われるオブジェクトをすばやくインポートするためのスニペットです。 |
| モデル | ultra.yolo | 各種モデル(yolo、sam、rtdetrなど)を初期化するコードブロックを、ドロップダウン形式の設定オプションとともに挿入します。 |
| 結果 | ultra.result | 推論結果の処理でよく使われる操作のコードブロックです。 |
| ユーティリティ | ultra.util | Ultralyticsパッケージに組み込まれている便利なユーティリティにすばやくアクセスできます。詳しくはSimple Utilitiesページをご覧ください。 |
例を使った学習#
ultra.examplesスニペットは、Ultralytics YOLOの基本的な使い方を学び始めたい方にとても役立ちます。サンプルスニペットは挿入後すぐに実行できるように設計されています(ドロップダウンオプションがあるものもあります)。このページの上部にあるアニメーションでは、スニペットを挿入するとコード全体が選択され、Shift ⇑+Enter ↵を使って対話的に実行される例を示しています。
このページの上部にあるアニメーションと同様に、ultra.example-yolo-predictスニペットを使って次のコード例を挿入できます。挿入後に設定できるのはモデルのスケールのみで、n、s、m、l、xのいずれかを指定できます。
from ultralytics import ASSETS, YOLO
model = YOLO("yolo26n.pt", task="detect")
results = model(source=ASSETS / "bus.jpg")
for result in results:
print(result.boxes.data)
# result.show() # 各結果画像を表示するにはコメントを解除します開発の加速#
ultra.examples以外のスニペットは、Ultralyticsを使用する際の開発をより簡単かつ迅速にすることを目的としています。多くのプロジェクトでは、モデルのpredictメソッドが返すResultsのリストを反復処理するコードブロックがよく使われます。この処理にはultra.result-loopスニペットが役立ちます。
ultra.result-loopを使うと、次のデフォルトコード(コメントを含む)が挿入されます。
# reference https://docs.ultralytics.com/modes/predict#working-with-results
for result in results:
result.boxes.data # torch.Tensor arrayただし、Ultralyticsは多数のタスクに対応しているため、推論結果を扱う際には、他のResults属性にもアクセスしたい場合があります。そのような場合にスニペットフィールドが便利です。
boxesフィールドに移動すると、必要に応じて別の属性を選択できるドロップダウンメニューが表示されます。
キーワード引数#
Ultralyticsのさまざまなタスクとモードには、100を超えるキーワード引数があります。すべてを覚えるのは大変で、引数がsave_frameなのかsave_framesなのか(正しくはsave_frames)を忘れがちです。そんなときにultra.kwargsスニペットが役立ちます。
すべての推論引数を含むpredictメソッドを挿入するには、ultra.kwargs-predictを使用します。次のコード(コメントを含む)が挿入されます。
model.predict(
source=src, # (str, optional) 画像または動画のソースディレクトリ
imgsz=640, # (int | list) predict用の入力画像サイズ。intまたはlist[h,w]
conf=0.25, # (float) 最小信頼度しきい値
iou=0.7, # (float) NMS用の交差領域と和集合の比率(IoU)しきい値
vid_stride=1, # (int) 動画のフレームレートのストライド
stream_buffer=False, # (bool) 入力フレームをキューにバッファリングする(True)か、最新のフレームのみを保持する(False)か
visualize=False, # (bool) クラスアクティベーションヒートマップを保存
augment=False, # (bool) 予測ソースに画像拡張を適用
agnostic_nms=False, # (bool) クラス非依存のNMS
classes=None, # (int | list[int], optional) クラスで結果をフィルタリングします。例: classes=0、またはclasses=[0,2,3]
retina_masks=False, # (bool) 高解像度のセグメンテーションマスクを使用
embed=None, # (list[int], optional) 指定したレイヤーから特徴ベクトル/埋め込みを返す
show=False, # (bool) 環境が対応している場合、予測した画像や動画を表示
save=True, # (bool) 予測結果を保存
save_frames=False, # (bool) 予測した動画の各フレームを保存
save_txt=False, # (bool) 結果を.txtファイルとして保存
save_conf=False, # (bool) 信頼度スコアとともに結果を保存
save_crop=False, # (bool) 結果を含む切り抜き画像を保存
stream=False, # (bool) ジェネレーターを返すことで、メモリ使用量を抑えながら長時間の動画や多数の画像を処理
verbose=True, # (bool) ターミナルでの詳細な推論ログを有効化/無効化
)このスニペットにはすべてのキーワード引数のフィールドに加えて、コード内で別の変数を使用している場合に備えてmodelとsrcのフィールドもあります。キーワード引数を含む各行には、参照用の簡単な説明が付いています。
すべてのコードスニペット#
利用可能なスニペットを確認するには、拡張機能をダウンロードしてインストールし、実際に試すのが最適です。事前に一覧を確認したい場合は、リポジトリまたはVS Code Marketplaceの拡張機能ページで、利用可能なすべてのスニペットの表をご覧ください。
結論#
VS Code用のUltralytics-Snippets拡張機能を使うと、データサイエンティストや機械学習エンジニアは、Ultralytics YOLOを使ったコンピュータービジョンアプリケーションをより効率的に開発できます。事前に用意されたコードスニペットとサンプルを活用すれば、定型コードの作成にかける時間を減らし、プロジェクトのロジックに集中できます。VS Codeマーケットプレイスの拡張機能ページにアクセスして、レビューを投稿し、ぜひご意見をお聞かせください。
よくある質問#
新しいスニペットは、Ultralytics-SnippetsのリポジトリでIssueを作成してリクエストできます。
この拡張機能は無料です。
VS Codeでは、プレビューウィンドウに表示する情報を増減するために、Ctrl+Spaceのキー操作を使用します。コードスニペットのプレフィックスを入力してもスニペットのプレビューが表示されない場合は、このキー操作でプレビューを再表示できます。
VS Codeを使用していて、Ultralytics-snippets拡張機能のインストールを促すメッセージが表示されるようになり、そのメッセージを今後表示したくない場合は、無効にする方法が2つあります。
-
Ultralytics-snippetsをインストールすると、このメッセージは表示されなくなります。
-
拡張機能をインストールせずに、
yolo settings vscode_msg=Falseを使用してメッセージが表示されないようにできます。詳しくは、Ultralyticsの設定ページをご覧ください。
-
Ultralytics-snippetsのリポジトリにアクセスして、IssueまたはPull Requestを作成してください!
他のVS Code拡張機能と同じように、VS Codeの拡張機能メニューからアンインストールできます。メニューでUltralytics-snippets拡張機能を見つけ、歯車アイコン(⚙)をクリックしてから「アンインストール」をクリックすると、拡張機能を削除できます。
コメント3
質問したり、結果を共有したり、ほかの人をサポートしたりできます。
Hugofox07
Hi, I'm new to YOLO, but I'd like to know how to program it directly from VS Code instead of Google Colab. Does anyone have any videos with simple examples of how to display an image, or even a video on YOLO detection? Thanks for the help.
Glenn JocherUltralyticsThanks for posting here—yes, you can run Ultralytics YOLO locally in VS Code; install the package, then use these minimal examples, and the VS Code Snippets extension lets you insert
ultra.example-yolo-predictto get a runnable template (the extension page linked above has a short walkthrough video); for setup see the Install Ultralytics guide and for options see the Predict mode guide.pip install ultralyticsfrom ultralytics import YOLO # Image model = YOLO("yolo11n.pt", task="detect") model.predict(source="path/to/image.jpg", show=True) # Video model.predict(source="path/to/video.mp4", show=True, save=True)See Install Ultralytics and the Predict mode guide; drop any follow-ups here so the team can see them.
1Hugofox07
Thanks very much , for your help. thanks dude.