Transformers documentation

EdgeTAM

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v5.22.1).
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Mô hình này được công bố trên HF papers vào ngày 13-01-2025 và được đóng góp cho Hugging Face Transformers vào ngày 29-09-2025.

SDPA FlashAttention

EdgeTAM

Tổng quan

Mô hình EdgeTAM được đề xuất trong EdgeTAM: On-Device Track Anything Model Chong Zhou, Chenchen Zhu, Yunyang Xiong, Saksham Suri, Fanyi Xiao, Lemeng Wu, Raghuraman Krishnamoorthi, Bo Dai, Chen Change Loy, Vikas Chandra, Bilge Soran.

EdgeTAM là một biến thể hiệu quả của SAM 2, giới thiệu kiến trúc 2D Spatial Perceiver để tối ưu hóa các cơ chế chú ý bộ nhớ cho phân đoạn video thời gian thực trên thiết bị di động.

Tóm tắt từ bài báo như sau:

Nằm trên nền tảng của Segment Anything Model (SAM), SAM 2 mở rộng thêm khả năng từ đầu vào hình ảnh sang đầu vào video thông qua cơ chế ngân hàng bộ nhớ (memory bank) và đạt được hiệu suất vượt trội so với các phương pháp trước đó, biến nó thành một mô hình nền tảng cho tác vụ phân đoạn video. Trong bài báo này, chúng tôi hướng đến việc làm cho SAM 2 hiệu quả hơn nhiều để nó thậm chí có thể chạy trên các thiết bị di động trong khi vẫn duy trì hiệu suất tương đương. Mặc dù đã có một số công việc tối ưu hóa SAM để cải thiện hiệu quả, chúng tôi nhận thấy chúng không đủ cho SAM 2 vì tất cả đều tập trung vào việc nén bộ mã hóa hình ảnh, trong khi benchmark của chúng tôi cho thấy các khối chú ý bộ nhớ (memory attention blocks) mới được giới thiệu cũng là nút thắt cổ chai về độ trễ. Với quan sát này, chúng tôi đề xuất EdgeTAM, tận dụng một 2D Spatial Perceiver mới để giảm chi phí tính toán. Cụ thể, 2D Spatial Perceiver được đề xuất mã hóa các bộ nhớ cấp khung (frame-level memories) được lưu trữ dày đặc bằng một Transformer nhẹ chứa một tập hợp cố định các truy vấn (queries) có thể học được. Do phân đoạn video là một tác vụ dự đoán dày đặc (dense prediction), chúng tôi nhận thấy việc bảo toàn cấu trúc không gian của các bộ nhớ là thiết yếu, do đó các truy vấn được chia thành các nhóm cấp toàn cục (global-level) và cấp mảnh (patch-level). Chúng tôi cũng đề xuất một quy trình chưng cất (distillation pipeline) giúp cải thiện thêm hiệu suất mà không gây ra chi phí suy luận (inference overhead). Kết quả, EdgeTAM đạt 87,7, 70,0, 72,3 và 71,7 J&F trên DAVIS 2017, MOSE, SA-V val và SA-V test, trong khi chạy ở 16 FPS trên iPhone 15 Pro Max.

Mô hình này được đóng góp bởi yonigozlan. Mã nguồn gốc có thể được tìm thấy tại đây.

Ví dụ sử dụng

Tự động tạo mặt nạ với Pipeline

EdgeTAM có thể được sử dụng để tạo mặt nạ tự động nhằm phân đoạn tất cả các đối tượng trong một hình ảnh bằng cách sử dụng pipeline mask-generation:

from transformers import pipeline


generator = pipeline("mask-generation", model="yonigozlan/edgetam-1", device=0)
image_url = "https://huggingface.co/datasets/hf-internal-testing/sam2-fixtures/resolve/main/truck.jpg"
outputs = generator(image_url, points_per_batch=64)

len(outputs["masks"])  # Number of masks generated
39

Phân đoạn hình ảnh cơ bản

Nhấp một điểm

Bạn có thể phân đoạn các đối tượng bằng cách nhấp một điểm duy nhất vào đối tượng mà bạn muốn phân đoạn:

from transformers import Sam2Processor, EdgeTamModel
import torch
from PIL import Image
import requests


model = EdgeTamModel.from_pretrained("yonigozlan/edgetam-1", device_map="auto")
processor = Sam2Processor.from_pretrained("yonigozlan/edgetam-1")

image_url = "https://huggingface.co/datasets/hf-internal-testing/sam2-fixtures/resolve/main/truck.jpg"
raw_image = Image.open(requests.get(image_url, stream=True).raw).convert("RGB")

input_points = [[[[500, 375]]]]  # Single point click, 4 dimensions (image_dim, object_dim, point_per_object_dim, coordinates)
input_labels = [[[1]]]  # 1 for positive click, 0 for negative click, 3 dimensions (image_dim, object_dim, point_label)

inputs = processor(images=raw_image, input_points=input_points, input_labels=input_labels, return_tensors="pt").to(model.device)

with torch.no_grad():
    outputs = model(**inputs)

masks = processor.post_process_masks(outputs.pred_masks.cpu(), inputs["original_sizes"])[0]

# The model outputs multiple mask predictions ranked by quality score
print(f"Generated {masks.shape[1]} masks with shape {masks.shape}")
Generated 3 masks with shape torch.Size([1, 3, 1200, 1800])
print(f"IoU scores: {outputs.iou_scores.squeeze()}")
IoU scores: tensor([0.0463, 0.4859, 0.7616], device='cuda:0')

Nhiều điểm để tinh chỉnh

Bạn có thể cung cấp nhiều điểm để tinh chỉnh phân đoạn:

# Add both positive and negative points to refine the mask
input_points = [[[[500, 375], [1125, 625]]]]  # Multiple points for refinement
input_labels = [[[1, 1]]]  # Both positive clicks

inputs = processor(images=raw_image, input_points=input_points, input_labels=input_labels, return_tensors="pt").to(model.device)

with torch.no_grad():
    outputs = model(**inputs)

masks = processor.post_process_masks(outputs.pred_masks.cpu(), inputs["original_sizes"])[0]
print(f"IoU scores: {outputs.iou_scores.squeeze()}")
IoU scores: tensor([0.8362, 0.6900, 0.2120], device='cuda:0')

Đầu vào Hộp Chứa

EdgeTAM cũng hỗ trợ đầu vào hộp bao (bounding box) cho phân đoạn:

# Define bounding box as [x_min, y_min, x_max, y_max]
input_boxes = [[[75, 275, 1725, 850]]]

inputs = processor(images=raw_image, input_boxes=input_boxes, return_tensors="pt").to(model.device)

with torch.no_grad():
    outputs = model(**inputs)

masks = processor.post_process_masks(outputs.pred_masks.cpu(), inputs["original_sizes"])[0]
print(f"IoU scores: {outputs.iou_scores.squeeze()}")
IoU scores: tensor([0.9301, 0.9348, 0.6605], device='cuda:0')

Phân đoạn nhiều đối tượng

Bạn có thể phân đoạn nhiều đối tượng đồng thời:

# Define points for two different objects
input_points = [[[[500, 375]], [[650, 750]]]]  # Points for two objects in same image
input_labels = [[[1], [1]]]  # Positive clicks for both objects

inputs = processor(images=raw_image, input_points=input_points, input_labels=input_labels, return_tensors="pt").to(model.device)

with torch.no_grad():
    outputs = model(**inputs, multimask_output=False)

# Each object gets its own mask
masks = processor.post_process_masks(outputs.pred_masks.cpu(), inputs["original_sizes"])[0]
print(f"Generated masks for {masks.shape[0]} objects")
Generated masks for 2 objects
print(f"IoU scores: {outputs.iou_scores.squeeze()}")
IoU scores: tensor([0.7616, 0.9465], device='cuda:0')

Suy luận theo lô

Hình ảnh theo lô

Xử lý nhiều hình ảnh đồng thời để cải thiện hiệu suất:

from transformers import Sam2Processor, EdgeTamModel
import torch
from PIL import Image
import requests


model = EdgeTamModel.from_pretrained("yonigozlan/edgetam-1", device_map="auto")
processor = Sam2Processor.from_pretrained("yonigozlan/edgetam-1")

# Load multiple images
image_urls = [
    "https://huggingface.co/datasets/hf-internal-testing/sam2-fixtures/resolve/main/truck.jpg",
    "https://huggingface.co/datasets/hf-internal-testing/transformers-synthetic-assets/resolve/main/images/dog_sam.png"
]
raw_images = [Image.open(requests.get(url, stream=True).raw).convert("RGB") for url in image_urls]

# Single point per image
input_points = [[[[500, 375]]], [[[770, 200]]]]  # One point for each image
input_labels = [[[1]], [[1]]]  # Positive clicks for both images

inputs = processor(images=raw_images, input_points=input_points, input_labels=input_labels, return_tensors="pt").to(model.device)

with torch.no_grad():
    outputs = model(**inputs, multimask_output=False)

# Post-process masks for each image
all_masks = processor.post_process_masks(outputs.pred_masks.cpu(), inputs["original_sizes"])
print(f"Processed {len(all_masks)} images, each with {all_masks[0].shape[0]} objects")
Processed 2 images, each with 1 objects
print(f"IoU scores: {outputs.iou_scores.squeeze()}")
IoU scores: tensor([0.7618, 0.7999], device='cuda:0')

Các Đối tượng được Xử lý theo Lô cho Mỗi Ảnh

Phân đoạn nhiều đối tượng trong mỗi hình ảnh bằng suy luận theo lô:

# Multiple objects per image - different numbers of objects per image
input_points = [
    [[[500, 375]], [[650, 750]]],  # Truck image: 2 objects
    [[[770, 200]]]  # Dog image: 1 object
]
input_labels = [
    [[1], [1]],  # Truck image: positive clicks for both objects
    [[1]]  # Dog image: positive click for the object
]

inputs = processor(images=raw_images, input_points=input_points, input_labels=input_labels, return_tensors="pt").to(model.device)

with torch.no_grad():
    outputs = model(**inputs, multimask_output=False)

all_masks = processor.post_process_masks(outputs.pred_masks.cpu(), inputs["original_sizes"])

Hình ảnh theo lô với các đối tượng theo lô và nhiều điểm

Xử lý các kịch bản batch phức tạp với nhiều điểm cho mỗi đối tượng:

# Add groceries image for more complex example
groceries_url = "https://huggingface.co/datasets/hf-internal-testing/sam2-fixtures/resolve/main/groceries.jpg"
groceries_image = Image.open(requests.get(groceries_url, stream=True).raw).convert("RGB")
raw_images = [raw_images[0], groceries_image]  # Use truck and groceries images

# Complex batching: multiple images, multiple objects, multiple points per object
input_points = [
    [[[500, 375]], [[650, 750]]],  # Truck image: 2 objects with 1 point each
    [[[400, 300]], [[630, 300], [550, 300]]]  # Groceries image: obj1 has 1 point, obj2 has 2 points
]
input_labels = [
    [[1], [1]],  # Truck image: positive clicks
    [[1], [1, 1]]  # Groceries image: positive clicks for refinement
]

inputs = processor(images=raw_images, input_points=input_points, input_labels=input_labels, return_tensors="pt").to(model.device)

with torch.no_grad():
    outputs = model(**inputs, multimask_output=False)

all_masks = processor.post_process_masks(outputs.pred_masks.cpu(), inputs["original_sizes"])

Hộp bao dạng lô

Xử lý nhiều hình ảnh với đầu vào là hộp bao quanh:

# Multiple bounding boxes per image (using truck and groceries images)
input_boxes = [
    [[75, 275, 1725, 850], [425, 600, 700, 875], [1375, 550, 1650, 800], [1240, 675, 1400, 750]],  # Truck image: 4 boxes
    [[450, 170, 520, 350], [350, 190, 450, 350], [500, 170, 580, 350], [580, 170, 640, 350]]  # Groceries image: 4 boxes
]

# Update images for this example
raw_images = [raw_images[0], groceries_image]  # truck and groceries

inputs = processor(images=raw_images, input_boxes=input_boxes, return_tensors="pt").to(model.device)

with torch.no_grad():
    outputs = model(**inputs, multimask_output=False)

all_masks = processor.post_process_masks(outputs.pred_masks.cpu(), inputs["original_sizes"])
print(f"Processed {len(input_boxes)} images with {len(input_boxes[0])} and {len(input_boxes[1])} boxes respectively")
Processed 2 images with 4 and 4 boxes respectively
print(f"IoU scores: {outputs.iou_scores.squeeze()}")
IoU scores: tensor([0.9301, 0.9348, 0.6605, 0.9465], device='cuda:0')

Sử dụng Mặt nạ Trước đó làm Đầu vào

EdgeTAM có thể sử dụng các mặt nạ từ các dự đoán trước đó làm đầu vào để tinh chỉnh phân đoạn:

# Get initial segmentation
input_points = [[[[500, 375]]]]
input_labels = [[[1]]]
inputs = processor(images=raw_image, input_points=input_points, input_labels=input_labels, return_tensors="pt").to(model.device)

with torch.no_grad():
    outputs = model(**inputs)

# Use the best mask as input for refinement
mask_input = outputs.pred_masks[:, :, torch.argmax(outputs.iou_scores.squeeze())]

# Add additional points with the mask input
new_input_points = [[[[500, 375], [450, 300]]]]
new_input_labels = [[[1, 1]]]
inputs = processor(
    input_points=new_input_points,
    input_labels=new_input_labels,
    original_sizes=inputs["original_sizes"],
    return_tensors="pt",
).to(model.device)

with torch.no_grad():
    refined_outputs = model(
        **inputs,
        input_masks=mask_input,
        image_embeddings=outputs.image_embeddings,
        multimask_output=False,
    )

EdgeTamConfig

lớp transformers.EdgeTamConfig

< >

( transformers_version: str | None = Nonearchitectures: list[str] | None = Noneoutput_hidden_states: bool | None = Falsereturn_dict: bool | None = Truedtype: str | torch.dtype | None = Nonechunk_size_feed_forward: int = 0is_encoder_decoder: bool = Falseid2label: dict[int, str] | dict[str, str] | None = Nonelabel2id: dict[str, int] | dict[str, str] | None = Noneproblem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = Nonevision_config: dict | transformers.configuration_utils.PreTrainedConfig | None = Noneprompt_encoder_config: dict | transformers.configuration_utils.PreTrainedConfig | None = Nonemask_decoder_config: dict | transformers.configuration_utils.PreTrainedConfig | None = Noneinitializer_range: float = 0.02 )

Tham số

  • vision_config (Union[dict, ~configuration_utils.PreTrainedConfig], tùy chọn) — Đối tượng cấu hình hoặc từ điển của bộ khung thị giác.
  • prompt_encoder_config (Union[dict, EdgeTamPromptEncoderConfig], tuỳ chọn) — Từ điển các tùy chọn cấu hình được sử dụng để khởi tạo EdgeTamPromptEncoderConfig.
  • mask_decoder_config (Union[dict, EdgeTamMaskDecoderConfig], tuỳ chọn) — Từ điển các tùy chọn cấu hình được dùng để khởi tạo EdgeTamMaskDecoderConfig.
  • initializer_range (float, tùy chọn, mặc định là 0.02) — Độ lệch chuẩn của truncated_normal_initializer để khởi tạo tất cả các ma trận trọng số.

Đây là lớp cấu hình để lưu trữ cấu hình của một EdgeTamModel. Nó được sử dụng để khởi tạo một mô hình Edgetam theo các đối số được chỉ định, xác định kiến trúc của mô hình. Khởi tạo một cấu hình với các giá trị mặc định sẽ tạo ra một cấu hình tương tự như cấu hình của yonigozlan/EdgeTAM-hf

Các đối tượng cấu hình kế thừa từ PreTrainedConfig và có thể được sử dụng để kiểm soát đầu ra của mô hình. Đọc tài liệu từ PreTrainedConfig để biết thêm thông tin.

Ví dụ:

>>> from transformers import (
...     EdgeTamVisionConfig,
...     EdgeTamPromptEncoderConfig,
...     EdgeTamMaskDecoderConfig,
...     EdgeTamModel,
... )

>>> # Initializing a EdgeTamConfig with `"facebook/edgetam.1_hiera_tiny"` style configuration
>>> configuration = EdgeTamConfig()

>>> # Initializing a EdgeTamModel (with random weights) from the `"facebook/edgetam.1_hiera_tiny"` style configuration
>>> model = EdgeTamModel(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

>>> # We can also initialize a EdgeTamConfig from a EdgeTamVisionConfig, EdgeTamPromptEncoderConfig, and EdgeTamMaskDecoderConfig
>>> # Initializing EDGETAM vision encoder, memory attention, and memory encoder configurations
>>> vision_config = EdgeTamVisionConfig()
>>> prompt_encoder_config = EdgeTamPromptEncoderConfig()
>>> mask_decoder_config = EdgeTamMaskDecoderConfig()

>>> config = EdgeTamConfig(vision_config, prompt_encoder_config, mask_decoder_config)

EdgeTamVisionConfig

lớp transformers.EdgeTamVisionConfig

< >

( transformers_version: str | None = Nonearchitectures: list[str] | None = Noneoutput_hidden_states: bool | None = Falsereturn_dict: bool | None = Truedtype: str | torch.dtype | None = Nonechunk_size_feed_forward: int = 0is_encoder_decoder: bool = Falseid2label: dict[int, str] | dict[str, str] | None = Nonelabel2id: dict[str, int] | dict[str, str] | None = Noneproblem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = Nonebackbone_config: dict | transformers.configuration_utils.PreTrainedConfig | None = Nonebackbone_channel_list: list[int] | None = Nonebackbone_feature_sizes: list | None = Nonefpn_hidden_size: int = 256fpn_kernel_size: int = 1fpn_stride: int = 1fpn_padding: int = 0fpn_top_down_levels: list[int] | None = Nonenum_feature_levels: int = 3hidden_act: str = 'gelu'layer_norm_eps: float = 1e-06initializer_range: float = 0.02 )

Tham số

  • backbone_config (Union[dict, ~configuration_utils.PreTrainedConfig], tùy chọn) — Cấu hình của mô hình backbone.
  • backbone_channel_list (List[int], tùy chọn, mặc định là [384, 192, 96, 48]) — Danh sách các chiều kênh của backbone.
  • backbone_feature_sizes (List[List[int]], tùy chọn, mặc định là [[256, 256], [128, 128], [64, 64]]) — Kích thước không gian của các bản đồ đặc trưng từ backbone.
  • fpn_hidden_size (int, tùy chọn, mặc định là 256) — Chiều ẩn của FPN.
  • fpn_kernel_size (int, tùy chọn, mặc định là 1) — Kích thước kernel cho các phép tích chập trong neck.
  • fpn_stride (int, tùy chọn, mặc định là 1) — Stride cho các lớp convolution trong neck.
  • fpn_padding (int, tùy chọn, mặc định là 0) — Độ đệm cho các phép tích chập trong neck.
  • fpn_top_down_levels (List[int], tùy chọn, mặc định là [2, 3]) — Các mức cho các kết nối FPN từ trên xuống.
  • num_feature_levels (int, tùy chọn, mặc định là 3) — Số lượng cấp độ đặc trưng từ FPN được sử dụng.
  • hidden_act (str, tùy chọn, mặc định là gelu) — Hàm kích hoạt phi tuyến (hàm hoặc chuỗi) trong bộ giải mã. Ví dụ, "gelu", "relu", "silu", v.v.
  • layer_norm_eps (float, tùy chọn, mặc định là 1e-06) — Giá trị epsilon được sử dụng bởi các lớp chuẩn hóa lớp (layer normalization).
  • initializer_range (float, tùy chọn, mặc định là 0.02) — Độ lệch chuẩn của truncated_normal_initializer để khởi tạo tất cả các ma trận trọng số.

Đây là lớp cấu hình để lưu trữ cấu hình của một EdgeTamModel. Nó được sử dụng để khởi tạo một mô hình Edgetam theo các đối số được chỉ định, xác định kiến trúc của mô hình. Khởi tạo một cấu hình với các giá trị mặc định sẽ tạo ra một cấu hình tương tự như cấu hình của yonigozlan/EdgeTAM-hf

Các đối tượng cấu hình kế thừa từ PreTrainedConfig và có thể được sử dụng để kiểm soát đầu ra của mô hình. Đọc tài liệu từ PreTrainedConfig để biết thêm thông tin.

EdgeTamMaskDecoderConfig

lớp transformers.EdgeTamMaskDecoderConfig

< >

( transformers_version: str | None = Nonearchitectures: list[str] | None = Noneoutput_hidden_states: bool | None = Falsereturn_dict: bool | None = Truedtype: str | torch.dtype | None = Nonechunk_size_feed_forward: int = 0is_encoder_decoder: bool = Falseid2label: dict[int, str] | dict[str, str] | None = Nonelabel2id: dict[str, int] | dict[str, str] | None = Noneproblem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = Nonehidden_size: int = 256hidden_act: str = 'gelu'mlp_dim: int = 2048num_hidden_layers: int = 2num_attention_heads: int = 8attention_downsample_rate: int = 2num_multimask_outputs: int = 3iou_head_depth: int = 3iou_head_hidden_dim: int = 256dynamic_multimask_via_stability: bool = Truedynamic_multimask_stability_delta: float = 0.05dynamic_multimask_stability_thresh: float = 0.98 )

Tham số

  • hidden_size (int, tùy chọn, mặc định là 256) — Kích thước của các biểu diễn ẩn.
  • hidden_act (str, tùy chọn, mặc định là gelu) — Hàm kích hoạt phi tuyến (hàm hoặc chuỗi) trong bộ giải mã. Ví dụ, "gelu", "relu", "silu", v.v.
  • mlp_dim (int, tùy chọn, mặc định là 2048) — Kích thước của MLP trong transformer hai chiều.
  • num_hidden_layers (int, tùy chọn, mặc định là 2) — Số lượng lớp ẩn trong bộ giải mã Transformer.
  • num_attention_heads (int, tùy chọn, mặc định là 8) — Số lượng đầu attention cho mỗi lớp attention trong bộ giải mã Transformer.
  • attention_downsample_rate (int, tùy chọn, mặc định là 2) — Tỷ lệ hạ mẫu cho các lớp attention.
  • num_multimask_outputs (int, tùy chọn, mặc định là 3) — Số lượng đầu ra đa mặt nạ.
  • iou_head_depth (int, tùy chọn, mặc định là 3) — Độ sâu của đầu IoU.
  • iou_head_hidden_dim (int, tùy chọn, mặc định là 256) — Chiều ẩn của đầu IoU.
  • dynamic_multimask_via_stability (bool, tùy chọn, mặc định là True) — Có sử dụng dynamic multimask qua stability hay không.
  • dynamic_multimask_stability_delta (float, tùy chọn, mặc định là 0.05) — Delta ổn định cho dynamic multimask.
  • dynamic_multimask_stability_thresh (float, tùy chọn, mặc định là 0.98) — Ngưỡng ổn định cho dynamic multimask.

Đây là lớp cấu hình để lưu trữ cấu hình của một EdgeTamModel. Nó được sử dụng để khởi tạo một mô hình Edgetam theo các đối số được chỉ định, xác định kiến trúc của mô hình. Khởi tạo một cấu hình với các giá trị mặc định sẽ tạo ra một cấu hình tương tự như cấu hình của yonigozlan/EdgeTAM-hf

Các đối tượng cấu hình kế thừa từ PreTrainedConfig và có thể được sử dụng để kiểm soát đầu ra của mô hình. Đọc tài liệu từ PreTrainedConfig để biết thêm thông tin.

EdgeTamPromptEncoderConfig

lớp transformers.EdgeTamPromptEncoderConfig

< >

( transformers_version: str | None = Nonearchitectures: list[str] | None = Noneoutput_hidden_states: bool | None = Falsereturn_dict: bool | None = Truedtype: str | torch.dtype | None = Nonechunk_size_feed_forward: int = 0is_encoder_decoder: bool = Falseid2label: dict[int, str] | dict[str, str] | None = Nonelabel2id: dict[str, int] | dict[str, str] | None = Noneproblem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = Nonehidden_size: int = 256image_size: int | list[int] | tuple[int, int] = 1024patch_size: int | list[int] | tuple[int, int] = 16mask_input_channels: int = 16num_point_embeddings: int = 4hidden_act: str = 'gelu'layer_norm_eps: float = 1e-06scale: int = 1 )

Tham số

  • hidden_size (int, tùy chọn, mặc định là 256) — Kích thước của các biểu diễn ẩn.
  • image_size (Union[int, list[int], tuple[int, int]], tùy chọn, mặc định là 1024) — Kích thước (độ phân giải) của mỗi hình ảnh.
  • patch_size (Union[int, list[int], tuple[int, int]], tùy chọn, mặc định là 16) — Kích thước (độ phân giải) của mỗi patch.
  • mask_input_channels (int, tùy chọn, mặc định là 16) — Số lượng kênh được đưa vào module MaskDecoder.
  • num_point_embeddings (int, tùy chọn, mặc định là 4) — Số lượng point embeddings sẽ được sử dụng.
  • hidden_act (str, tùy chọn, mặc định là gelu) — Hàm kích hoạt phi tuyến (hàm hoặc chuỗi) trong bộ giải mã. Ví dụ, "gelu", "relu", "silu", v.v.
  • layer_norm_eps (float, tùy chọn, mặc định là 1e-06) — Giá trị epsilon được sử dụng bởi các lớp chuẩn hóa lớp (layer normalization).
  • scale (float, tùy chọn, mặc định là 1) — Hệ số tỷ lệ cho bộ mã hóa prompt.

Đây là lớp cấu hình để lưu trữ cấu hình của một EdgeTamModel. Nó được sử dụng để khởi tạo một mô hình Edgetam theo các đối số được chỉ định, xác định kiến trúc của mô hình. Khởi tạo một cấu hình với các giá trị mặc định sẽ tạo ra một cấu hình tương tự như cấu hình của yonigozlan/EdgeTAM-hf

Các đối tượng cấu hình kế thừa từ PreTrainedConfig và có thể được sử dụng để kiểm soát đầu ra của mô hình. Đọc tài liệu từ PreTrainedConfig để biết thêm thông tin.

EdgeTamVisionModel

lớp transformers.EdgeTamVisionModel

< >

( config: EdgeTamVisionConfig )

Tham số

  • config (EdgeTamVisionConfig) — Lớp cấu hình mô hình chứa tất cả các tham số của mô hình. Khởi tạo bằng tệp cấu hình không tải trọng số liên quan đến mô hình, chỉ tải cấu hình. Xem phương thức from_pretrained() để tải trọng số mô hình.

Mô hình thị giác từ EdgeTAM không có đầu (head) hay lớp chiếu (projection) nào ở phía trên.

Mô hình này kế thừa từ PreTrainedModel. Xem tài liệu của lớp cha để biết các phương thức chung mà thư viện triển khai cho tất cả các mô hình của nó (chẳng hạn như tải xuống hoặc lưu trữ, thay đổi kích thước các nhúng đầu vào, cắt tỉa các đầu, v.v.)

Mô hình này cũng là một lớp con của torch.nn.Module trong PyTorch. Hãy sử dụng nó như một Module PyTorch thông thường và tham khảo tài liệu PyTorch cho mọi vấn đề liên quan đến cách sử dụng và hành vi chung.

forward

< >

( pixel_values: typing.Optional[torch.Tensor] = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> )

EdgeTamModel

lớp transformers.EdgeTamModel

< >

( config: EdgeTamConfig )

Tham số

  • config (EdgeTamConfig) — Lớp cấu hình mô hình chứa tất cả các tham số của mô hình. Khởi tạo bằng tệp cấu hình không tải trọng số liên quan đến mô hình, chỉ tải cấu hình. Xem phương thức from_pretrained() để tải trọng số của mô hình.

Mô hình Segment Anything 2 (SAM 2) để tạo các mặt nạ phân đoạn, dựa trên ảnh đầu vào và các điểm, nhãn, hộp hoặc mặt nạ đầu vào.

Mô hình này kế thừa từ PreTrainedModel. Xem tài liệu của lớp cha để biết các phương thức chung mà thư viện triển khai cho tất cả các mô hình của nó (chẳng hạn như tải xuống hoặc lưu trữ, thay đổi kích thước các nhúng đầu vào, cắt tỉa các đầu, v.v.)

Mô hình này cũng là một lớp con của torch.nn.Module trong PyTorch. Hãy sử dụng nó như một Module PyTorch thông thường và tham khảo tài liệu PyTorch cho mọi vấn đề liên quan đến cách sử dụng và hành vi chung.

forward

< >

( pixel_values: typing.Optional[torch.Tensor] = Noneinput_points: typing.Optional[torch.Tensor] = Noneinput_labels: typing.Optional[torch.LongTensor] = Noneinput_boxes: typing.Optional[torch.Tensor] = Noneinput_masks: typing.Optional[torch.LongTensor] = Noneimage_embeddings: typing.Optional[torch.Tensor] = Nonemultimask_output: bool = Trueattention_similarity: typing.Optional[torch.Tensor] = Nonetarget_embedding: typing.Optional[torch.Tensor] = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → EdgeTamImageSegmentationOutput or tuple(torch.Tensor)

Tham số

  • pixel_values (torch.Tensor có hình dạng (batch_size, num_channels, image_size, image_size), tùy chọn) — Các tensor tương ứng với các hình ảnh đầu vào. Giá trị pixel có thể được lấy bằng cách sử dụng Sam2ImageProcessor. Xem Sam2ImageProcessor.call() để biết chi tiết (Sam2Processor sử dụng Sam2ImageProcessor để xử lý hình ảnh).
  • input_points (torch.Tensor có hình dạng (batch_size, num_points, 2)) — Các điểm không gian 2D đầu vào, được bộ mã hóa prompt sử dụng để mã hóa prompt. Thông thường cho kết quả tốt hơn đáng kể. Các điểm này có thể được lấy bằng cách truyền một danh sách các danh sách con vào bộ xử lý, bộ xử lý sẽ tạo ra các tensor torch tương ứng có chiều 4. Chiều đầu tiên là kích thước lô ảnh, chiều thứ hai là kích thước lô điểm (tức là số lượng mặt nạ phân đoạn mà chúng ta muốn mô hình dự đoán cho mỗi điểm đầu vào), chiều thứ ba là số điểm cho mỗi mặt nạ phân đoạn (có thể truyền nhiều điểm cho một mặt nạ duy nhất), và chiều cuối cùng là tọa độ x (dọc) và y (ngang) của điểm. Nếu số lượng điểm được truyền khác nhau cho mỗi ảnh, hoặc cho mỗi mặt nạ, bộ xử lý sẽ tạo ra các điểm “PAD” tương ứng với tọa độ (0, 0), và việc tính toán nhúng sẽ bị bỏ qua cho các điểm này bằng cách sử dụng nhãn.
  • input_labels (torch.LongTensor có hình dạng (batch_size, point_batch_size, num_points)) — Nhãn đầu vào cho các điểm, được sử dụng bởi prompt encoder để mã hóa prompt. Theo triển khai chính thức, có 3 loại nhãn
    • 1: điểm đó là một điểm chứa đối tượng cần quan tâm
    • 0: điểm đó là một điểm không chứa đối tượng cần quan tâm
    • -1: điểm tương ứng với nền

    Chúng tôi đã thêm nhãn:

    • -10: điểm này là điểm đệm, do đó nên được bộ mã hóa prompt bỏ qua

    Các nhãn đệm nên được xử lý tự động bởi bộ xử lý.

  • input_boxes (torch.Tensor có shape (batch_size, num_boxes, 4)) — Các hộp đầu vào cho các điểm, được prompt encoder sử dụng để mã hóa prompt. Thường cho ra các mask được tạo ra tốt hơn nhiều. Các hộp có thể được lấy bằng cách truyền một danh sách các danh sách con vào processor, từ đó tạo ra một torch tensor, trong đó mỗi chiều lần lượt tương ứng với kích thước batch ảnh, số lượng hộp trên mỗi ảnh và tọa độ của điểm góc trên bên trái và góc dưới bên phải của hộp. Theo thứ tự (x1, y1, x2, y2):
    • x1: tọa độ x của điểm góc trên bên trái của hộp đầu vào
    • y1: tọa độ y của điểm góc trên bên trái của hộp đầu vào
    • x2: tọa độ x của điểm góc dưới bên phải của hộp đầu vào
    • y2: tọa độ y của điểm góc dưới bên phải của hộp đầu vào
  • input_masks (torch.Tensor có shape (batch_size, image_size, image_size)) — Mô hình SAM cũng chấp nhận các mask phân đoạn (segmentation masks) làm đầu vào. Mask sẽ được nhúng (embed) bởi prompt encoder để tạo ra một embedding tương ứng, sau đó được đưa vào mask decoder. Người dùng cần tự động cung cấp các mask này, và chúng phải có shape (batch_size, image_size, image_size).
  • image_embeddings (torch.Tensor có hình dạng (batch_size, output_channels, window_size, window_size)) — Các embedding của ảnh, được bộ giải mã mặt nạ (mask decoder) sử dụng để tạo ra các mặt nạ và điểm iou. Để tính toán hiệu quả bộ nhớ hơn, người dùng có thể lấy trước các embedding của ảnh bằng phương thức get_image_embeddings, sau đó truyền chúng vào phương thức forward thay vì truyền pixel_values.
  • multimask_output (bool, tùy chọn) — Trong bản triển khai và bài báo gốc, mô hình luôn xuất ra 3 mask cho mỗi ảnh (hoặc cho mỗi điểm / mỗi bounding box nếu liên quan). Tuy nhiên, có thể chỉ xuất ra một mask duy nhất, tương ứng với mask “tốt nhất”, bằng cách chỉ định multimask_output=False.
  • attention_similarity (torch.Tensor, tùy chọn) — Tensor tương đồng attention, được cung cấp cho mask decoder để thực hiện attention có hướng dẫn theo mục tiêu trong trường hợp mô hình được sử dụng cho cá nhân hóa như đã giới thiệu trong PerSAM.
  • target_embedding (torch.Tensor, tùy chọn) — Embedding của khái niệm đích, được cung cấp cho bộ giải mã mặt nạ để thực hiện gợi ý ngữ nghĩa đích trong trường hợp mô hình được sử dụng cho cá nhân hóa như đã giới thiệu trong PerSAM.

Trả về

EdgeTamImageSegmentationOutput hoặc tuple(torch.Tensor)

Một EdgeTamImageSegmentationOutput hoặc một tuple của torch.Tensor (nếu return_dict=False được truyền hoặc khi config.return_dict=False) bao gồm các thành phần khác nhau tùy thuộc vào cấu hình (EdgeTamConfig) và đầu vào.

Phương thức forward của EdgeTamModel ghi đè phương thức đặc biệt __call__.

Mặc dù công thức cho bước truyền tiến cần được định nghĩa bên trong hàm này, người dùng nên gọi instance của Module sau đó thay vì gọi hàm này, vì instance Module sẽ đảm nhận việc thực hiện các bước tiền xử lý và hậu xử lý, trong khi hàm này sẽ lặng lẽ bỏ qua chúng.

  • iou_scores (torch.Tensor có hình dạng (batch_size, point_batch_size, num_masks)) — Điểm số Intersection over Union (IoU) của các mask dự đoán.
  • pred_masks (torch.Tensor có hình dạng (batch_size, point_batch_size, num_masks, height, width)) — Các mặt nạ độ phân giải thấp được dự đoán. Đây là một alias cho low_res_masks. Các mặt nạ này cần được xử lý hậu kỳ bởi processor để đưa về kích thước ảnh gốc.
  • object_score_logits (torch.Tensor có hình dạng (batch_size, point_batch_size, 1)) — Logits cho điểm số đối tượng, cho biết có đối tượng hiện diện hay không.
  • image_embeddings (tuple(torch.Tensor)) — Các đặc trưng từ FPN, được sử dụng bởi bộ giải mã mask. Đây là một tuple của torch.Tensor trong đó mỗi tensor có hình dạng (batch_size, channels, height, width).
  • vision_hidden_states (tuple(torch.Tensor), tuỳ chọn, được trả về khi output_hidden_states=True) — Tuple của torch.Tensor (một cho đầu ra của mỗi giai đoạn) có hình dạng (batch_size, height, width, hidden_size). Trạng thái ẩn (hidden-states) của mô hình thị giác tại đầu ra của mỗi giai đoạn.
  • vision_attentions (tuple(torch.Tensor), tuỳ chọn, trả về khi output_attentions=True) — Tuple của torch.Tensor (một cho mỗi lớp) có hình dạng (batch_size, num_heads, sequence_length, sequence_length). Trọng số chú ý của mô hình thị giác.
  • mask_decoder_attentions (tuple(torch.Tensor), tuỳ chọn, trả về khi output_attentions=True) — Tuple của torch.Tensor (một cho mỗi lớp) có hình dạng (batch_size, num_heads, sequence_length, sequence_length). Trọng số chú ý của mask decoder.

Ví dụ:

>>> from PIL import Image
>>> from huggingface_hub.utils import httpx
>>> from io import BytesIO
>>> from transformers import AutoModel, AutoProcessor

>>> model = AutoModel.from_pretrained("danelcsb/edgetam.1_hiera_tiny")
>>> processor = AutoProcessor.from_pretrained("danelcsb/edgetam.1_hiera_tiny")

>>> url = "https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/transformers/model_doc/sam-car.png"
>>> with httpx.stream("GET", url) as response:
...     raw_image = Image.open(BytesIO(response.read())).convert("RGB")
>>> input_points = [[[400, 650]]]  # 2D location of a window on the car
>>> inputs = processor(images=raw_image, input_points=input_points, return_tensors="pt")

>>> # Get segmentation mask
>>> outputs = model(**inputs)

>>> # Postprocess masks
>>> masks = processor.post_process_masks(
...     outputs.pred_masks, inputs["original_sizes"]
... )

get_image_features

< >

( pixel_values: Tensor**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → EdgeTamVisionEncoderOutput or tuple(torch.Tensor)

Tham số

  • pixel_values (torch.Tensor) — Giá trị pixel đầu vào có hình dạng (batch_size, num_channels, height, width).

Trả về

EdgeTamVisionEncoderOutput hoặc tuple(torch.Tensor)

Một EdgeTamVisionEncoderOutput hoặc một tuple của torch.Tensor (nếu return_dict=False được truyền hoặc khi config.return_dict=False) bao gồm các thành phần khác nhau tùy thuộc vào cấu hình (EdgeTamConfig) và đầu vào.

  • last_hidden_state (torch.Tensor có hình dạng (batch_size, height, width, hidden_size)) — Chuỗi các hidden-state tại đầu ra của lớp cuối cùng của mô hình.

  • pooler_output (torch.Tensor có hình dạng (batch_size, hidden_size)) — Trạng thái ẩn của lớp cuối cùng của token đầu tiên trong chuỗi (token phân loại) sau khi được xử lý thêm qua các lớp được sử dụng cho tác vụ tiền huấn luyện bổ trợ. Ví dụ, đối với các mô hình thuộc họ BERT, giá trị này trả về token phân loại sau khi được xử lý qua một lớp tuyến tính và một hàm kích hoạt tanh. Trọng số của lớp tuyến tính được huấn luyện từ mục tiêu dự đoán câu tiếp theo (phân loại) trong quá trình tiền huấn luyện.

  • hidden_states (tuple(torch.Tensor), tuỳ chọn, được trả về khi output_hidden_states=True được truyền vào hoặc khi config.output_hidden_states=True) — Bộ tuple của torch.Tensor (một cho đầu ra của embeddings, nếu mô hình có lớp embedding, + một cho đầu ra của mỗi lớp) có hình dạng (batch_size, sequence_length, hidden_size).

    Trạng thái ẩn của mô hình tại đầu ra của mỗi lớp cùng với các đầu ra embedding ban đầu tùy chọn.

  • attentions (tuple(torch.Tensor), tuỳ chọn, được trả về khi output_attentions=True được truyền vào hoặc khi config.output_attentions=True) — Tuple của torch.Tensor (một cho mỗi lớp) có hình dạng (batch_size, num_heads, sequence_length, sequence_length).

    Trọng số chú ý sau softmax của attention, được sử dụng để tính trung bình có trọng số trong các đầu self-attention.

  • fpn_hidden_states (tuple(torch.Tensor)) — Tuple của torch.Tensor (một tensor cho mỗi mức đặc trưng, từ độ phân giải cao xuống thấp) có hình dạng (batch_size, hidden_size, height, width). Các bản đồ đặc trưng từ phần neck của Feature Pyramid Network.

  • fpn_position_encoding (tuple(torch.Tensor)) — Tuple của torch.Tensor (một cho mỗi mức đặc trưng, từ độ phân giải cao xuống thấp) có hình dạng (batch_size, hidden_size, height, width). Các mã hóa vị trí tương ứng với fpn_hidden_states.

Ví dụ:

Update on GitHub