Começar

Extensão Ultralytics para VS Code



Assista: Como usar a extensão Ultralytics para Visual Studio Code | Trechos de código prontos para usar | Ultralytics YOLO 🎉

Funcionalidades e vantagens#

✅ Você é cientista de dados ou engenheiro de aprendizado de máquina e está desenvolvendo aplicações de visão computacional com Ultralytics?

✅ Cansado de escrever os mesmos blocos de código repetidamente?

✅ Esqueces-te sempre dos argumentos ou dos valores predefinidos dos métodos train, val, predict, export ou track?

✅ Queres começar a usar a Ultralytics e gostarias de ter uma forma mais fácil de consultar ou executar exemplos de código?

✅ Queres acelerar o teu ciclo de desenvolvimento ao trabalhar com a Ultralytics?

Se você usa o Visual Studio Code e respondeu “sim” a alguma das perguntas acima, a extensão Ultralytics-snippets para VS Code pode ajudar. As seções abaixo explicam o que a extensão faz, como instalá-la e como usá-la.


Inserting and running an Ultralytics YOLO prediction snippet in VS Code
Execute um código de exemplo usando Ultralytics YOLO em menos de 20 segundos.

Inspirada pela comunidade Ultralytics#

A inspiração para criar esta extensão veio da Comunidade Ultralytics. As perguntas da Comunidade sobre tópicos semelhantes e exemplos impulsionaram o desenvolvimento deste projeto. Além disso, muitos membros da equipe Ultralytics usam o VS Code no próprio trabalho.

Porquê o VS Code?#

O Visual Studio Code é amplamente usado por desenvolvedores do mundo todo e ficou em primeiro lugar na pesquisa para desenvolvedores do Stack Overflow em 2021, 2022, 2023 e 2024. Sua popularidade se deve ao alto nível de personalização, aos recursos integrados, à ampla compatibilidade e à extensibilidade. Dada essa popularidade na comunidade de desenvolvimento em geral e nas comunidades Ultralytics do Discord, Discourse, Reddit e GitHub, fazia sentido criar uma extensão para VS Code que ajudasse a otimizar seu fluxo de trabalho.

Para compartilhar quais ferramentas você usa para desenvolver código, vote na enquete da comunidade do Discourse.

Instalar a extensão#

Nota

Qualquer ambiente de programação que permita instalar extensões do VS Code deverá ser compatível com a extensão Ultralytics-snippets. O Neovim também pode ser configurado para ser compatível com extensões do VS Code.

Instalar no VS Code#

  1. Acede ao menu Extensões do VS Code ou usa o atalho Ctrl+Shift ⇑+x e pesquisa por Ultralytics-snippets.

  2. Clica no botão Install.


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

Instalar a partir do Marketplace de extensões do VS Code#

  1. Visita o Marketplace de extensões do VS Code e pesquisa por Ultralytics-snippets ou acede diretamente à página da extensão no Marketplace do VS Code.

  2. Clica no botão Install e permite que o navegador inicie uma sessão do VS Code.

  3. Segue as instruções apresentadas para instalar a extensão.


VS Code marketplace extension install
Página da extensão Ultralytics-Snippets no Marketplace do Visual Studio CodeUltralytics-Snippets

Utilizar a extensão Ultralytics-Snippets#

  • Conclusão inteligente de código: Escreva código com mais rapidez e precisão usando sugestões avançadas de conclusão adaptadas à API da Ultralytics.

  • Maior velocidade de desenvolvimento: Economize tempo eliminando tarefas repetitivas de programação com trechos de código prontos.

  • Melhor qualidade do código: Escreva código mais limpo e consistente, com menos erros.

  • Fluxo de trabalho simplificado: Mantenha o foco na lógica principal do seu projeto automatizando tarefas comuns.

Visão geral#

A extensão funciona somente quando o Modo de linguagem está configurado para Python. Isso impede a inserção de trechos ao trabalhar com qualquer outro tipo de arquivo. Todos os trechos têm um prefixo que começa com ultra; digitar ultra no editor após instalar a extensão exibe uma lista de trechos disponíveis. Você também pode abrir a Paleta de Comandos do VS Code usando Ctrl+Shift ⇑+p e executar o comando Snippets: Insert Snippet.

Campos dos fragmentos de código#

Muitos fragmentos têm «campos» com valores predefinidos ou nomes de marcador de posição. Por exemplo, o resultado do método predict pode ser guardado numa variável Python chamada r, results, detections, preds ou qualquer outro nome escolhido pelo programador; por isso, os fragmentos incluem «campos». Depois de inserir um fragmento, usa Tab ⇥ no teclado para mover rapidamente o cursor entre os campos. Quando um campo estiver selecionado, ao escrever um novo nome de variável, esse nome substituirá o campo selecionado e todas as outras ocorrências dessa variável no código do fragmento!


Renaming a snippet field updates every instance and opens model scale and variant dropdowns
Depois de inserir o trecho, renomear model como world_model atualiza todas as instâncias. Ao pressionar Tab ⇥, você vai para o próximo campo, que abre um menu suspenso e permite selecionar uma escala de modelo; ao avançar para o campo seguinte, outro menu suspenso permite escolher a variante do modelo world ou worldv2.

Conclusões dos fragmentos de código#

Atalhos ainda _mais curtos_

Não é necessário escrever o prefixo completo do fragmento, nem sequer começar a escrever desde o início do prefixo. Vê o exemplo na imagem abaixo.

Os fragmentos têm nomes tão descritivos quanto possível, mas isso pode implicar escrever muito, o que seria contraproducente se o objetivo for avançar mais depressa. Felizmente, o VS Code permite escrever ultra.example-yolo-predict, example-yolo-predict, yolo-predict ou até ex-yolo-p e, mesmo assim, encontrar a opção de fragmento pretendida! Se o fragmento pretendido for mesmo ultra.example-yolo-predict-kwords, basta usar as teclas de seta ↑ ou ↓ para selecionar o fragmento pretendido e premir Enter ↵ ou Tab ⇥ para inserir o bloco de código correto.


VS Code incomplete code snippet preview
Digitar ex-yolo-p ainda vai levar ao trecho correto.

Categorias de fragmentos#

Estas são as categorias de trechos disponíveis atualmente na extensão Ultralytics-snippets. Outras serão adicionadas no futuro, então não deixe de verificar se há atualizações e ativar as atualizações automáticas da extensão. Você também pode solicitar trechos adicionais caso algum esteja faltando.

CategoriaPrefixo inicialDescrição
Exemplosultra.examplesExemplos de código para ajudar a aprender ou começar a utilizar a Ultralytics. Os exemplos são cópias ou adaptações de código das páginas da documentação.
Kwargsultra.kwargsAcelera o desenvolvimento adicionando fragmentos para os métodos train, val, predict e track, com todos os argumentos nomeados e valores predefinidos.
Importaçõesultra.importsFragmentos para importar rapidamente objetos comuns da Ultralytics.
Modelosultra.yoloInsere blocos de código para inicializar vários modelos (yolo, sam, rtdetr, etc.), incluindo opções de configuração em menus pendentes.
Resultadosultra.resultBlocos de código para operações comuns ao trabalhar com resultados de inferência.
Utilitáriosultra.utilOferece acesso rápido a utilitários comuns incluídos no pacote Ultralytics. Sabe mais sobre eles na página de utilitários simples.

Aprender com exemplos#

Os trechos ultra.examples são muito úteis para quem quer aprender os fundamentos para começar a trabalhar com Ultralytics YOLO. Os exemplos de trechos devem ser executados assim que inseridos (alguns também têm opções em menus suspensos). Um exemplo é mostrado na animação no início desta página: depois que o trecho é inserido, todo o código é selecionado e executado interativamente usando Shift ⇑+Enter ↵.

Exemplo

Tal como mostra a animação no início desta página, podes usar o fragmento ultra.example-yolo-predict para inserir o seguinte exemplo de código. Depois de o inserires, a única opção configurável é a escala do modelo, que pode ser uma destas: n, s, m, l ou 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 imagem de resultado

Acelerar o desenvolvimento#

Os trechos que não são ultra.examples têm como objetivo tornar o desenvolvimento com Ultralytics mais fácil e rápido. Em muitos projetos, um bloco de código comum percorre a lista de Results retornada pelo método predict do modelo. O trecho ultra.result-loop pode ajudar com isso.

Exemplo

Ao usar ultra.result-loop, será inserido o seguinte código predefinido (incluindo comentários).

# referência https://docs.ultralytics.com/modes/predict#working-with-results

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

No entanto, como a Ultralytics oferece suporte a várias tarefas, ao trabalhar com resultados de inferência, talvez você queira acessar outros atributos Results; é aí que os campos de trechos são úteis.


VS Code YOLO results visualization options
Depois de avançar com Tab até o campo boxes, aparece um menu suspenso que permite selecionar outro atributo, conforme necessário.

Argumentos nomeados#

Há mais de 100 argumentos de palavra-chave para as várias tarefas e modos da Ultralytics! É muita coisa para lembrar, e é fácil esquecer se o argumento é save_frame ou save_frames (é save_frames). É aí que os trechos ultra.kwargs podem ajudar!

Exemplo

Para inserir o método predict, incluindo todos os argumentos de inferência, usa ultra.kwargs-predict, que insere o seguinte código (incluindo comentários).

model.predict(
    source=src,  # (str, optional) diretório de origem das imagens ou vídeos
    imgsz=640,  # (int | list) tamanho das imagens de entrada como int ou list[h,w] para predict
    conf=0.25,  # (float) limiar mínimo de confiança
    iou=0.7,  # (float) limiar de interseção sobre união (IoU) para NMS
    vid_stride=1,  # (int) intervalo entre fotogramas de vídeo
    stream_buffer=False,  # (bool) guardar os fotogramas recebidos numa fila (True) ou manter apenas o fotograma mais recente (False)
    visualize=False,  # (bool) guardar mapas de calor de ativação de classes
    augment=False,  # (bool) aplicar aumento de dados de imagem às fontes de previsão
    agnostic_nms=False,  # (bool) NMS independente da classe
    classes=None,  # (int | list[int], optional) filtrar resultados por classe, por exemplo, classes=0 ou classes=[0,2,3]
    retina_masks=False,  # (bool) usar máscaras de segmentação de alta resolução
    embed=None,  # (list[int], optional) devolver vetores de características/embeddings das camadas indicadas
    show=False,  # (bool) mostrar imagens e vídeos previstos, se o ambiente o permitir
    save=True,  # (bool) guardar os resultados da previsão
    save_frames=False,  # (bool) guardar fotogramas individuais do vídeo previsto
    save_txt=False,  # (bool) guardar os resultados num ficheiro .txt
    save_conf=False,  # (bool) guardar os resultados com as pontuações de confiança
    save_crop=False,  # (bool) guardar imagens recortadas com os resultados
    stream=False,  # (bool) processar vídeos longos ou muitas imagens com menor utilização de memória, devolvendo um gerador
    verbose=True,  # (bool) ativar/desativar o registo detalhado da inferência no terminal
)

Este fragmento tem campos para todos os argumentos nomeados, mas também para model e src, caso tenhas usado uma variável diferente no teu código. Cada linha com um argumento nomeado inclui uma breve descrição para consulta.

Todos os fragmentos de código#

A melhor forma de descobrir que fragmentos estão disponíveis é transferir e instalar a extensão e experimentá-la! Se tiveres curiosidade e quiseres consultar a lista primeiro, visita o repositório ou a página da extensão no Marketplace do VS Code para ver as tabelas com todos os fragmentos disponíveis.

Conclusão#

A extensão Ultralytics-Snippets para VS Code ajuda cientistas de dados e engenheiros de aprendizado de máquina a desenvolver aplicações de visão computacional com Ultralytics YOLO com mais eficiência. Os trechos de código e exemplos prontos permitem que você passe menos tempo com código repetitivo e mais tempo na lógica do seu projeto. Compartilhe sua opinião acessando a página da extensão no marketplace do VS Code e deixando uma avaliação.

Perguntas frequentes#

  • Podes pedir novos fragmentos através das Issues no repositório Ultralytics-Snippets.

  • A extensão é gratuita.

  • O VS Code usa a combinação de teclas Ctrl+Space para mostrar mais ou menos informações na janela de pré-visualização. Se não estiveres a ver uma pré-visualização do trecho ao escreveres um prefixo de trecho de código, usar esta combinação de teclas deverá restaurar a pré-visualização.

  • Se usas o VS Code e começaste a ver uma mensagem a pedir que instales a extensão Ultralytics-snippets, mas não queres voltar a ver essa mensagem, há duas formas de a desativar.

    1. Instale Ultralytics-snippets e a mensagem não será mais exibida.

    2. Podes usar yolo settings vscode_msg=False para impedir que a mensagem apareça sem teres de instalar a extensão. Se não estiveres familiarizado com a página Definições do Ultralytics, podes saber mais.

  • Visita o repositório do Ultralytics-snippets e abre uma issue ou um pull request!

  • Tal como qualquer outra extensão do VS Code, podes desinstalá-la acedendo ao menu Extensões no VS Code. Encontra a extensão Ultralytics-snippets no menu, clica no ícone da engrenagem (⚙) e, em seguida, clica em "Desinstalar" para remover a extensão.


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

Comentários3

Faz uma pergunta, partilha os teus resultados ou ajuda alguém.

  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