Начать

Расширение Ultralytics для VS Code



Смотри: Как использовать расширение Ultralytics для Visual Studio Code | Готовые фрагменты кода | Ultralytics YOLO 🎉

Возможности и преимущества#

✅ Ты специалист по данным или инженер по машинному обучению и создаешь приложения компьютерного зрения с Ultralytics?

✅ Надоело постоянно писать одни и те же фрагменты кода?

✅ Ты постоянно забываешь аргументы или значения по умолчанию для методов train, val, predict, export или track?

✅ Хочешь начать работать с Ultralytics и хотел бы найти более простой способ просматривать примеры кода или запускать их?

✅ Хочешь ускорить цикл разработки при работе с Ultralytics?

Если ты пользуешься Visual Studio Code и ответил «да» хотя бы на один из вопросов выше, тебе поможет расширение Ultralytics-snippets для VS Code. В разделах ниже рассказано, что делает расширение, как его установить и как им пользоваться.


Inserting and running an Ultralytics YOLO prediction snippet in VS Code
Запусти пример кода с Ultralytics YOLO менее чем за 20 секунд.

Вдохновлено сообществом Ultralytics#

Идея создать это расширение возникла благодаря сообществу Ultralytics. Вопросы сообщества на похожие темы и примеры вдохновили нас на разработку проекта. Кроме того, многие сотрудники Ultralytics используют VS Code в своей работе.

Почему VS Code?#

Visual Studio Code широко используется разработчиками по всему миру и занимал первое место по популярности в опросе разработчиков Stack Overflow в 2021, 2022, 2023 и 2024 годах. Своей популярностью он обязан широким возможностям настройки, встроенным функциям, совместимости и расширяемости. Учитывая его популярность в сообществе разработчиков и среди участников сообществ Ultralytics в Discord, Discourse, Reddit и GitHub, было вполне логично создать расширение для VS Code, которое поможет оптимизировать твой рабочий процесс.

Расскажи, какими инструментами ты пользуешься для разработки, проголосовав в опросе сообщества на Discourse.

Установка расширения#

Примечание

Любая среда разработки, в которой можно устанавливать расширения VS Code, должна быть совместима с расширением Ultralytics-snippets. Neovim также можно настроить для совместимости с расширениями VS Code.

Установка в VS Code#

  1. Открой меню Extensions в VS Code или воспользуйся сочетанием клавиш Ctrl+Shift ⇑+x, затем найди Ultralytics-snippets.

  2. Нажми кнопку Install.


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

Установка из магазина расширений VS Code#

  1. Открой магазин расширений VS Code и найди Ultralytics-snippets или сразу перейди на страницу расширения в магазине VS Code.

  2. Нажми кнопку Install и разреши браузеру запустить сеанс VS Code.

  3. Следуй инструкциям, чтобы установить расширение.


VS Code marketplace extension install
Страница Ultralytics-Snippets в каталоге расширений Visual Studio CodeUltralytics-Snippets

Использование расширения Ultralytics-Snippets#

  • Интеллектуальное автодополнение кода: пиши код быстрее и точнее благодаря продвинутым подсказкам автодополнения, адаптированным к API Ultralytics.

  • Ускорение разработки: экономь время, избавляясь от повторяющихся задач программирования с помощью готовых фрагментов кода.

  • Повышение качества кода: пиши более чистый и единообразный код с меньшим количеством ошибок.

  • Оптимизация рабочего процесса: сосредоточься на основной логике проекта, автоматизировав типовые задачи.

Обзор#

Расширение работает только тогда, когда для режима языка выбран Python. Это не позволяет вставлять фрагменты кода при работе с файлами других типов. Все фрагменты начинаются с префикса ultra; после установки расширения введи ultra в редакторе, чтобы увидеть список доступных фрагментов. Также можно открыть палитру команд VS Code сочетанием Ctrl+Shift ⇑+p и выполнить команду Snippets: Insert Snippet.

Поля фрагментов кода#

Во многих фрагментах есть «поля» со значениями или именами-заполнителями по умолчанию. Например, результат метода predict можно сохранить в переменную Python с именем r, results, detections, preds или любым другим именем на выбор разработчика — поэтому во фрагментах и предусмотрены «поля». После вставки фрагмента нажимай Tab ⇥ на клавиатуре, чтобы быстро перемещать курсор между полями. Выбрав поле, введи новое имя переменной: оно изменится в этом месте и во всех остальных вхождениях этой переменной во фрагменте кода!


Renaming a snippet field updates every instance and opens model scale and variant dropdowns
После вставки фрагмента переименование 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 ⇥, чтобы вставить правильный блок кода.


VS Code incomplete code snippet preview
Если ввести 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. Подробнее о них читай на странице простых утилит.

Обучение на примерах#

Фрагменты 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. Во многих проектах часто встречается блок кода, который перебирает список Results, возвращаемый методом predict модели. Для этого пригодится фрагмент 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. В этом помогут поля фрагментов.


VS Code YOLO results visualization options
После перехода клавишей Tab к полю 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) размер входных изображений: целое число или список [h,w] для predict
    conf=0.25,  # (float) минимальный порог уверенности
    iou=0.7,  # (float) порог пересечения над объединением (IoU) для NMS
    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 и изучи таблицы со всеми доступными фрагментами.

Заключение#

Расширение Ultralytics-Snippets для VS Code помогает специалистам по данным и инженерам по машинному обучению эффективнее создавать приложения компьютерного зрения с Ultralytics YOLO. Благодаря готовым фрагментам кода и примерам ты тратишь меньше времени на шаблонный код и больше — на логику проекта. Поделись отзывом: перейди на страницу расширения в магазине VS Code и оставь оценку.

Часто задаваемые вопросы#

  • Запросить новые фрагменты можно, создав Issue в репозитории Ultralytics-Snippets.

  • Расширение бесплатное.

  • В VS Code сочетание клавиш Ctrl+Space позволяет показывать больше или меньше информации в окне предварительного просмотра. Если при вводе префикса фрагмента кода предварительный просмотр не отображается, это сочетание клавиш должно восстановить его.

  • Если ты пользуешься VS Code и видишь сообщение с предложением установить расширение Ultralytics-snippets, но больше не хочешь его видеть, есть два способа отключить это сообщение.

    1. Установи Ultralytics-snippets, и это сообщение больше не будет отображаться.

    2. Ты можешь использовать yolo settings vscode_msg=False, чтобы отключить показ сообщения, не устанавливая расширение. Если тебе нужны подробности, загляни на страницу настроек Ultralytics.

  • Зайди в репозиторий Ultralytics-snippets и создай Issue или Pull Request!

  • Как и любое другое расширение VS Code, его можно удалить через меню Extensions в VS Code. Найди в меню расширение Ultralytics-snippets, нажми на значок шестерёнки (⚙), а затем выбери «Uninstall», чтобы удалить расширение.


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

Комментарии3

Задай вопрос, поделись результатами или помоги кому-нибудь.

  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