Erste Schritte

Ultralytics-Erweiterung für VS Code



Ansehen: So verwendest du die Ultralytics-Erweiterung für Visual Studio Code | Sofort einsetzbare Code-Schnipsel | Ultralytics YOLO 🎉

Funktionen und Vorteile#

✅ Bist du Data Scientist oder Ingenieur für maschinelles Lernen und entwickelst Computer-Vision-Anwendungen mit Ultralytics?

✅ Hast du es satt, immer wieder dieselben Codeblöcke zu schreiben?

✅ Vergisst du ständig die Argumente oder Standardwerte der Methoden train, val, predict, export oder track?

✅ Möchtest du mit Ultralytics loslegen und wünschst dir eine einfachere Möglichkeit, auf Codebeispiele zuzugreifen oder sie auszuführen?

✅ Möchtest du deinen Entwicklungszyklus bei der Arbeit mit Ultralytics beschleunigen?

Wenn du Visual Studio Code verwendest und eine der obigen Fragen mit „Ja“ beantwortet hast, kann dir die Ultralytics-snippets-Erweiterung für VS Code helfen. In den folgenden Abschnitten erfährst du, was die Erweiterung macht, wie du sie installierst und wie du sie verwendest.


Inserting and running an Ultralytics YOLO prediction snippet in VS Code
Führe Beispielcode mit Ultralytics YOLO in weniger als 20 Sekunden aus.

Inspiriert von der Ultralytics-Community#

Die Inspiration für diese Erweiterung kam aus der Ultralytics Community. Fragen aus der Community zu ähnlichen Themen sowie Beispiele haben die Entwicklung dieses Projekts vorangetrieben. Außerdem verwenden viele Mitglieder des Ultralytics-Teams VS Code bei ihrer Arbeit.

Warum VS Code?#

Visual Studio Code wird von Entwicklern weltweit häufig verwendet und wurde in der Stack Overflow Developer Survey in den Jahren 2021, 2022, 2023 und 2024 als beliebtester Editor eingestuft. Seine Beliebtheit beruht auf den umfangreichen Anpassungsmöglichkeiten, den integrierten Funktionen, der breiten Kompatibilität und der Erweiterbarkeit. Angesichts seiner Beliebtheit in der Entwicklergemeinschaft insgesamt und in den Ultralytics-Communities auf Discord, Discourse, Reddit und GitHub lag es nahe, eine VS Code-Erweiterung zu entwickeln, die deinen Arbeitsablauf vereinfacht.

Stimme in der Community-Umfrage auf Discourse ab und teile mit, welche Tools du zum Entwickeln von Code verwendest.

Erweiterung installieren#

Hinweis

Jede Codeumgebung, in der sich VS-Code-Erweiterungen installieren lassen, sollte mit der Ultralytics-snippets-Erweiterung kompatibel sein. Auch Neovim lässt sich kompatibel machen mit VS-Code-Erweiterungen.

Installation in VS Code#

  1. Öffne das Erweiterungsmenü in VS Code oder verwende das Tastenkürzel Ctrl+Shift ⇑+x und suche nach Ultralytics-snippets.

  2. Klicke auf die Schaltfläche Install.


Ultralytics Snippets search result with Install button in the VS Code Extensions Marketplace panel

Installation über den VS-Code-Erweiterungsmarktplatz#

  1. Rufe den VS-Code-Erweiterungsmarktplatz auf und suche nach Ultralytics-snippets oder öffne direkt die Erweiterungsseite im VS-Code-Marktplatz.

  2. Klicke auf die Schaltfläche Install und erlaube deinem Browser, eine VS-Code-Sitzung zu starten.

  3. Folge den Anweisungen, um die Erweiterung zu installieren.


VS Code marketplace extension install
Marketplace-Seite der Visual Studio Code-Erweiterung für Ultralytics-Snippets

Die Erweiterung Ultralytics-Snippets verwenden#

  • Intelligente Codevervollständigung: Schreibe Code schneller und präziser mit erweiterten Vorschlägen zur Codevervollständigung, die auf die Ultralytics API zugeschnitten sind.

  • Schnellere Entwicklung: Spare Zeit, indem du wiederkehrende Programmieraufgaben mit vorgefertigten Codeblöcken vermeidest.

  • Bessere Codequalität: Schreibe übersichtlicheren und einheitlicheren Code mit weniger Fehlern.

  • Einfacherer Arbeitsablauf: Konzentriere dich auf die zentrale Logik deines Projekts, indem du häufige Aufgaben automatisierst.

Übersicht#

Die Erweiterung funktioniert nur, wenn der Sprachmodus auf Python eingestellt ist. So wird verhindert, dass Snippets bei der Arbeit mit anderen Dateitypen eingefügt werden. Alle Snippets haben ein Präfix, das mit ultra beginnt. Wenn du nach der Installation der Erweiterung ultra in deinem Editor eingibst, wird eine Liste verfügbarer Snippets angezeigt. Du kannst auch die VS Code-Befehlspalette mit Ctrl+Shift ⇑+p öffnen und den Befehl Snippets: Insert Snippet ausführen.

Felder in Code-Snippets#

Viele Snippets enthalten „Felder“ mit Platzhaltern oder Namen als Standardwerte. Zum Beispiel kann die Ausgabe der Methode predict in einer Python-Variablen namens r, results, detections, preds oder einem anderen vom Entwickler gewählten Namen gespeichert werden. Deshalb enthalten die Snippets „Felder“. Wenn du nach dem Einfügen eines Snippets auf deiner Tastatur Tab ⇥ drückst, springt der Cursor schnell zwischen den Feldern hin und her. Sobald ein Feld ausgewählt ist, ändert die Eingabe eines neuen Variablennamens diesen Namen an der ausgewählten Stelle und an allen weiteren Stellen im Snippet-Code, an denen die Variable vorkommt!


Renaming a snippet field updates every instance and opens model scale and variant dropdowns
Wenn du das Snippet einfügst, aktualisiert das Umbenennen von model in world_model alle Vorkommen. Drücke Tab ⇥, um zum nächsten Feld zu wechseln. Dort kannst du im Dropdown-Menü eine Modellgröße auswählen. Im nächsten Feld erscheint ein weiteres Dropdown-Menü, in dem du entweder die Modellvariante world oder worldv2 auswählen kannst.

Vervollständigungen für Code-Snippets#

Noch _kürzere_ Tastenkürzel

Du musst nicht das vollständige Präfix eines Snippets eingeben oder mit der Eingabe am Anfang des Präfixes beginnen. Das folgende Bild zeigt ein Beispiel.

Die Snippets sind so aussagekräftig wie möglich benannt. Dadurch kann die Eingabe jedoch lang werden, was dem Ziel, schneller zu arbeiten, entgegenwirken würde. Zum Glück kannst du in VS Code ultra.example-yolo-predict, example-yolo-predict, yolo-predict oder sogar ex-yolo-p eingeben und trotzdem das gewünschte Snippet finden! Wenn das gewünschte Snippet tatsächlich ultra.example-yolo-predict-kwords heißt, kannst du einfach mit den Pfeiltasten ↑ oder ↓ das gewünschte Snippet markieren und es mit Enter ↵ oder Tab ⇥ als Codeblock einfügen.


VS Code incomplete code snippet preview
Wenn du ex-yolo-p eingibst, findest du weiterhin das richtige Snippet.

Snippet-Kategorien#

Dies sind die aktuellen Snippet-Kategorien der Ultralytics-snippets-Erweiterung. Künftig kommen weitere hinzu. Suche daher regelmäßig nach Updates und aktiviere automatische Updates für die Erweiterung. Du kannst auch weitere Snippets anfordern, falls welche fehlen.

KategorieAnfangspräfixBeschreibung
Beispieleultra.examplesBeispielcode, der beim Lernen oder beim Einstieg in Ultralytics hilft. Die Beispiele sind Kopien von Code aus Dokumentationsseiten oder daran angelehnt.
Schlüsselwortargumenteultra.kwargsBeschleunige die Entwicklung mit Snippets für die Methoden train, val, predict und track, einschließlich aller Schlüsselwortargumente und Standardwerte.
Importeultra.importsSnippets zum schnellen Import gängiger Ultralytics-Objekte.
Modelleultra.yoloFüge Codeblöcke zum Initialisieren verschiedener Modelle (yolo, sam, rtdetr usw.) ein, einschließlich Konfigurationsoptionen in Dropdown-Menüs.
Ergebnisseultra.resultCodeblöcke für gängige Vorgänge beim Arbeiten mit Inferenz-Ergebnissen.
Hilfsfunktionenultra.utilBietet schnellen Zugriff auf gängige Hilfsfunktionen des Ultralytics-Pakets. Mehr dazu erfährst du auf der Seite Einfache Hilfsfunktionen.

Mit Beispielen lernen#

Die Snippets ultra.examples sind sehr nützlich, wenn du die Grundlagen der Arbeit mit Ultralytics YOLO kennenlernen möchtest. Die Beispiel-Snippets sind so gedacht, dass sie nach dem Einfügen ausgeführt werden können (einige bieten außerdem Dropdown-Optionen). Ein Beispiel dafür siehst du in der Animation am Anfang dieser Seite: Nach dem Einfügen des Snippets wird der gesamte Code ausgewählt und interaktiv mit Shift ⇑+Enter ↵ ausgeführt.

Beispiel

Wie in der Animation am Anfang dieser Seite gezeigt, kannst du mit dem Snippet ultra.example-yolo-predict das folgende Codebeispiel einfügen. Nach dem Einfügen lässt sich nur die Modellgröße konfigurieren. Zur Auswahl stehen n, s, m, l und 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()  # auskommentieren, um jedes Ergebnisbild anzuzeigen

Entwicklung beschleunigen#

Andere Snippets als ultra.examples sollen die Entwicklung mit Ultralytics einfacher und schneller machen. In vielen Projekten gibt es Codeblöcke, die die Liste der vom Modell zurückgegebenen Results durchlaufen. Diese Liste wird von der Methode predict zurückgegeben. Das Snippet ultra.result-loop kann dabei helfen.

Beispiel

Mit ultra.result-loop wird der folgende Standardcode einschließlich der Kommentare eingefügt.

# Referenz https://docs.ultralytics.com/modes/predict#working-with-results

for result in results:
    result.boxes.data  # torch.Tensor-Array

Da Ultralytics jedoch zahlreiche Aufgaben unterstützt, gibt es bei der Arbeit mit Inferenzergebnissen weitere Results-Attribute, auf die du möglicherweise zugreifen möchtest. Dabei helfen die Snippet-Felder.


VS Code YOLO results visualization options
Sobald du mit der Tabulatortaste zum Feld boxes wechselst, erscheint ein Dropdown-Menü, in dem du bei Bedarf ein anderes Attribut auswählen kannst.

Schlüsselwortargumente#

Für die verschiedenen Ultralytics-Aufgaben und Modi gibt es über 100 Schlüsselwortargumente! Das ist eine ganze Menge, und man kann leicht vergessen, ob das Argument save_frame oder save_frames lautet (es ist save_frames). Hier können die Snippets ultra.kwargs helfen!

Beispiel

Um die Methode predict einschließlich aller Inferenzargumente einzufügen, verwende ultra.kwargs-predict. Dadurch wird der folgende Code einschließlich der Kommentare eingefügt.

model.predict(
    source=src,  # (str, optional) Quellverzeichnis für Bilder oder Videos
    imgsz=640,  # (int | list) Größe der Eingabebilder als int oder als Liste [h,w] für die Vorhersage
    conf=0.25,  # (float) Mindest-Konfidenzschwellenwert
    iou=0.7,  # (float) Schwellenwert für intersection over union (IoU) bei NMS
    vid_stride=1,  # (int) Schrittweite der Videobildrate
    stream_buffer=False,  # (bool) Eingehende Einzelbilder in einer Warteschlange zwischenspeichern (True) oder nur das neueste Einzelbild behalten (False)
    visualize=False,  # (bool) Aktivierungskarten der Klassen speichern
    augment=False,  # (bool) Bildveränderung auf Vorhersagequellen anwenden
    agnostic_nms=False,  # (bool) Klassenunabhängige NMS
    classes=None,  # (int | list[int], optional) Ergebnisse nach Klasse filtern, z. B. classes=0 oder classes=[0,2,3]
    retina_masks=False,  # (bool) Segmentierungsmasken mit hoher Auflösung verwenden
    embed=None,  # (list[int], optional) Merkmalsvektoren/Einbettungen aus den angegebenen Schichten zurückgeben
    show=False,  # (bool) Vorhergesagte Bilder und Videos anzeigen, sofern die Umgebung dies zulässt
    save=True,  # (bool) Vorhersageergebnisse speichern
    save_frames=False,  # (bool) Einzelne vorhergesagte Videobilder speichern
    save_txt=False,  # (bool) Ergebnisse als .txt-Datei speichern
    save_conf=False,  # (bool) Ergebnisse mit Konfidenzwerten speichern
    save_crop=False,  # (bool) zugeschnittene Bilder mit Ergebnissen speichern
    stream=False,  # (bool) Lange Videos oder zahlreiche Bilder mit geringerem Speicherbedarf verarbeiten, indem ein Generator zurückgegeben wird
    verbose=True,  # (bool) Ausführliche Inferenzprotokollierung im Terminal aktivieren/deaktivieren
)

Dieses Snippet enthält Felder für alle Schlüsselwortargumente sowie für model und src, falls du in deinem Code eine andere Variable verwendet hast. In jeder Zeile mit einem Schlüsselwortargument findest du eine kurze Beschreibung als Referenz.

Alle Code-Snippets#

Am besten findest du heraus, welche Snippets verfügbar sind, indem du die Erweiterung herunterlädst, installierst und ausprobierst! Wenn du neugierig bist und dir die Liste vorab ansehen möchtest, findest du auf dem Repository oder der Erweiterungsseite im VS-Code-Marktplatz Tabellen mit allen verfügbaren Snippets.

Fazit#

Die Ultralytics-Snippets-Erweiterung für VS Code unterstützt Data Scientists und Ingenieure für maschinelles Lernen dabei, Computer-Vision-Anwendungen mit Ultralytics YOLO effizienter zu entwickeln. Dank vorgefertigter Code-Snippets und Beispiele verbringst du weniger Zeit mit Standardcode und mehr mit der Logik deines Projekts. Teile dein Feedback, indem du die Erweiterungsseite im VS Code Marketplace besuchst und eine Bewertung hinterlässt.

Häufig gestellte Fragen#

  • Du kannst neue Snippets über die Issues im Repository von Ultralytics-Snippets anfordern.

  • Die Erweiterung ist kostenlos.

  • VS Code verwendet die Tastenkombination Ctrl+Space, um im Vorschaufenster mehr oder weniger Informationen anzuzeigen. Wenn beim Eingeben eines Code-Snippet-Präfixes keine Vorschau angezeigt wird, sollte sich die Vorschau mit dieser Tastenkombination wieder einblenden lassen.

  • Wenn du VS Code verwendest und eine Meldung angezeigt wird, die dich zur Installation der Erweiterung Ultralytics-snippets auffordert, du diese Meldung aber nicht mehr sehen möchtest, gibt es zwei Möglichkeiten, sie zu deaktivieren.

    1. Installiere Ultralytics-snippets, dann wird diese Meldung nicht mehr angezeigt.

    2. Mit yolo settings vscode_msg=False kannst du die Meldung deaktivieren, ohne die Erweiterung installieren zu müssen. Weitere Informationen findest du auf der Seite Ultralytics-Einstellungen, falls du damit nicht vertraut bist.

  • Besuche das Repository von Ultralytics-snippets und eröffne ein Issue oder einen Pull Request!

  • Wie jede andere VS-Code-Erweiterung kannst du sie über das Menü „Erweiterungen“ in VS Code deinstallieren. Suche im Menü nach der Erweiterung Ultralytics-snippets, klicke auf das Zahnradsymbol (⚙) und anschließend auf „Deinstallieren“, um die Erweiterung zu entfernen.


    Uninstall option in the Ultralytics Snippets settings menu in the VS Code Extensions panel

Kommentare3

Stell eine Frage, teile deine Ergebnisse oder hilf jemand anderem.

  1. Hugofox07GitHub

    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.

    1. Glenn JocherUltralytics

      Thanks 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-predict to 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 ultralytics
      from 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.

      1