ultralytics/docs/en/integrations/vscode.md

comments	description	keywords
true	An overview of how the Ultralytics-Snippets extension for Visual Studio Code can help developers accelerate their work with the Ultralytics Python package.	Visual Studio Code, VS Code, deep learning, convolutional neural networks, computer vision, Python, code snippets, Ultralytics, developer productivity, machine learning, YOLO, developers, productivity, efficiency, learning, programming, IDE, code editor, developer utilities, programming tools

Ultralytics VS Code Extension

Run example code using Ultralytics YOLO in under 20 seconds! 🚀

Features and Benefits

✅ Are you a data scientist or machine learning engineer building computer vision applications with Ultralytics?

✅ Do you despise writing the same blocks of code repeatedly?

✅ Are you always forgetting the arguments or default values for the export, predict, train, track, or val methods?

✅ Looking to get started with Ultralytics and wish you had an easier way to reference or run code examples?

✅ Want to speed up your development cycle when working with Ultralytics?

If you use Visual Studio Code and answered 'yes' to any of the above, then the Ultralytics-snippets extension for VS Code is here to help! Read on to learn more about the extension, how to install it, and how to use it.

Inspired by the Ultralytics Community

The inspiration to build this extension came from the Ultralytics Community. Questions from the Community around similar topics and examples fueled the development for this project. Additionally, as some of the Ultralytics Team also uses VS Code, we also use it as a tool to accelerate our work too ⚡.

Why VS Code?

Visual Studio Code is extremely popular with developers worldwide and has ranked most popular by the Stack Overflow Developer Survey in 2021, 2022, 2023, and 2024. Due to VS Code's high level of customization, built-in features, broad compatibility, and extensibility, it's no surprise that so many developers are using it. Given the popularity in the wider developer community and within the Ultralytics Discord, Discourse, Reddit, and GitHub Communities, it made sense to build a VS Code extension to help streamline your workflow and boost your productivity.

Want to let us know what you use for developing code? Head over to our Discourse community poll and let us know! While you're there, maybe check out some of our favorite computer vision, machine learning, AI, and developer memes, or even post your favorite!

Installing the Extension

!!! Note

Any code environment that will allow for installing VS Code extensions _should be_ compatible with the Ultralytics-snippets extension. After publishing the extension, it was discovered that [neovim](https://neovim.io/) can be made compatible with VS Code extensions. To learn more see the [`neovim` install section][neovim install] of the Readme in the [Ultralytics-Snippets repository][repo].

Installing in VS Code

1. Navigate to the Extensions menu in VS Code or use the shortcut Ctrl+Shift ⇑+x, and search for Ultralytics-snippets.

2. Click the Install button.

Installing from the VS Code Extension Marketplace

1. Visit the VS Code Extension Marketplace and search for Ultralytics-snippets or go straight to the extension page on the VS Code marketplace.

2. Click the Install button and allow your browser to launch a VS Code session.

3. Follow any prompts to install the extension.

Visual Studio Code Extension Marketplace page for Ultralytics-Snippets

Using the Ultralytics-Snippets Extension

• 🧠 Intelligent Code Completion: Write code faster and more accurately with advanced code completion suggestions tailored to the Ultralytics API.

• ⌛ Increased Development Speed: Save time by eliminating repetitive coding tasks and leveraging pre-built code block snippets.

• 🔬 Improved Code Quality: Write cleaner, more consistent, and error-free code with intelligent code completion.

• 💎 Streamlined Workflow: Stay focused on the core logic of your project by automating common tasks.

Overview

The extension will only operate when the Language Mode is configured for Python 🐍. This is to avoid snippets from being inserted when working on any other file type. All snippets have prefix starting with ultra, and simply typing ultra in your editor after installing the extension, will display a list of possible snippets to use. You can also open the VS Code Command Palette using Ctrl+Shift ⇑+p and running the command Snippets: Insert Snippet.

Code Snippet Fields

Many snippets have "fields" with default placeholder values or names. For instance, output from the predict method could be saved to a Python variable named r, results, detections, preds or whatever else a developer chooses, which is why snippets include "fields". Using Tab ⇥ on your keyboard after a snippet is inserted, your cursor will move between fields quickly. Once a field is selected, typing a new variable name will change that instance, but also every other instance in the snippet code for that variable!

After inserting snippet, renaming model as world_model updates all instances. Pressing Tab ⇥ moves to the next field, which opens a dropdown menu and allows for selection of a model scale, and moving to the next field provides another dropdown to choose either world or worldv2 model variant.

Code Snippet Completions

!!! tip "Even Shorter Shortcuts"

It's **not** required to type the full prefix of the snippet, or even to start typing from the start of the snippet. See example in the image below.

The snippets are named in the most descriptive way possible, but this means there could be a lot to type and that would be counterproductive if the aim is to move faster. Luckily VS Code lets users type ultra.example-yolo-predict, example-yolo-predict, yolo-predict, or even ex-yolo-p and still reach the intended snippet option! If the intended snippet was actually ultra.example-yolo-predict-kwords, then just using your keyboard arrows ↑ or ↓ to highlight the desired snippet and pressing Enter ↵ or Tab ⇥ will insert the correct block of code.

Typing ex-yolo-p will still arrive at the correct snippet.

Snippet Categories

These are the current snippet categories available to the Ultralytics-snippets extension. More will be added in the future, so make sure to check for updates and to enable auto-updates for the extension. You can also request additional snippets to be added if you feel there's any missing.

Category	Starting Prefix	Description
Examples	ultra.examples	Example code to help learn or for getting started with Ultralytics. Examples are copies of or similar to code from documentation pages.
Kwargs	ultra.kwargs	Speed up development by adding snippets for train, track, predict, and val methods with all keyword arguments and default values.
Imports	ultra.imports	Snippets to quickly import common Ultralytics objects.
Models	ultra.yolo	Insert code blocks for initializing various models (yolo, sam, rtdetr, etc.), including dropdown configuration options.
Results	ultra.result	Code blocks for common operations when working with inference results.
Utilities	ultra.util	Provides quick access to common utilities that are built into the Ultralytics package, learn more about these on the Simple Utilities page.

Learning with Examples

The ultra.examples snippets are to useful for anyone looking to learn how to get started with the basics of working with Ultralytics YOLO. Example snippets are intended to run once inserted (some have dropdown options as well). An example of this is shown at the animation at the top of this page, where after the snippet is inserted, all code is selected and run interactively using Shift ⇑+Enter ↵.

!!! Example

Just like the animation shows at the [top] of this page, you can use the snippet `ultra.example-yolo-predict` to insert the following code example. Once inserted, the only configurable option is for the model scale which can be any one of: `n`, `s`, `m`, `l`, or `x`.

```python
from ultralytics import ASSETS, YOLO

model = YOLO("yolov8n.pt", task="detect")
results = model(source=ASSETS / "bus.jpg")

for result in results:
    print(result.boxes.data)
    # result.show()  # uncomment to view each result image
```

Accelerating Development

The aim for snippets other than the ultra.examples are for making development easier and quicker when working with Ultralytics. A common code block to be used in many projects, is to iterate the list of Results returned from using the model predict method. The ultra.result-loop snippet can help with this.

!!! Example

Using the `ultra.result-loop` will insert the following default code (including comments).

```python
# reference https://docs.ultralytics.com/modes/predict/#working-with-results

for result in results:
    result.boxes.data  # torch.Tensor array
```

However, since Ultralytics supports numerous tasks, when working with inference results there are other Results attributes that you may wish to access, which is where the snippet fields will be powerful.

Once tabbed to the boxes field, a dropdown menu appears to allow selection of another attribute as required.

Keywords Arguments

There are over 💯 keyword arguments for all of the various Ultralytics tasks and modes! That's a lot to remember and it can be easy to forget if the argument is save_frame or save_frames (it's definitely save_frames by the way). This is where the ultra.kwargs snippets can help out!

!!! Example

To insert the [predict] method, including all [inference arguments], use `ultra.kwargs-predict`, which will insert the following code (including comments).

```python
model.predict(
    source=src,  # (str, optional) source directory for images or videos
    imgsz=640,  # (int | list) input images size as int or list[w,h] for predict
    conf=0.25,  # (float) minimum confidence threshold
    iou=0.7,  # (float) intersection over union (IoU) threshold for NMS
    vid_stride=1,  # (int) video frame-rate stride
    stream_buffer=False,  # (bool) buffer all streaming frames (True) or return the most recent frame (False)
    visualize=False,  # (bool) visualize model features
    augment=False,  # (bool) apply image augmentation to prediction sources
    agnostic_nms=False,  # (bool) class-agnostic NMS
    classes=None,  # (int | list[int], optional) filter results by class, i.e. classes=0, or classes=[0,2,3]
    retina_masks=False,  # (bool) use high-resolution segmentation masks
    embed=None,  # (list[int], optional) return feature vectors/embeddings from given layers
    show=False,  # (bool) show predicted images and videos if environment allows
    save=True,  # (bool) save prediction results
    save_frames=False,  # (bool) save predicted individual video frames
    save_txt=False,  # (bool) save results as .txt file
    save_conf=False,  # (bool) save results with confidence scores
    save_crop=False,  # (bool) save cropped images with results
    stream=False,  # (bool) for processing long videos or numerous images with reduced memory usage by returning a generator
    verbose=True,  # (bool) enable/disable verbose inference logging in the terminal
)
```

This snippet has fields for all the keyword arguments, but also for `model` and `src` in case you've used a different variable in your code. On each line containing a keyword argument, a brief description is included for reference.

All Code Snippets

The best way to find out what snippets are available is to download and install the extension and try it out! If you're curious and want to take a look at the list beforehand, you can visit the repo or extension page on the VS Code marketplace to view the tables for all available snippets.

Conclusion

The Ultralytics-Snippets extension for VS Code is designed to empower data scientists and machine learning engineers to build computer vision applications using Ultralytics YOLO more efficiently. By providing pre-built code snippets and useful examples, we help you focus on what matters most: creating innovative solutions. Please share your feedback by visiting the extension page on the VS Code marketplace and leaving a review. ⭐

FAQ

How do I request a new snippet?

New snippets can be requested using the Issues on the Ultralytics-Snippets repo.

How much does the Ultralytics-Extension Cost?

It's 100% free!

Why don't I see a code snippet preview?

VS Code uses the key combination Ctrl+Space to show more/less information in the preview window. If you're not seeing a snippet preview when you type in a code snippet prefix, using this key combination should restore the preview.

How do I disable the extension recommendation in Ultralytics?

If you use VS Code and have started to see a message prompting you to install the Ultralytics-snippets extension, and don't want to see the message any more, there are two ways to disable this message.

1. Install Ultralytics-snippets and the message will no longer be shown 😆!

2. You can using yolo settings vscode_msg False to disable the message from showing without having to install the extension. You can learn more about the Ultralytics Settings on the quickstart page if you're unfamiliar.

I have an idea for a new Ultralytics code snippet, how can I get one added?

Visit the Ultralytics-snippets repo and open an Issue or Pull Request!

How do I uninstall the Ultralytics-Snippets Extension?

Like any other VS Code extension, you can uninstall it by navigating to the Extensions menu in VS Code. Find the Ultralytics-snippets extension in the menu and click the cog icon (⚙) and then click on "Uninstall" to remove the extension.