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 社区。社区成员提出的相关问题和示例推动了这个项目的开发。此外,许多 Ultralytics 团队成员也使用 VS Code 开展自己的工作。
为什么选择 VS Code?#
Visual Studio Code 在全球开发者中广泛使用,并在 Stack Overflow 开发者调查中于 2021、2022、2023 和 2024 年排名最受欢迎。它之所以受欢迎,得益于高度可定制性、内置功能、广泛的兼容性和可扩展性。考虑到它在更广泛的开发者社区以及 Ultralytics 的 Discord、Discourse、Reddit 和 GitHub 社区中的人气,开发 VS Code 扩展来简化你的工作流程是顺理成章的选择。
想分享你使用哪些工具编写代码?请在 Discourse 的社区投票中投票。
安装扩展#
在 VS Code 中安装#
-
前往 VS Code 中的扩展菜单,或使用快捷键 Ctrl+Shift ⇑+x,然后搜索 Ultralytics-snippets。
-
点击 Install 按钮。
从 VS Code 扩展市场安装#
-
访问 VS Code 扩展市场并搜索 Ultralytics-snippets,或直接前往 VS Code 市场中的扩展页面。
-
点击 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 软件包内置的常用实用工具。请在简单实用工具页面了解详情。 |
通过示例学习#
对于想要学习 Ultralytics YOLO 基础用法的用户,ultra.examples 代码片段非常实用。示例代码片段插入后即可运行(其中一些还提供下拉选项)。本页面顶部的动画展示了一个示例:插入代码片段后,所有代码都会被选中,并通过 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 数组不过,由于 Ultralytics 支持多种任务,在处理推理结果时,你可能还需要访问其他 Results 属性,这时代码片段字段就很有用。
按 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) 输入图像尺寸,可用整数或 list[h,w] 表示,供 predict 使用
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 市场中的扩展页面,查看所有可用代码片段的表格。
结论#
VS Code 的 Ultralytics-Snippets 扩展可帮助数据科学家和机器学习工程师更高效地使用 Ultralytics YOLO 构建计算机视觉应用。借助预先编写的代码片段和示例,你可以减少编写样板代码的时间,把更多精力放在项目逻辑上。欢迎前往 VS Code 市场中的扩展页面留下评价,分享你的反馈。
常见问题#
你可以通过 Ultralytics-Snippets 仓库中的 Issues 申请新的代码片段。
该扩展免费。
VS Code 使用快捷键 Ctrl+Space 在预览窗口中显示/隐藏更多信息。如果输入代码片段前缀时看不到代码片段预览,使用此快捷键组合应该就能恢复预览。
如果你使用 VS Code,并且开始看到提示你安装 Ultralytics-snippets 扩展的消息,但不想再看到这条消息,可以通过两种方式将其禁用。
-
安装 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.