Ultralytics Explorer API#

Introdução#

The Explorer API is a Python API for exploring your datasets. It supports filtering and searching your dataset using SQL queries, vector similarity search, and semantic search.

Instalação#

O Explorer depende de bibliotecas externas para algumas de suas funcionalidades. Elas são instaladas automaticamente quando usas o Explorer. Para instalar estas dependências manualmente, usa o seguinte comando:

pip install ultralytics[explorer]

Uso#

from ultralytics import Explorer

# Create an Explorer object
explorer = Explorer(data="coco128.yaml", model="yolo11n.pt")

# Create embeddings for your dataset
explorer.create_embeddings_table()

# Search for similar images to a given image/images
df = explorer.get_similar(img="path/to/image.jpg")

# Or search for similar images to a given index/indices
df = explorer.get_similar(idx=0)

Caso queiras forçar a atualização da tabela de embeddings, podes passar force=True para o método create_embeddings_table.

Podes aceder diretamente ao objeto da tabela do LanceDB para realizar análises avançadas. Sabe mais sobre isso na secção Working with Embeddings Table

1. Pesquisa de Semelhança#

A pesquisa de semelhança é uma técnica para encontrar imagens semelhantes a uma dada imagem. Baseia-se na ideia de que imagens semelhantes terão embeddings semelhantes. Assim que a tabela de embeddings for criada, podes executar a pesquisa semântica de qualquer uma das seguintes formas:

• Num determinado índice ou lista de índices no conjunto de dados: exp.get_similar(idx=[1,10], limit=10)
• Em qualquer imagem ou lista de imagens que não esteja no conjunto de dados: exp.get_similar(img=["path/to/img1", "path/to/img2"], limit=10)

No caso de múltiplas entradas, é utilizado o agregado dos seus embeddings.

Obténs um pandas DataFrame com o número limit de pontos de dados mais semelhantes à entrada, juntamente com a respetiva distância no espaço de embeddings. Podes usar este conjunto de dados para efetuar filtragens adicionais.

from ultralytics import Explorer

# create an Explorer object
exp = Explorer(data="coco128.yaml", model="yolo11n.pt")
exp.create_embeddings_table()

similar = exp.get_similar(img="https://ultralytics.com/images/bus.jpg", limit=10)
print(similar.head())

# Search using multiple indices
similar = exp.get_similar(
    img=["https://ultralytics.com/images/bus.jpg", "https://ultralytics.com/images/bus.jpg"],
    limit=10,
)
print(similar.head())

A Esboçar Imagens Semelhantes#

Também podes desenhar as imagens semelhantes usando o método plot_similar. Este método aceita os mesmos argumentos que get_similar e desenha as imagens semelhantes numa grelha.

from ultralytics import Explorer

# create an Explorer object
exp = Explorer(data="coco128.yaml", model="yolo11n.pt")
exp.create_embeddings_table()

plt = exp.plot_similar(img="https://ultralytics.com/images/bus.jpg", limit=10)
plt.show()

2. Perguntar à IA (Consultas em Linguagem Natural)#

Esta funcionalidade permite-te filtrar o teu conjunto de dados utilizando linguagem natural, sem escrever SQL. O gerador de consultas alimentado por IA converte a tua instrução numa consulta e devolve resultados correspondentes. Por exemplo, podes perguntar: "mostra-me 100 imagens com exatamente uma pessoa e 2 cães. Também pode haver outros objetos" e ele irá gerar a consulta e mostrar-te esses resultados. Nota: Esta funcionalidade utiliza LLMs, pelo que os resultados são probabilísticos e podem ser imprecisos.

from ultralytics.data.explorer import plot_query_result

from ultralytics import Explorer

# create an Explorer object
exp = Explorer(data="coco128.yaml", model="yolo11n.pt")
exp.create_embeddings_table()

df = exp.ask_ai("show me 100 images with exactly one person and 2 dogs. There can be other objects too")
print(df.head())

# plot the results
plt = plot_query_result(df)
plt.show()

3. Consultas SQL#

Podes executar consultas SQL no teu conjunto de dados utilizando o método sql_query. Este método aceita uma consulta SQL como entrada e devolve um pandas DataFrame com os resultados.

from ultralytics import Explorer

# create an Explorer object
exp = Explorer(data="coco128.yaml", model="yolo11n.pt")
exp.create_embeddings_table()

df = exp.sql_query("WHERE labels LIKE '%person%' AND labels LIKE '%dog%'")
print(df.head())

A Esboçar Resultados de Consultas SQL#

Também podes desenhar os resultados de uma consulta SQL usando o método plot_sql_query. Este método aceita os mesmos argumentos que sql_query e desenha os resultados numa grelha.

from ultralytics import Explorer

# create an Explorer object
exp = Explorer(data="coco128.yaml", model="yolo11n.pt")
exp.create_embeddings_table()

# plot the SQL Query
exp.plot_sql_query("WHERE labels LIKE '%person%' AND labels LIKE '%dog%' LIMIT 10")

4. Trabalhar com a Tabela de Embeddings#

Também podes trabalhar diretamente com a tabela de embeddings. Assim que a tabela de embeddings for criada, podes aceder a ela utilizando Explorer.table

from ultralytics import Explorer

exp = Explorer()
exp.create_embeddings_table()
table = exp.table

Aqui tens alguns exemplos do que podes fazer com a tabela:

Obter Embeddings em Bruto#

from ultralytics import Explorer

exp = Explorer()
exp.create_embeddings_table()
table = exp.table

embeddings = table.to_pandas()["vector"]
print(embeddings)

Consultas Avançadas com filtros pré e pós-processamento#

from ultralytics import Explorer

exp = Explorer(model="yolo11n.pt")
exp.create_embeddings_table()
table = exp.table

# Dummy embedding
embedding = [i for i in range(256)]
rs = table.search(embedding).metric("cosine").where("").limit(10)

Criar Índice Vetorial#

Ao utilizar grandes conjuntos de dados, também podes criar um índice vetorial dedicado para consultas mais rápidas. Isto é feito através do método create_index na tabela do LanceDB.

table.create_index(num_partitions=..., num_sub_vectors=...)

5. Aplicações de Embeddings#

Podes utilizar a tabela de embeddings para realizar uma variedade de análises exploratórias. Aqui tens alguns exemplos:

Índice de Similaridade#

O Explorer inclui uma operação similarity_index:

• Tenta estimar o quão semelhante cada ponto de dados é em relação ao resto do dataset.
• Para o fazer, conta quantos embeddings de imagem estão mais próximos do que max_dist da imagem atual no espaço de embeddings gerado, considerando top_k imagens semelhantes de cada vez.

Devolve um DataFrame pandas com as seguintes colunas:

• idx: Índice da imagem no conjunto de dados
• im_file: Caminho para o ficheiro de imagem
• count: Número de imagens no conjunto de dados que estão mais próximas do que max_dist da imagem atual
• sim_im_files: Lista de caminhos para as count imagens semelhantes

from ultralytics import Explorer

exp = Explorer()
exp.create_embeddings_table()

sim_idx = exp.similarity_index()

Podes utilizar o índice de semelhança para criar condições personalizadas para filtrar o conjunto de dados. Por exemplo, podes filtrar imagens que não são semelhantes a nenhuma outra imagem no conjunto de dados utilizando o seguinte código:

import numpy as np

sim_count = np.array(sim_idx["count"])
sim_idx["im_file"][sim_count > 30]

Visualizar o Espaço de Embeddings#

Também podes visualizar o espaço de embeddings utilizando a ferramenta de plotagem da tua escolha. Por exemplo, aqui tens um exemplo simples utilizando Matplotlib:

import matplotlib.pyplot as plt
from sklearn.decomposition import PCA

# Reduce dimensions using PCA to 3 components for visualization in 3D
pca = PCA(n_components=3)
reduced_data = pca.fit_transform(embeddings)

# Create a 3D scatter plot using Matplotlib Axes3D
fig = plt.figure(figsize=(8, 6))
ax = fig.add_subplot(111, projection="3d")

# Scatter plot
ax.scatter(reduced_data[:, 0], reduced_data[:, 1], reduced_data[:, 2], alpha=0.5)
ax.set_title("3D Scatter Plot of Reduced 256-Dimensional Data (PCA)")
ax.set_xlabel("Component 1")
ax.set_ylabel("Component 2")
ax.set_zlabel("Component 3")

plt.show()

Começa a criar os teus próprios relatórios de exploração de conjuntos de dados de CV utilizando a API do Explorer. Para inspiração, consulta o exemplo de exploração do VOC.

Aplicações Criadas com o Ultralytics Explorer#

Experimenta a nossa demonstração da GUI baseada na API do Explorer

FAQ#