Transformers documentation

SAM-HQ

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

and get access to the augmented documentation experience

to get started

이 모델은 2023-06-02에 HF papers에 게시되었으며, 2025-04-28에 Hugging Face Transformers에 기여되었습니다.

SAM-HQ

개요

SAM-HQ(High-Quality Segment Anything Model)는 Lei Ke, Mingqiao Ye, Martin Danelljan, Yifan Liu, Yu-Wing Tai, Chi-Keung Tang, Fisher Yu가 Segment Anything in High Quality에서 제안했습니다.

이 모델은 원래의 SAM 모델을 개선한 것으로, SAM의 원래 프롬프터블 설계, 효율성, 제로샷 일반화 능력을 유지하면서 훨씬 더 높은 품질의 분할 마스크를 생성합니다.

example image

SAM-HQ는 원래 SAM 모델에 비해 몇 가지 주요 개선 사항을 도입했습니다:

  1. 고품질 출력 토큰: 더 높은 품질의 마스크 예측을 위해 SAM의 마스크 디코더에 주입되는 학습 가능한 토큰
  2. Global-local Feature Fusion: 모델의 다양한 단계에서 추출된 특징을 결합하여 마스크의 세부 사항을 개선합니다
  3. 학습 데이터: SA-1B 대신 44K개의 고품질 마스크로 구성된 정교하게 큐레이션된 데이터셋을 사용합니다
  4. 효율성: 추가 매개변수를 0.5%만 추가하면서 마스크 품질을 크게 향상시킵니다
  5. Zero-shot 기능: SAM의 강력한 zero-shot 성능을 유지하면서 정확도를 향상

해당 논문의 초록은 다음과 같습니다:

최근 발표된 Segment Anything Model(SAM)은 세그멘테이션 모델의 스케일업에 있어 큰 도약을 이루었으며, 강력한 제로샷(zero-shot) 기능과 유연한 프롬프팅을 가능하게 합니다. 11억 개의 마스크로 학습되었음에도 불구하고, SAM의 마스크 예측 품질은 복잡한 구조를 가진 객체를 다룰 때를 포함해 많은 경우에서 기대에 미치지 못합니다. 우리는 SAM의 원래 프롬프터블 설계, 효율성, 제로샷 일반화 능력을 유지하면서 모든 객체를 정확하게 세그멘테이션할 수 있는 능력을 SAM에 부여하는 HQ-SAM을 제안합니다. 우리의 신중한 설계는 SAM의 사전 학습된 모델 가중치를 재사용하고 보존하면서, 최소한의 추가 파라미터와 계산만 도입합니다. 우리는 학습 가능한 High-Quality Output Token을 설계하여 SAM의 마스크 디코더에 주입하며, 이 토큰은 고품질 마스크 예측을 담당합니다. 마스크 디코더 특징에만 적용하는 대신, 더 나은 마스크 디테일을 위해 먼저 초기 및 최종 ViT 특징과 융합합니다. 도입한 학습 가능한 파라미터를 학습하기 위해, 여러 출처에서 44K개의 세밀한 마스크로 구성된 데이터셋을 구성했습니다. HQ-SAM은 44k 마스크로 구성된 이 도입된 데이터셋에서만 학습되며, 8개의 GPU에서 단 4시간만 소요됩니다.

팁:

  • SAM-HQ는 원래 SAM 모델보다 더 높은 품질의 마스크를 생성하며, 특히 복잡한 구조와 세밀한 디테일을 가진 객체에서 그 차이가 두드러집니다
  • 모델은 더 정확한 경계와 얇은 구조에 대한 더 나은 처리를 통해 바이너리 마스크를 예측합니다
  • SAM과 마찬가지로, 이 모델은 입력 2D 점과/또는 입력 바운딩 박스를 함께 사용할 때 더 나은 성능을 보입니다.
  • …
  • 모델은 SAM의 제로샷 일반화 기능을 유지합니다
  • SAM-HQ는 SAM에 비해 약 0.5%의 추가 파라미터만 추가합니다
  • 모델의 Fine-tuning은 아직 지원되지 않습니다

이 모델은 sushmanth님이 기여했습니다. 원본 코드는 여기에서 찾을 수 있습니다.

… 이미지와 2D 점을 입력으로 받아 마스크를 생성하는 방법의 예시입니다:

import requests
import torch
from PIL import Image

from transformers import SamHQModel, SamHQProcessor


model = SamHQModel.from_pretrained("syscv-community/sam-hq-vit-base", device_map="auto")
processor = SamHQProcessor.from_pretrained("syscv-community/sam-hq-vit-base")

img_url = "https://huggingface.co/ybelkada/segment-anything/resolve/main/assets/car.png"
raw_image = Image.open(requests.get(img_url, stream=True).raw).convert("RGB")
input_points = [[[450, 600]]]  # 2D location of a window in the image

inputs = processor(raw_image, input_points=input_points, return_tensors="pt").to(model.device)
with torch.no_grad():
    outputs = model(**inputs)

masks = processor.image_processor.post_process_masks(
    outputs.pred_masks.cpu(), inputs["original_sizes"].cpu(), inputs["reshaped_input_sizes"].cpu()
)
scores = outputs.iou_scores

프로세서를 통해 입력 이미지와 함께 자체 마스크를 처리하여 모델에 전달할 수도 있습니다:

import requests
import torch
from PIL import Image

from transformers import SamHQModel, SamHQProcessor


model = SamHQModel.from_pretrained("syscv-community/sam-hq-vit-base", device_map="auto")
processor = SamHQProcessor.from_pretrained("syscv-community/sam-hq-vit-base")

img_url = "https://huggingface.co/ybelkada/segment-anything/resolve/main/assets/car.png"
raw_image = Image.open(requests.get(img_url, stream=True).raw).convert("RGB")
mask_url = "https://huggingface.co/ybelkada/segment-anything/resolve/main/assets/car.png"
segmentation_map = Image.open(requests.get(mask_url, stream=True).raw).convert("1")
input_points = [[[450, 600]]]  # 2D location of a window in the image

inputs = processor(raw_image, input_points=input_points, segmentation_maps=segmentation_map, return_tensors="pt").to(model.device)
with torch.no_grad():
    outputs = model(**inputs)

masks = processor.image_processor.post_process_masks(
    outputs.pred_masks.cpu(), inputs["original_sizes"].cpu(), inputs["reshaped_input_sizes"].cpu()
)
scores = outputs.iou_scores

리소스

SAM-HQ 시작을 돕기 위한 공식 Hugging Face 및 커뮤니티(🌎로 표시) 리소스 목록입니다:

SamHQConfig

class transformers.SamHQConfig

< >

( 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.02tie_word_embeddings: bool = True )

매개변수

  • vision_config (Union[dict, ~configuration_utils.PreTrainedConfig], 선택) — 비전 백본의 config 객체 또는 사전입니다.
  • prompt_encoder_config (Union[dict, SamHQPromptEncoderConfig], 선택) — SamHQPromptEncoderConfig를 초기화하는 데 사용되는 구성 옵션의 사전.
  • mask_decoder_config (Union[dict, SamHQMaskDecoderConfig], 선택) — SamHQMaskDecoderConfig를 초기화하는 데 사용되는 설정 옵션의 사전.
  • initializer_range (float, 선택 사항, 기본값 0.02) — 모든 가중치 행렬을 초기화하는 truncated_normal_initializer의 표준 편차입니다.
  • tie_word_embeddings (bool, 선택, 기본값 True) — 모델의 tied_weights_keys 매핑에 따라 가중치 임베딩을 묶을지 여부.

이것은 SamHQModel의 설정을 저장하기 위한 설정 클래스입니다. 지정된 인자에 따라 Sam Hq 모델을 인스턴스화하고 모델 아키텍처를 정의하는 데 사용됩니다. 기본값으로 설정을 인스턴스화하면 syscv-community/sam-hq-vit-base와 유사한 설정이 생성됩니다.

Configuration 객체는 PreTrainedConfig를 상속하며 모델 출력을 제어하는 데 사용할 수 있습니다. 자세한 내용은 PreTrainedConfig의 문서를 참고하세요.

SamHQVisionConfig

클래스 transformers.SamHQVisionConfig

< >

( 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 = 768output_channels: int = 256num_hidden_layers: int = 12num_attention_heads: int = 12num_channels: int = 3image_size: int | list[int] | tuple[int, int] = 1024patch_size: int | list[int] | tuple[int, int] = 16hidden_act: str = 'gelu'layer_norm_eps: float = 1e-06attention_dropout: float | int = 0.0initializer_range: float = 1e-10qkv_bias: bool = Truemlp_ratio: float = 4.0use_abs_pos: bool = Trueuse_rel_pos: bool = Truewindow_size: int = 14global_attn_indexes: list[int] | tuple[int, ...] = (2, 5, 8, 11)num_pos_feats: int = 128mlp_dim: int | None = None )

매개변수

  • hidden_size (int, 선택 사항, 기본값 768) — 숨겨진 표현의 차원입니다.
  • output_channels (int, 선택 사항, 기본값 256) — Patch Encoder의 출력 채널 차원입니다.
  • num_hidden_layers (int, 선택 사항, 기본값 12) — Transformer 디코더의 숨겨진 레이어 수.
  • num_attention_heads (int, 선택 사항, 기본값 12) — Transformer decoder의 각 attention layer에 사용할 attention head의 수입니다.
  • num_channels (int, 선택 사항, 기본값 3) — 입력 채널의 수입니다.
  • image_size (Union[int, list[int], tuple[int, int]], 선택, 기본값 1024) — 각 이미지의 크기(해상도)입니다.
  • patch_size (Union[int, list[int], tuple[int, int]], 선택 사항, 기본값 16) — 각 패치의 크기(해상도)입니다.
  • hidden_act (str, 선택 사항, 기본값 gelu) — 디코더에서 사용되는 비선형 활성화 함수(함수 또는 문자열)입니다. 예를 들어, "gelu", "relu", "silu" 등이 있습니다.
  • layer_norm_eps (float, 선택 사항, 기본값 1e-06) — 레이어 정규화 레이어에서 사용되는 epsilon 값입니다.
  • attention_dropout (Union[float, int], 선택 사항, 기본값 0.0) — Attention 확률에 적용할 dropout 비율입니다.
  • initializer_range (float, 선택 사항, 기본값 1e-10) — 모든 가중치 행렬을 초기화하는 truncated_normal_initializer의 표준 편차입니다.
  • qkv_bias (bool, 선택 사항, 기본값 True) — 쿼리, 키, 값에 bias를 추가할지 여부.
  • mlp_ratio (float, 선택 사항, 기본값 4.0) — 임베딩 차원에 대한 MLP 숨겨진 차원의 비율입니다.
  • use_abs_pos (bool, 선택 사항, 기본값 True) — 절대 위치 임베딩을 사용할지 여부입니다.
  • use_rel_pos (bool, 선택 사항, 기본값 True) — 상대 위치 임베딩을 사용할지 여부입니다.
  • window_size (int, 선택 사항, 기본값 14) — 상대 위치를 위한 윈도우 크기.
  • global_attn_indexes (list[int], 선택 사항, 기본값 [2, 5, 8, 11]) — 글로벌 어텐션 레이어의 인덱스입니다.
  • num_pos_feats (int, 선택 사항, 기본값 128) — 위치 임베딩의 차원입니다.
  • mlp_dim (int, 선택 사항) — Transformer 인코더의 MLP 레이어 차원입니다. None인 경우 기본값은 mlp_ratio * hidden_size입니다.

이것은 SamHQModel의 설정을 저장하기 위한 설정 클래스입니다. 지정된 인자에 따라 Sam Hq 모델을 인스턴스화하고 모델 아키텍처를 정의하는 데 사용됩니다. 기본값으로 설정을 인스턴스화하면 syscv-community/sam-hq-vit-base와 유사한 설정이 생성됩니다.

Configuration 객체는 PreTrainedConfig를 상속하며 모델 출력을 제어하는 데 사용할 수 있습니다. 자세한 내용은 PreTrainedConfig의 문서를 참고하세요.

예:

>>> from transformers import (
...     SamHQVisionConfig,
...     SamHQVisionModel,
... )

>>> # Initializing a SamHQVisionConfig with `"facebook/sam_hq-vit-huge"` style configuration
>>> configuration = SamHQVisionConfig()

>>> # Initializing a SamHQVisionModel (with random weights) from the `"facebook/sam_hq-vit-huge"` style configuration
>>> model = SamHQVisionModel(configuration)

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

SamHQMaskDecoderConfig

클래스 transformers.SamHQMaskDecoderConfig

< >

( 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 = 'relu'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 = 256layer_norm_eps: float = 1e-06vit_dim: int = 768 )

매개변수

  • hidden_size (int, 선택 사항, 기본값 256) — 숨겨진 표현의 차원입니다.
  • hidden_act (str, 선택 사항, 기본값 relu) — 디코더의 비선형 활성화 함수(함수 또는 문자열)입니다. 예를 들어, "gelu", "relu", "silu" 등이 있습니다.
  • mlp_dim (int, 선택 사항, 기본값 2048) — Transformer 인코더의 “중간” (즉, feed-forward) 레이어의 차원.
  • num_hidden_layers (int, 선택 사항, 기본값 2) — Transformer decoder의 숨겨진 레이어 수.
  • num_attention_heads (int, 선택 사항, 기본값 8) — Transformer decoder의 각 attention layer에 사용할 attention head의 수입니다.
  • attention_downsample_rate (int, 선택 사항, 기본값 2) — attention 레이어의 다운샘플링 비율입니다.
  • num_multimask_outputs (int, 선택 사항, 기본값 3) — SamMaskDecoder 모듈의 출력 개수입니다. Segment Anything 논문에서는 이 값이 3으로 설정되어 있습니다.
  • iou_head_depth (int, 선택 사항, 기본값 3) — IoU head 모듈의 레이어 수입니다.
  • iou_head_hidden_dim (int, 선택 사항, 기본값 256) — IoU head 모듈의 hidden states 차원입니다.
  • layer_norm_eps (float, 선택 사항, 기본값 1e-06) — 레이어 정규화 레이어에서 사용되는 epsilon 값입니다.
  • vit_dim (int, 선택 사항, 기본값 768) — SamHQMaskDecoder 모듈에서 사용되는 Vision Transformer(ViT)의 차원입니다.

이것은 SamHQModel의 설정을 저장하기 위한 설정 클래스입니다. 지정된 인자에 따라 Sam Hq 모델을 인스턴스화하고 모델 아키텍처를 정의하는 데 사용됩니다. 기본값으로 설정을 인스턴스화하면 syscv-community/sam-hq-vit-base와 유사한 설정이 생성됩니다.

Configuration 객체는 PreTrainedConfig를 상속하며 모델 출력을 제어하는 데 사용할 수 있습니다. 자세한 내용은 PreTrainedConfig의 문서를 참고하세요.

SamHQPromptEncoderConfig

class transformers.SamHQPromptEncoderConfig

< >

( 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-06 )

매개변수

  • hidden_size (int, 선택 사항, 기본값 256) — 숨겨진 표현의 차원입니다.
  • image_size (Union[int, list[int], tuple[int, int]], 선택, 기본값 1024) — 각 이미지의 크기(해상도)입니다.
  • patch_size (Union[int, list[int], tuple[int, int]], 선택 사항, 기본값 16) — 각 패치의 크기(해상도)입니다.
  • mask_input_channels (int, 선택 사항, 기본값 16) — MaskDecoder 모듈에 전달될 채널 수입니다.
  • num_point_embeddings (int, 선택 사항, 기본값 4) — 사용할 point embedding의 개수입니다.
  • hidden_act (str, 선택 사항, 기본값 gelu) — 디코더에서 사용되는 비선형 활성화 함수(함수 또는 문자열)입니다. 예를 들어, "gelu", "relu", "silu" 등이 있습니다.
  • layer_norm_eps (float, 선택 사항, 기본값 1e-06) — 레이어 정규화 레이어에서 사용되는 epsilon 값입니다.

이것은 SamHQModel의 설정을 저장하기 위한 설정 클래스입니다. 지정된 인자에 따라 Sam Hq 모델을 인스턴스화하고 모델 아키텍처를 정의하는 데 사용됩니다. 기본값으로 설정을 인스턴스화하면 syscv-community/sam-hq-vit-base와 유사한 설정이 생성됩니다.

Configuration 객체는 PreTrainedConfig를 상속하며 모델 출력을 제어하는 데 사용할 수 있습니다. 자세한 내용은 PreTrainedConfig의 문서를 참고하세요.

SamHQProcessor

class transformers.SamHQProcessor

< >

( image_processor )

매개변수

  • image_processor (SamImageProcessor) — 이미지 프로세서가 필수 입력값입니다.

이미지 프로세서를 단일 프로세서로 감싸는 SamHQProcessor를 생성합니다.

SamHQProcessor은 SamImageProcessor의 모든 기능을 제공합니다. 자세한 내용은 ~SamImageProcessor를 참고하세요.

__call__

< >

( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor'], NoneType] = None**kwargs: *<class 'transformers.models.sam_hq.processing_sam_hq.SamHQProcessorKwargs'> ) → ~feature_extraction_utils.BatchFeature

매개변수

  • images (Union[PIL.Image.Image, numpy.ndarray, torch.Tensor, list[PIL.Image.Image], list[numpy.ndarray], list[torch.Tensor]], 선택) — 전처리할 이미지입니다. 픽셀 값이 0에서 255 범위로 이루어진 단일 이미지 또는 배치 이미지를 기대합니다. 픽셀 값이 0에서 1 사이인 이미지를 전달하는 경우 do_rescale=False로 설정하세요.
  • segmentation_maps (ImageInput, kwargs, 선택) — 입력 이미지와 함께 처리할 ground truth segmentation map입니다. 이 map은 학습 또는 평가 목적으로 사용되며, 처리된 이미지의 차원에 맞게 리사이즈 및 정규화됩니다.
  • input_points (NestedList, kwargs, 선택) — 프롬프트 기반 분할을 위한 입력 점입니다. 각 점을 원본 이미지 공간의 [x, y] 좌표로 지정하는 [image_level, object_level, point_level, [x, y]] 구조의 중첩 리스트여야 합니다. 점은 모델에 전달되기 전에 대상 이미지 크기로 정규화됩니다.
  • input_labels (NestedList, kwargs, 선택 사항) — 입력 포인트의 라벨로, 각 포인트가 foreground(1)인지 background(0)인지를 나타냅니다. 구조가 [image_level, object_level, point_level]인 중첩 리스트여야 합니다. input_points와 동일한 구조(좌표 차원을 제외)여야 합니다.
  • input_boxes (NestedList, kwargs, 선택) — 프롬프트 기반 분할을 위한 바운딩 박스입니다. 각 박스가 [x1, y1, x2, y2] 좌표로 원본 이미지 공간에서 지정되는 [image_level, box_level, [x1, y1, x2, y2]] 구조의 중첩 리스트여야 합니다. 박스는 모델에 전달되기 전에 대상 이미지 크기로 정규화됩니다.
  • point_pad_value (int, kwargs, 선택 사항, 기본값 None) — 서로 길이가 다른 시퀀스를 배치할 때 입력 포인트를 패딩하는 데 사용되는 값입니다. 이 값은 패딩된 위치를 표시하며, 좌표 정규화 과정에서 유지되어 실제 포인트와 패딩을 구별하는 데 사용됩니다. None인 경우, 프로세서 구성의 기본 패딩 값이 사용됩니다.
  • mask_size (dict[str, *kwargs*, int], 선택) — "height"와 "width" 키를 사용하여 대상 마스크 크기를 지정하는 사전입니다. 이는 모델이 생성하는 출력 분할 마스크의 해상도를 결정합니다.
  • mask_pad_size (dict[str, *kwargs*, int], 선택) — "height"와 "width"를 키로 사용하여 마스크의 패딩 크기를 지정하는 사전입니다. 서로 다른 크기의 마스크를 배치할 때 일관된 차원을 유지하도록 하는 데 사용됩니다.
  • return_tensors (str 또는 TensorType, 선택 사항) — 설정된 경우, 특정 프레임워크의 텐서를 반환합니다. 허용되는 값은 다음과 같습니다:
    • 'pt': PyTorch torch.Tensor 객체를 반환합니다.
    • 'np': NumPy np.ndarray 객체를 반환합니다.
  • **kwargs (ProcessingKwargs, 선택) — 각 모달리티(텍스트, 이미지, 비디오, 오디오)에 대한 추가 처리 옵션입니다. 모델별 매개변수는 위에 나열되어 있으며, 지원되는 인수의 전체 목록은 TypedDict 클래스를 참조하세요.

반환값

~feature_extraction_utils.BatchFeature

  • data (dict, 선택) — call/pad 메서드가 반환하는 리스트/배열/텐서 딕셔너리(‘input_values’, ‘attention_mask’ 등).
  • tensor_type (Union[None, str, TensorType], 선택 사항) — 초기화 시 PyTorch/Numpy 텐서에서 정수 목록을 변환하려면 여기에 tensor_type를 지정할 수 있습니다.
  • skip_tensor_conversion (list[str] 또는 set[str], 선택 사항) — tensor_type가 지정된 경우에도 텐서로 변환하지 않아야 하는 키의 목록 또는 집합.

SamHQVisionModel

class transformers.SamHQVisionModel

< >

( config: SamHQVisionConfig )

매개변수

  • config (SamHQVisionConfig) — 모델의 모든 매개변수를 포함하는 모델 구성 클래스입니다. 구성 파일로 초기화하는 것은 모델과 연관된 가중치를 로드하지 않으며, 구성 정보만 로드합니다. 모델 가중치를 로드하려면 from_pretrained() 메서드를 확인하세요.

head나 projection이 없는 SamHQ의 vision model입니다.

이 모델은 PreTrainedModel에서 상속됩니다. 라이브러리가 모든 모델에 대해 구현하는 일반적 메서드(다운로드 또는 저장, 입력 임베딩 크기 조정, 헤드 프루닝 등)에 대한 세부 사항은 상위 클래스 문서를 확인하세요.

이 모델은 또한 PyTorch torch.nn.Module의 하위 클래스입니다. 일반적인 PyTorch Module처럼 사용하며, 일반적인 사용법 및 동작과 관련된 모든 사항은 PyTorch 문서를 참조하세요.

forward

< >

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

매개변수

  • pixel_values (torch.Tensor, shape (batch_size, num_channels, image_size, image_size), 선택 사항) — 입력 이미지에 해당하는 텐서입니다. 픽셀 값은 SamImageProcessor를 사용하여 얻을 수 있습니다. 자세한 내용은 SamImageProcessor.call()를 참조하세요 (SamHQProcessor는 이미지 처리에 SamImageProcessor를 사용합니다).

반환값

SamHQVisionEncoderOutput 또는 tuple(torch.Tensor)

SamHQVisionEncoderOutput 또는 torch.Tensor의 튜플(return_dict=False가 전달되었거나 config.return_dict=False인 경우)로, 구성(SamHQConfig)과 입력에 따라 다양한 요소를 포함합니다.

SamHQVisionModel의 forward 메서드는 __call__ 특수 메서드를 오버라이드합니다.

이 함수 내에서 forward pass의 레시피를 정의해야 하지만, 이후에는 이 함수 대신 Module 인스턴스를 호출해야 합니다. 전자는 전처리 및 후처리 단계를 실행하는 것을 처리하는 반면, 후자는 이를 조용히 무시하기 때문입니다.

  • image_embeds (torch.Tensor, shape (batch_size, output_dim), 선택 사항, 모델이 with_projection=True로 초기화될 때 반환됨) — pooler_output에 투영 계층을 적용하여 얻은 이미지 임베딩입니다.

  • last_hidden_state (torch.Tensor, shape (batch_size, sequence_length, hidden_size), 선택 사항) — 모델의 마지막 레이어 출력에서 생성된 hidden-state 시퀀스입니다.

  • hidden_states (tuple[torch.Tensor, ...], 선택 사항, output_hidden_states=True가 전달되거나 config.output_hidden_states=True인 경우 반환됨) — torch.Tensor의 튜플(모델에 임베딩 레이어가 있는 경우 임베딩의 출력에 대한 것 1개 + 각 레이어의 출력에 대한 것 1개)로, 모양은 (batch_size, sequence_length, hidden_size)입니다.

    각 레이어의 출력에서 모델의 Hidden-states와 선택적 초기 임베딩 출력을 포함합니다.

  • attentions (tuple[torch.Tensor, ...], 선택 사항, output_attentions=True가 전달되었거나 config.output_attentions=True인 경우 반환됨) — 각 레이어마다 하나씩 포함된 torch.Tensor의 튜플로, 모양은 (batch_size, num_heads, sequence_length, sequence_length)입니다.

    self-attention 헤드에서 가중 평균을 계산하는 데 사용되는 attention softmax 이후의 attention 가중치.

  • intermediate_embeddings (list(torch.Tensor), 선택) — 모델 내 특정 블록, 일반적으로 windowed attention이 없는 블록에서 수집된 중간 임베딩의 목록입니다. 목록의 각 요소의 shape은 (batch_size, sequence_length, hidden_size)입니다. 이것은 SAM-HQ에만 해당되며 base SAM에는 존재하지 않습니다.

SamHQModel

class transformers.SamHQModel

< >

( config: SamHQConfig )

매개변수

  • config (SamHQConfig) — 모델의 모든 매개변수를 포함하는 모델 구성 클래스입니다. 구성 파일로 초기화하는 것은 모델과 관련된 가중치를 로드하지 않으며, 구성 정보만 로드합니다. 모델 가중치를 로드하려면 from_pretrained() 메서드를 확인하세요.

입력 이미지와 선택적인 2D 위치 및 바운딩 박스를 기반으로 마스크를 생성하는 Segment Anything Model HQ (SAM-HQ).

이 모델은 PreTrainedModel에서 상속됩니다. 라이브러리가 모든 모델에 대해 구현하는 일반적 메서드(다운로드 또는 저장, 입력 임베딩 크기 조정, 헤드 프루닝 등)에 대한 세부 사항은 상위 클래스 문서를 확인하세요.

이 모델은 또한 PyTorch torch.nn.Module의 하위 클래스입니다. 일반적인 PyTorch Module처럼 사용하며, 일반적인 사용법 및 동작과 관련된 모든 사항은 PyTorch 문서를 참조하세요.

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 = Truehq_token_only: bool = Falseattention_similarity: typing.Optional[torch.Tensor] = Nonetarget_embedding: typing.Optional[torch.Tensor] = Noneintermediate_embeddings: list[torch.Tensor] | None = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> )

매개변수

  • pixel_values (torch.Tensor, shape (batch_size, num_channels, image_size, image_size), 선택 사항) — 입력 이미지에 해당하는 텐서입니다. 픽셀 값은 SamImageProcessor를 사용하여 얻을 수 있습니다. 자세한 내용은 SamImageProcessor.call()를 참조하세요 (SamHQProcessor는 이미지 처리에 SamImageProcessor를 사용합니다).
  • input_points (torch.Tensor, shape (batch_size, num_points, 2)) — 입력 2D 공간 점입니다. 프롬프트 인코더가 프롬프트를 인코딩하는 데 사용됩니다. 일반적으로 훨씬 더 나은 결과를 제공합니다. 이 점은 리스트의 리스트의 리스트를 프로세서에 전달하여 얻을 수 있으며, 프로세서는 차원이 4인 해당하는 torch 텐서를 생성합니다. 첫 번째 차원은 이미지 배치 크기, 두 번째 차원은 점 배치 크기(즉, 입력 점당 모델이 예측할 세그멘테이션 마스크의 개수), 세 번째 차원은 세그멘테이션 마스크당 점의 개수(단일 마스크에 여러 점을 전달할 수 있음)이며, 마지막 차원은 점의 x(수직) 및 y(수평) 좌표입니다. 이미지마다 또는 마스크마다 전달되는 점의 수가 서로 다른 경우, 프로세서는 (0, 0) 좌표에 해당하는 “PAD” 점을 생성하며, 라벨을 사용하여 이러한 점에 대한 임베딩 계산은 건너뜁니다.
  • input_labels (torch.LongTensor 형상 (batch_size, point_batch_size, num_points)) — 포인트에 대한 입력 라벨입니다. 프롬프트 인코더가 프롬프트를 인코딩하는 데 사용됩니다. 공식 구현에 따르면 라벨은 3가지 유형이 있습니다.
    • 1: 해당 지점은 관심 대상이 포함된 지점입니다
    • 0: 관심 대상이 포함되지 않은 점
    • -1: 해당 점은 배경에 해당

    을 추가했습니다:

    • -10: 해당 점은 패딩 포인트이므로 프롬프트 인코더에서 무시해야 합니다

    패딩 라벨은 프로세서에 의해 자동으로 처리되어야 합니다.

  • input_boxes (torch.Tensor shape (batch_size, num_boxes, 4)) — 을 가진 입력 박스입니다. 이 값은 프롬프트 인코더가 프롬프트를 인코딩하는 데 사용되며, 일반적으로 훨씬 더 나은 생성된 마스크를 제공합니다. 박스는 리스트의 리스트의 리스트를 프로세서에 전달하여 생성할 수 있으며, 이는 torch 텐서를 생성합니다. 각 차원은 각각 이미지 배치 크기, 이미지당 박스 수, 박스의 왼쪽 위 및 오른쪽 아래 점의 좌표에 해당합니다. 순서 (x1, y1, x2, y2):
    • x1: 입력 박스의 왼쪽 위 점의 x 좌표
    • y1: 입력 박스의 왼쪽 위 점의 y 좌표
    • x2: 입력 박스의 오른쪽 아래 점의 x 좌표
    • y2: 입력 박스의 오른쪽 아래 점의 y 좌표
  • input_masks (torch.Tensor, shape (batch_size, image_size, image_size)) — SAM_HQ 모델은 분할 마스크를 입력으로 받을 수도 있습니다. 해당 마스크는 프롬프트 인코더에 의해 임베딩되어 나중에 마스크 디코더에 전달됩니다. 이러한 마스크는 사용자가 직접 제공해야 하며, shape이 (batch_size, image_size, image_size)여야 합니다.
  • image_embeddings (torch.Tensor, shape (batch_size, output_channels, window_size, window_size)) — 이미지 임베딩입니다. 마스크 디코더가 마스크와 iou 점수를 생성하는 데 사용됩니다. 메모리 효율적인 계산을 위해, 사용자는 먼저 get_image_embeddings 메서드로 이미지 임베딩을 가져온 후, pixel_values 대신 이를 forward 메서드에 전달할 수 있습니다.
  • multimask_output (bool, 선택) — 원래 구현 및 논문에서는 모델이 항상 이미지당 3개의 마스크(해당하는 경우 점 또는 바운딩 박스당)를 출력합니다. 그러나 multimask_output=False를 지정하면 “최적”의 마스크에 해당하는 단일 마스크만 출력할 수 있습니다.
  • hq_token_only (bool, 선택, 기본값 False) — 마스크 생성에 HQ 토큰 경로만 사용할지 여부입니다. False인 경우 표준 경로와 HQ 경로를 모두 조합하여 사용합니다. 이것은 SAM-HQ의 아키텍처에 특화된 설정입니다.
  • attention_similarity (torch.Tensor, 선택 사항) — 모델이 PerSAM에서 소개된 개인화 용도로 사용되는 경우, 대상 기반 주의를 위해 마스크 디코더에 제공되는 어텐션 유사성 텐서입니다.
  • target_embedding (torch.Tensor, 선택 사항) — PerSAM에서 소개된 개인화 용도로 모델이 사용되는 경우, 대상 의미론적 프롬프팅을 위해 마스크 디코더에 제공되는 대상 개념 임베딩입니다.
  • intermediate_embeddings (List[torch.Tensor], 선택) — 비전 인코더의 non-windowed 블록에서 생성된 중간 임베딩으로, SAM-HQ에서 향상된 마스크 품질을 위해 사용됩니다. pixel_values 대신 사전 계산된 image_embeddings를 제공할 때 필수입니다.

SamHQModel의 forward 메서드는 __call__ 특수 메서드를 오버라이드합니다.

이 함수 내에서 forward pass의 레시피를 정의해야 하지만, 이후에는 이 함수 대신 Module 인스턴스를 호출해야 합니다. 전자는 전처리 및 후처리 단계를 실행하는 것을 처리하는 반면, 후자는 이를 조용히 무시하기 때문입니다.

예:

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

>>> model = AutoModel.from_pretrained("sushmanth/sam_hq_vit_b")
>>> processor = AutoProcessor.from_pretrained("sushmanth/sam_hq_vit_b")

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

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

>>> # For high-quality mask only
>>> outputs = model(**inputs, hq_token_only=True)

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