diff --git a/.github/workflows/greetings.yml b/.github/workflows/greetings.yml
index a8f815c23..19b099ebc 100644
--- a/.github/workflows/greetings.yml
+++ b/.github/workflows/greetings.yml
@@ -33,7 +33,7 @@ jobs:
If this is a custom training ❓ Question, please provide as much information as possible, including dataset image examples and training logs, and verify you are following our [Tips for Best Training Results](https://docs.ultralytics.com/guides/model-training-tips/).
Join the Ultralytics community where it suits you best. For real-time chat, head to [Discord](https://ultralytics.com/discord) 🎧. Prefer in-depth discussions? Check out [Discourse](https://community.ultralytics.com). Or dive into threads on our [Subreddit](https://reddit.com/r/ultralytics) to share knowledge with the community.
-
+
## Install
Pip install the `ultralytics` package including all [requirements](https://github.com/ultralytics/ultralytics/blob/main/pyproject.toml) in a [**Python>=3.8**](https://www.python.org/) environment with [**PyTorch>=1.8**](https://pytorch.org/get-started/locally/).
diff --git a/.github/workflows/merge-main-into-prs.yml b/.github/workflows/merge-main-into-prs.yml
index 328775a22..438967a96 100644
--- a/.github/workflows/merge-main-into-prs.yml
+++ b/.github/workflows/merge-main-into-prs.yml
@@ -35,7 +35,7 @@ jobs:
g = Github(os.getenv('GITHUB_TOKEN'))
repo = g.get_repo(os.getenv('GITHUB_REPOSITORY'))
-
+
# Fetch the default branch name
default_branch_name = repo.default_branch
default_branch = repo.get_branch(default_branch_name)
@@ -44,7 +44,7 @@ jobs:
updated_branches = 0
up_to_date_branches = 0
errors = 0
-
+
for pr in repo.get_pulls(state='open', sort='created'):
try:
# Label PRs as popular for positive reactions
diff --git a/README.md b/README.md
index 975d3673f..0505701dd 100644
--- a/README.md
+++ b/README.md
@@ -12,6 +12,7 @@
+
diff --git a/README.zh-CN.md b/README.zh-CN.md
index f719f7133..efa08597f 100644
--- a/README.zh-CN.md
+++ b/README.zh-CN.md
@@ -12,6 +12,7 @@
+
diff --git a/docs/README.md b/docs/README.md
index e983bac1b..565a00105 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -9,8 +9,8 @@
[![Check Broken links](https://github.com/ultralytics/docs/actions/workflows/links.yml/badge.svg)](https://github.com/ultralytics/docs/actions/workflows/links.yml)
[![Check Domains](https://github.com/ultralytics/docs/actions/workflows/check_domains.yml/badge.svg)](https://github.com/ultralytics/docs/actions/workflows/check_domains.yml)
[![Ultralytics Actions](https://github.com/ultralytics/docs/actions/workflows/format.yml/badge.svg)](https://github.com/ultralytics/docs/actions/workflows/format.yml)
-[![Discord](https://img.shields.io/discord/1089800235347353640?logo=discord&logoColor=white&label=Discord&color=blue)](https://ultralytics.com/discord)
-[![Forums](https://img.shields.io/discourse/users?server=https%3A%2F%2Fcommunity.ultralytics.com&logo=discourse&label=Forums&color=blue)](https://community.ultralytics.com)
+
+
## 🛠️ Installation
diff --git a/docs/en/hub/index.md b/docs/en/hub/index.md
index dbd583781..17a1333f5 100644
--- a/docs/en/hub/index.md
+++ b/docs/en/hub/index.md
@@ -22,7 +22,7 @@ keywords: Ultralytics HUB, YOLO models, train YOLO, YOLOv5, YOLOv8, object detec
-
+
diff --git a/docs/en/index.md b/docs/en/index.md
index 33e787104..10baa4956 100644
--- a/docs/en/index.md
+++ b/docs/en/index.md
@@ -24,6 +24,7 @@ keywords: Ultralytics, YOLOv8, object detection, image segmentation, deep learni
+
diff --git a/docs/en/integrations/index.md b/docs/en/integrations/index.md
index 342cda063..5f8146456 100644
--- a/docs/en/integrations/index.md
+++ b/docs/en/integrations/index.md
@@ -87,6 +87,8 @@ Welcome to the Ultralytics Integrations page! This page provides an overview of
- [NCNN](ncnn.md): Developed by [Tencent](http://www.tencent.com/), NCNN is an efficient neural network inference framework tailored for mobile devices. It enables direct deployment of AI models into apps, optimizing performance across various mobile platforms.
+- [VS Code](vscode.md): An extension for VS Code that provides code snippets for accelerating development workflows with Ultralytics and also for anyone looking for examples to help learn or get started with Ultralytics.
+
### Export Formats
We also support a variety of model export formats for deployment in different environments. Here are the available formats:
diff --git a/docs/en/integrations/vscode.md b/docs/en/integrations/vscode.md
new file mode 100644
index 000000000..9f158faf4
--- /dev/null
+++ b/docs/en/integrations/vscode.md
@@ -0,0 +1,276 @@
+---
+comments: true
+description: An overview of how the Ultralytics-Snippets extension for Visual Studio Code can help developers accelerate their work with the Ultralytics Python package.
+keywords: 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](https://code.visualstudio.com/) 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](https://code.visualstudio.com/docs/editor/extension-marketplace) 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](https://marketplace.visualstudio.com/VSCode) 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](https://code.visualstudio.com/docs/getstarted/tips-and-tricks#_change-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](https://code.visualstudio.com/docs/getstarted/userinterface#_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](#how-do-i-request-a-new-snippet) 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](#code-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.
+
+
+
+
+
+
+
+
+
+[top]: #ultralytics-vs-code-extension
+[export]: ../modes/export.md
+[predict]: ../modes/predict.md
+[track]: ../modes/track.md
+[train]: ../modes/train.md
+[val]: ../modes/val.md
+[tasks]: ../tasks/index.md
+[modes]: ../modes/index.md
+[models]: ../models/index.md
+[working with inference results]: ../modes/predict.md#working-with-results
+[inference arguments]: ../modes/predict.md#inference-arguments
+[Simple Utilities page]: ../usage/simple-utilities.md
+[Ultralytics Settings]: ../quickstart.md/#ultralytics-settings
+[quickstart]: ../quickstart.md
+[Discord]: https://ultralytics.com/discord
+[Discourse]: https://community.ultralytics.com
+[Reddit]: https://reddit.com/r/Ultralytics
+[GitHub]: https://github.com/ultralytics
+[community poll]: https://community.ultralytics.com/t/what-do-you-use-to-write-code/89/1
+[memes]: https://community.ultralytics.com/c/off-topic/memes-jokes/11
+[repo]: https://github.com/Burhan-Q/ultralytics-snippets
+[extension page on the VS Code marketplace]: https://marketplace.visualstudio.com/items?itemName=Ultralytics.ultralytics-snippets
+[neovim install]: https://github.com/Burhan-Q/ultralytics-snippets?tab=readme-ov-file#use-with-neovim
+[2021]: https://survey.stackoverflow.co/2021#section-most-popular-technologies-integrated-development-environment
+[2022]: https://survey.stackoverflow.co/2022/#section-most-popular-technologies-integrated-development-environment
+[2023]: https://survey.stackoverflow.co/2023/#section-most-popular-technologies-integrated-development-environment
+[2024]: https://survey.stackoverflow.co/2024/technology/#1-integrated-development-environment
diff --git a/docs/en/quickstart.md b/docs/en/quickstart.md
index 6a5a21dba..424732815 100644
--- a/docs/en/quickstart.md
+++ b/docs/en/quickstart.md
@@ -321,24 +321,25 @@ Ultralytics allows users to easily modify their settings. Changes can be perform
The table below provides an overview of the settings available for adjustment within Ultralytics. Each setting is outlined along with an example value, the data type, and a brief description.
-| Name | Example Value | Data Type | Description |
-| ------------------ | --------------------- | --------- | ---------------------------------------------------------------------------------------------------------------- |
-| `settings_version` | `'0.0.4'` | `str` | Ultralytics _settings_ version (different from Ultralytics [pip](https://pypi.org/project/ultralytics/) version) |
-| `datasets_dir` | `'/path/to/datasets'` | `str` | The directory where the datasets are stored |
-| `weights_dir` | `'/path/to/weights'` | `str` | The directory where the model weights are stored |
-| `runs_dir` | `'/path/to/runs'` | `str` | The directory where the experiment runs are stored |
-| `uuid` | `'a1b2c3d4'` | `str` | The unique identifier for the current settings |
-| `sync` | `True` | `bool` | Whether to sync analytics and crashes to HUB |
-| `api_key` | `''` | `str` | Ultralytics HUB [API Key](https://hub.ultralytics.com/settings?tab=api+keys) |
-| `clearml` | `True` | `bool` | Whether to use ClearML logging |
-| `comet` | `True` | `bool` | Whether to use [Comet ML](https://bit.ly/yolov8-readme-comet) for experiment tracking and visualization |
-| `dvc` | `True` | `bool` | Whether to use [DVC for experiment tracking](https://dvc.org/doc/dvclive/ml-frameworks/yolo) and version control |
-| `hub` | `True` | `bool` | Whether to use [Ultralytics HUB](https://hub.ultralytics.com) integration |
-| `mlflow` | `True` | `bool` | Whether to use MLFlow for experiment tracking |
-| `neptune` | `True` | `bool` | Whether to use Neptune for experiment tracking |
-| `raytune` | `True` | `bool` | Whether to use Ray Tune for hyperparameter tuning |
-| `tensorboard` | `True` | `bool` | Whether to use TensorBoard for visualization |
-| `wandb` | `True` | `bool` | Whether to use Weights & Biases logging |
+| Name | Example Value | Data Type | Description |
+| ------------------ | --------------------- | --------- | -------------------------------------------------------------------------------------------- |
+| `settings_version` | `'0.0.4'` | `str` | Ultralytics _settings_ version (different from Ultralytics [pip] version) |
+| `datasets_dir` | `'/path/to/datasets'` | `str` | The directory where the datasets are stored |
+| `weights_dir` | `'/path/to/weights'` | `str` | The directory where the model weights are stored |
+| `runs_dir` | `'/path/to/runs'` | `str` | The directory where the experiment runs are stored |
+| `uuid` | `'a1b2c3d4'` | `str` | The unique identifier for the current settings |
+| `sync` | `True` | `bool` | Whether to sync analytics and crashes to HUB |
+| `api_key` | `''` | `str` | Ultralytics HUB [API Key] |
+| `clearml` | `True` | `bool` | Whether to use [ClearML] logging |
+| `comet` | `True` | `bool` | Whether to use [Comet ML] for experiment tracking and visualization |
+| `dvc` | `True` | `bool` | Whether to use [DVC for experiment tracking] and version control |
+| `hub` | `True` | `bool` | Whether to use [Ultralytics HUB] integration |
+| `mlflow` | `True` | `bool` | Whether to use [MLFlow] for experiment tracking |
+| `neptune` | `True` | `bool` | Whether to use [Neptune] for experiment tracking |
+| `raytune` | `True` | `bool` | Whether to use [Ray Tune] for hyperparameter tuning |
+| `tensorboard` | `True` | `bool` | Whether to use [TensorBoard] for visualization |
+| `wandb` | `True` | `bool` | Whether to use [Weights & Biases] logging |
+| `vscode_msg` | `True` | `bool` | When VS Code terminal detected, enables prompt to download [Ultralytics-Snippets] extension. |
As you navigate through your projects or experiments, be sure to revisit these settings to ensure that they are optimally configured for your needs.
@@ -424,3 +425,19 @@ yolo train data=coco8.yaml model=yolov8n.pt epochs=10 lr0=0.01
```
Check out the full [CLI Guide](usage/cli.md) to explore more commands and usage examples.
+
+
+
+[Ultralytics HUB]: https://hub.ultralytics.com
+[API Key]: https://hub.ultralytics.com/settings?tab=api+keys
+[pip]: https://pypi.org/project/ultralytics/
+[DVC for experiment tracking]: https://dvc.org/doc/dvclive/ml-frameworks/yolo
+[Comet ML]: https://bit.ly/yolov8-readme-comet
+[Ultralytics HUB]: https://hub.ultralytics.com
+[ClearML]: ./integrations/clearml.md
+[MLFlow]: ./integrations/mlflow.md
+[Neptune]: https://neptune.ai/
+[Tensorboard]: ./integrations/tensorboard.md
+[Ray Tune]: ./integrations/ray-tune.md
+[Weights & Biases]: ./integrations/weights-biases.md
+[Ultralytics-Snippets]: ./integrations/vscode.md
diff --git a/docs/en/reference/utils/__init__.md b/docs/en/reference/utils/__init__.md
index 264f2e504..380daaecc 100644
--- a/docs/en/reference/utils/__init__.md
+++ b/docs/en/reference/utils/__init__.md
@@ -169,4 +169,8 @@ keywords: Ultralytics, utils, TQDM, Python, ML, Machine Learning utilities, YOLO
## ::: ultralytics.utils.url2file
+
+
+## ::: ultralytics.utils.vscode_msg
+
diff --git a/examples/hub.ipynb b/examples/hub.ipynb
index fc8daa317..ee6f3cae6 100644
--- a/examples/hub.ipynb
+++ b/examples/hub.ipynb
@@ -13,11 +13,12 @@
"\n",
"[中文](https://docs.ultralytics.com/zh/hub/) | [한국어](https://docs.ultralytics.com/ko/hub/) | [日本語](https://docs.ultralytics.com/ja/hub/) | [Русский](https://docs.ultralytics.com/ru/hub/) | [Deutsch](https://docs.ultralytics.com/de/hub/) | [Français](https://docs.ultralytics.com/fr/hub/) | [Español](https://docs.ultralytics.com/es/hub/) | [Português](https://docs.ultralytics.com/pt/hub/) | [Türkçe](https://docs.ultralytics.com/tr/hub/) | [Tiếng Việt](https://docs.ultralytics.com/vi/hub/) | [العربية](https://docs.ultralytics.com/ar/hub/)\n",
"\n",
- " \n",
- " \n",
- " \n",
- " \n",
+ " \n",
+ " \n",
+ "\n",
" \n",
+ " \n",
+ " \n",
"\n",
"Welcome to the [Ultralytics](https://ultralytics.com/) HUB notebook!\n",
"\n",
diff --git a/examples/tutorial.ipynb b/examples/tutorial.ipynb
index 649369c38..c83558cc1 100644
--- a/examples/tutorial.ipynb
+++ b/examples/tutorial.ipynb
@@ -31,7 +31,10 @@
" \n",
" \n",
" \n",
+ "\n",
" \n",
+ " \n",
+ " \n",
"\n",
"Welcome to the Ultralytics YOLOv8 🚀 notebook! YOLOv8 is the latest version of the YOLO (You Only Look Once) AI models developed by Ultralytics. This notebook serves as the starting point for exploring the various resources available to help you get started with YOLOv8 and understand its features and capabilities.\n",
"\n",
diff --git a/mkdocs.yml b/mkdocs.yml
index 151c92698..e97b3fc1a 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -405,6 +405,7 @@ nav:
- Kaggle: integrations/kaggle.md
- JupyterLab: integrations/jupyterlab.md
- IBM Watsonx: integrations/ibm-watsonx.md
+ - VS Code: integrations/vscode.md
- HUB:
- hub/index.md
- Web:
diff --git a/ultralytics/cfg/__init__.py b/ultralytics/cfg/__init__.py
index 98db96b17..2f89c7dc6 100644
--- a/ultralytics/cfg/__init__.py
+++ b/ultralytics/cfg/__init__.py
@@ -13,6 +13,7 @@ from ultralytics.utils import (
DEFAULT_CFG,
DEFAULT_CFG_DICT,
DEFAULT_CFG_PATH,
+ IS_VSCODE,
LOGGER,
RANK,
ROOT,
@@ -25,6 +26,7 @@ from ultralytics.utils import (
checks,
colorstr,
deprecation_warn,
+ vscode_msg,
yaml_load,
yaml_print,
)
@@ -834,6 +836,10 @@ def entrypoint(debug=""):
# Show help
LOGGER.info(f"💡 Learn more at https://docs.ultralytics.com/modes/{mode}")
+ # Recommend VS Code extension
+ if IS_VSCODE and SETTINGS.get("vscode_msg", True):
+ LOGGER.info(vscode_msg())
+
# Special modes --------------------------------------------------------------------------------------------------------
def copy_default_cfg():
diff --git a/ultralytics/utils/__init__.py b/ultralytics/utils/__init__.py
index c195b862a..616639abb 100644
--- a/ultralytics/utils/__init__.py
+++ b/ultralytics/utils/__init__.py
@@ -46,6 +46,7 @@ ARM64 = platform.machine() in {"arm64", "aarch64"} # ARM64 booleans
PYTHON_VERSION = platform.python_version()
TORCH_VERSION = torch.__version__
TORCHVISION_VERSION = importlib.metadata.version("torchvision") # faster than importing torchvision
+IS_VSCODE = os.environ.get("TERM_PROGRAM", False) == "vscode"
HELP_MSG = """
Examples for running Ultralytics:
@@ -1046,7 +1047,7 @@ class SettingsManager(dict):
version (str): Settings version. In case of local version mismatch, new default settings will be saved.
"""
- def __init__(self, file=SETTINGS_YAML, version="0.0.4"):
+ def __init__(self, file=SETTINGS_YAML, version="0.0.5"):
"""Initializes the SettingsManager with default settings and loads user settings."""
import copy
import hashlib
@@ -1077,6 +1078,7 @@ class SettingsManager(dict):
"raytune": True,
"tensorboard": True,
"wandb": True,
+ "vscode_msg": True,
}
self.help_msg = (
f"\nView settings with 'yolo settings' or at '{self.file}'"
@@ -1152,6 +1154,18 @@ def url2file(url):
return Path(clean_url(url)).name
+def vscode_msg(ext="ultralytics.ultralytics-snippets") -> str:
+ """Display a message to install Ultralytics-Snippets for VS Code if not already installed."""
+ path = (USER_CONFIG_DIR.parents[2] if WINDOWS else USER_CONFIG_DIR.parents[1]) / ".vscode/extensions"
+ obs_file = path / ".obsolete" # file tracks uninstalled extensions, while source directory remains
+ installed = any(path.glob(f"{ext}*")) and ext not in (obs_file.read_text("utf-8") if obs_file.exists() else "")
+ return (
+ f"{colorstr('VS Code:')} view Ultralytics VS Code Extension ⚡ at https://docs.ultralytics.com/integrations/vscode"
+ if not installed
+ else ""
+ )
+
+
# Run below code on utils init ------------------------------------------------------------------------------------
# Check first-install steps