Empezar

Extensión de Ultralytics para VS Code



Ver: Cómo usar la extensión de Ultralytics para Visual Studio Code | Fragmentos de código listos para usar | Ultralytics YOLO 🎉

Funciones y ventajas#

✅ ¿Eres científico de datos o ingeniero de aprendizaje automático y desarrollas aplicaciones de visión artificial con Ultralytics?

✅ ¿Te cansa escribir una y otra vez los mismos bloques de código?

✅ ¿Olvidas a menudo los argumentos o los valores predeterminados de los métodos train, val, predict, export o track?

✅ ¿Quieres empezar a usar Ultralytics y te gustaría tener una forma más sencilla de consultar o ejecutar ejemplos de código?

✅ ¿Quieres acelerar tu ciclo de desarrollo cuando trabajas con Ultralytics?

Si usas Visual Studio Code y has respondido «sí» a alguna de las preguntas anteriores, la extensión Ultralytics-snippets para VS Code puede ayudarte. En las secciones siguientes se explica qué hace la extensión, cómo instalarla y cómo usarla.


Inserting and running an Ultralytics YOLO prediction snippet in VS Code
Ejecuta código de ejemplo con Ultralytics YOLO en menos de 20 segundos.

Inspirada por la comunidad de Ultralytics#

La inspiración para crear esta extensión surgió de la comunidad Ultralytics. Las preguntas de la comunidad sobre temas y ejemplos similares impulsaron el desarrollo de este proyecto. Además, muchos miembros del equipo de Ultralytics usan VS Code en su trabajo.

¿Por qué VS Code?#

Visual Studio Code es muy popular entre los desarrolladores de todo el mundo y ocupó el primer puesto en la encuesta para desarrolladores de Stack Overflow en 2021, 2022, 2023 y 2024. Su popularidad se debe a sus amplias opciones de personalización, sus funciones integradas, su gran compatibilidad y su extensibilidad. Dada su popularidad entre la comunidad de desarrolladores y en las comunidades de Ultralytics en Discord, Discourse, Reddit y GitHub, tenía sentido crear una extensión para VS Code que te ayude a agilizar tu flujo de trabajo.

Para compartir qué herramientas utilizas para desarrollar código, vota en la encuesta de la comunidad de Discourse.

Instalar la extensión#

Nota

Cualquier entorno de código en el que se puedan instalar extensiones de VS Code debería ser compatible con la extensión Ultralytics-snippets. Neovim también se puede hacer compatible con las extensiones de VS Code.

Instalar en VS Code#

  1. Ve al menú Extensiones de VS Code o utiliza el atajo Ctrl+Shift ⇑+x, y busca Ultralytics-snippets.

  2. Haz clic en el botón Install.


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

Instalar desde el Marketplace de extensiones de VS Code#

  1. Visita el Marketplace de extensiones de VS Code y busca Ultralytics-snippets, o ve directamente a la página de la extensión en el Marketplace de VS Code.

  2. Haz clic en el botón Install y permite que el navegador inicie una sesión de VS Code.

  3. Sigue las indicaciones para instalar la extensión.


VS Code marketplace extension install
Página de la extensión Ultralytics-Snippets en el Marketplace de Visual Studio CodeUltralytics-Snippets

Uso de la extensión Ultralytics-Snippets#

  • Autocompletado inteligente de código: escribe código más rápido y con mayor precisión gracias a las sugerencias avanzadas de autocompletado adaptadas a la API de Ultralytics.

  • Mayor velocidad de desarrollo: ahorra tiempo y evita tareas de programación repetitivas con fragmentos de código predefinidos.

  • Mejor calidad del código: escribe código más limpio y coherente, con menos errores.

  • Flujo de trabajo más ágil: céntrate en la lógica principal de tu proyecto automatizando las tareas habituales.

Descripción general#

La extensión solo funcionará si el modo de lenguaje está configurado para Python. Así se evita insertar fragmentos al trabajar con otros tipos de archivo. Todos los fragmentos tienen un prefijo que empieza por ultra; al escribir ultra en el editor después de instalar la extensión, se muestra una lista de fragmentos disponibles. También puedes abrir la paleta de comandos de VS Code con Ctrl+Shift ⇑+p y ejecutar el comando Snippets: Insert Snippet.

Campos de los fragmentos de código#

Muchos fragmentos tienen «campos» con nombres o valores predeterminados de marcador de posición. Por ejemplo, la salida del método predict se podría guardar en una variable de Python llamada r, results, detections, preds o cualquier otro nombre que elija el desarrollador; por eso los fragmentos incluyen «campos». Al pulsar Tab ⇥ en el teclado después de insertar un fragmento, el cursor se desplazará rápidamente entre los campos. Una vez seleccionado un campo, al escribir un nuevo nombre de variable cambiará esa instancia y también todas las demás apariciones de esa variable en el código del fragmento.


Renaming a snippet field updates every instance and opens model scale and variant dropdowns
Después de insertar el fragmento, al cambiar el nombre de model a world_model se actualizan todas las instancias. Al pulsar Tab ⇥, pasarás al siguiente campo; se abrirá un menú desplegable para seleccionar la escala del modelo. Al pasar al campo siguiente, se abrirá otro menú desplegable para elegir la variante del modelo world o worldv2.

Autocompletado de fragmentos de código#

Atajos aún _más cortos_

No hace falta escribir el prefijo completo del fragmento, ni siquiera empezar a escribir desde el principio. Mira el ejemplo de la imagen siguiente.

Los fragmentos tienen nombres lo más descriptivos posible, pero eso puede obligarte a escribir mucho, lo que resultaría contraproducente si lo que buscas es ir más rápido. Por suerte, VS Code permite escribir ultra.example-yolo-predict, example-yolo-predict, yolo-predict o incluso ex-yolo-p y aun así encontrar el fragmento deseado. Si el fragmento que buscas es realmente ultra.example-yolo-predict-kwords, solo tienes que utilizar las teclas de flecha ↑ o ↓ para resaltar el fragmento deseado y pulsar Enter ↵ o Tab ⇥ para insertar el bloque de código correcto.


VS Code incomplete code snippet preview
Si escribes ex-yolo-p, seguirás obteniendo el fragmento correcto.

Categorías de fragmentos#

Estas son las categorías de fragmentos disponibles actualmente en la extensión Ultralytics-snippets. En el futuro se añadirán más, así que asegúrate de buscar actualizaciones y activar las actualizaciones automáticas de la extensión. También puedes solicitar que se añadan más fragmentos si falta alguno.

CategoríaPrefijo inicialDescripción
Ejemplosultra.examplesEjemplos de código para aprender o empezar a utilizar Ultralytics. Los ejemplos son copias de código de las páginas de documentación o versiones similares.
Argumentos con nombreultra.kwargsAcelera el desarrollo añadiendo fragmentos para los métodos train, val, predict y track, con todos sus argumentos con nombre y valores predeterminados.
Importacionesultra.importsFragmentos para importar rápidamente objetos habituales de Ultralytics.
Modelosultra.yoloInserta bloques de código para inicializar distintos modelos (yolo, sam, rtdetr, etc.), incluidas opciones de configuración en menús desplegables.
Resultadosultra.resultBloques de código para operaciones habituales al trabajar con resultados de inferencia.
Utilidadesultra.utilOfrece acceso rápido a utilidades habituales integradas en el paquete Ultralytics. Obtén más información en la página de utilidades sencillas.

Aprender con ejemplos#

Los fragmentos ultra.examples son muy útiles para quienes quieran aprender los fundamentos para empezar a trabajar con Ultralytics YOLO. Los fragmentos de ejemplo están pensados para ejecutarse nada más insertarlos (algunos también incluyen opciones desplegables). La animación de la parte superior de esta página muestra un ejemplo: después de insertar el fragmento, se selecciona todo el código y se ejecuta de forma interactiva con Shift ⇑+Enter ↵.

Ejemplo

Como muestra la animación de la parte superior de esta página, puedes utilizar el fragmento ultra.example-yolo-predict para insertar el siguiente ejemplo de código. Una vez insertado, la única opción que puedes configurar es la escala del modelo, que puede ser cualquiera de estas: n, s, m, l o 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()  # descomenta para ver cada imagen de resultado

Acelerar el desarrollo#

Los fragmentos que no sean ultra.examples están pensados para facilitar y agilizar el desarrollo con Ultralytics. En muchos proyectos es habitual iterar sobre la lista de Results que devuelve el método predict del modelo. El fragmento ultra.result-loop te puede ayudar con esto.

Ejemplo

Al utilizar ultra.result-loop, se insertará el siguiente código predeterminado (incluidos los comentarios).

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

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

Sin embargo, como Ultralytics admite numerosas tareas, al trabajar con los resultados de inferencia quizá quieras acceder a otros atributos Results; para eso resultan útiles los campos de fragmentos.


VS Code YOLO results visualization options
Una vez que llegues con el tabulador al campo boxes, aparecerá un menú desplegable que te permitirá seleccionar otro atributo según sea necesario.

Argumentos con nombre#

¡Hay más de 100 argumentos de palabra clave para las distintas tareas y modos de Ultralytics! Son muchos para recordar, y es fácil olvidar si el argumento es save_frame o save_frames (es save_frames). ¡Aquí es donde pueden ayudarte los fragmentos ultra.kwargs!

Ejemplo

Para insertar el método predict con todos los argumentos de inferencia, utiliza ultra.kwargs-predict; se insertará el siguiente código (incluidos los comentarios).

model.predict(
    source=src,  # (str, optional) directorio de origen de las imágenes o los vídeos
    imgsz=640,  # (int | list) tamaño de las imágenes de entrada como int o list[h,w] para predict
    conf=0.25,  # (float) umbral mínimo de confianza
    iou=0.7,  # (float) umbral de intersección sobre unión (IoU) para NMS
    vid_stride=1,  # (int) paso de la frecuencia de fotogramas del vídeo
    stream_buffer=False,  # (bool) almacenar los fotogramas entrantes en una cola (True) o conservar solo el fotograma más reciente (False)
    visualize=False,  # (bool) guardar mapas de activación de clases
    augment=False,  # (bool) aplicar aumentación de imagen a las fuentes de predicción
    agnostic_nms=False,  # (bool) NMS independiente de la clase
    classes=None,  # (int | list[int], optional) filtrar resultados por clase; p. ej., classes=0 o classes=[0,2,3]
    retina_masks=False,  # (bool) utilizar máscaras de segmentación de alta resolución
    embed=None,  # (list[int], optional) devolver vectores de características/incrustaciones de las capas indicadas
    show=False,  # (bool) mostrar imágenes y vídeos con predicciones si el entorno lo permite
    save=True,  # (bool) guardar los resultados de las predicciones
    save_frames=False,  # (bool) guardar los fotogramas de vídeo individuales con predicciones
    save_txt=False,  # (bool) guardar los resultados como archivo .txt
    save_conf=False,  # (bool) guardar los resultados con puntuaciones de confianza
    save_crop=False,  # (bool) guardar las imágenes recortadas con los resultados
    stream=False,  # (bool) procesar vídeos largos o numerosas imágenes con menos uso de memoria devolviendo un generador
    verbose=True,  # (bool) activar/desactivar el registro detallado de inferencia en el terminal
)

Este fragmento incluye campos para todos los argumentos con nombre, además de model y src, por si has utilizado otra variable en tu código. Cada línea que contiene un argumento con nombre incluye una breve descripción a modo de referencia.

Todos los fragmentos de código#

La mejor forma de averiguar qué fragmentos hay disponibles es descargar e instalar la extensión y probarla. Si tienes curiosidad y quieres echar un vistazo a la lista antes, puedes visitar el repositorio o la página de la extensión en el Marketplace de VS Code para consultar las tablas con todos los fragmentos disponibles.

Conclusión#

La extensión Ultralytics-Snippets para VS Code ayuda a científicos de datos e ingenieros de aprendizaje automático a desarrollar aplicaciones de visión artificial con Ultralytics YOLO de forma más eficiente. Sus fragmentos de código y ejemplos predefinidos te permiten dedicar menos tiempo al código repetitivo y más a la lógica de tu proyecto. Comparte tu opinión visitando la página de la extensión en el Marketplace de VS Code y dejando una reseña.

Preguntas frecuentes#

  • Puedes solicitar fragmentos nuevos mediante las incidencias del repositorio de Ultralytics-Snippets.

  • La extensión es gratuita.

  • VS Code utiliza la combinación de teclas Ctrl+Space para mostrar más o menos información en la ventana de vista previa. Si no ves la vista previa de un fragmento al escribir su prefijo, esta combinación de teclas debería volver a mostrarla.

  • Si utilizas VS Code y ha empezado a aparecerte un mensaje que te pide instalar la extensión Ultralytics-snippets, pero no quieres volver a verlo, tienes dos formas de desactivarlo.

    1. Instala Ultralytics-snippets y dejarás de ver este mensaje.

    2. Puedes utilizar yolo settings vscode_msg=False para evitar que aparezca el mensaje sin tener que instalar la extensión. Si no conoces la página Configuración de Ultralytics, puedes obtener más información en ella.

  • ¡Visita el repositorio de Ultralytics-snippets y abre una incidencia o una solicitud de cambios!

  • Como cualquier otra extensión de VS Code, puedes desinstalarla desde el menú Extensiones de VS Code. Busca la extensión Ultralytics-snippets en el menú, haz clic en el icono del engranaje (⚙) y, a continuación, haz clic en «Desinstalar» para eliminarla.


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

Comentarios3

Haz una pregunta, comparte tus resultados o ayuda a otra persona.

  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