Transformers documentation
SwiftFormer
이 모델은 2023-03-27에 HF papers에 게시되었으며, 2023-05-12에 Hugging Face Transformers에 기여되었습니다.
SwiftFormer
개요
SwiftFormer 모델은 Abdelrahman Shaker, Muhammad Maaz, Hanoona Rasheed, Salman Khan, Ming-Hsuan Yang, Fahad Shahbaz Khan이 SwiftFormer: Efficient Additive Attention for Transformer-based Real-time Mobile Vision Applications에서 제안했습니다.
SwiftFormer 논문은 자기 주의(self-attention) 계산에서 이차적 행렬 곱셈 연산을 선형 요소별 곱셈으로 효과적으로 대체하는 새로운 효율적 가산적 주의(additive attention) 메커니즘을 소개합니다. 이를 기반으로 ‘SwiftFormer’이라는 일련의 모델이 구축되었으며, 정확도와 모바일 추론 속도 모두에서 최첨단 성능을 달성합니다. 소형 변형 모델조차 iPhone 14에서 0.8 ms의 지연 시간으로 78.5%의 top-1 ImageNet1K 정확도를 달성하여, MobileViT-v2보다 정확도가 높고 2배 빠릅니다.
해당 논문의 초록은 다음과 같습니다:
Self-attention은 다양한 비전 애플리케이션에서 전역 컨텍스트를 포착하기 위한 사실상 표준 선택이 되었습니다. 그러나 이미지 해상도에 대한 2차 계산 복잡성으로 인해 실시간 애플리케이션, 특히 리소스가 제한된 모바일 기기에서의 배포에 사용이 제한됩니다. 컨볼루션과 self-attention의 장점을 결합하여 속도-정확도 트레이드오프를 개선하기 위한 하이브리드 접근법이 제안되었지만, self-attention의 비용이 높은 행렬 곱셈 연산은 여전히 병목 현상을 일으킵니다. 본 연구에서는 2차 행렬 곱셈 연산을 선형 요소별 곱셈으로 효과적으로 대체하는 새로운 효율적 가산 attention 메커니즘을 소개합니다. 우리의 설계는 정확도를 희생하지 않고도 key-value 상호작용을 선형 레이어로 대체할 수 있음을 보여줍니다. 이전의 최첨단 방법들과 달리, 우리의 효율적인 self-attention 수식은 네트워크의 모든 단계에서 사용 가능하게 합니다. 제안된 효율적 가산 attention을 사용하여 "SwiftFormer"이라는 이름의 모델 시리즈를 구축했으며, 정확도와 모바일 추론 속도 모두에서 최첨단 성능을 달성합니다. 우리의 소형 변형은 iPhone 14에서 0.8ms의 지연 시간으로 78.5%의 top-1 ImageNet-1K 정확도를 달성하며, MobileViT-v2보다 정확도가 높고 2배 빠릅니다.
이 모델은 shehan97님이 기여했습니다. 원본 코드는 여기에서 찾을 수 있습니다.
SwiftFormerConfig
class transformers.SwiftFormerConfig
< source >( 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 = Noneimage_size: int | list[int] | tuple[int, int] = 224num_channels: int = 3depths: list[int] | tuple[int, ...] = (3, 3, 6, 4)embed_dims: list[int] | tuple[int, ...] = (48, 56, 112, 220)mlp_ratio: int = 4downsamples: list[bool] | tuple[bool, ...] = (True, True, True, True)hidden_act: str = 'gelu'down_patch_size: int | list[int] | tuple[int, int] = 3down_stride: int = 2down_pad: int = 1drop_path_rate: float | int = 0.0drop_mlp_rate: float | int = 0.0drop_conv_encoder_rate: float | int = 0.0use_layer_scale: bool = Truelayer_scale_init_value: float = 1e-05batch_norm_eps: float = 1e-05 )
매개변수
- image_size (
Union[int, list[int], tuple[int, int]], 선택 사항, 기본값224) — 각 이미지의 크기(해상도). - num_channels (
int, 선택 사항, 기본값3) — 입력 채널의 수입니다. - depths (
Union[list[int], tuple[int, ...]], 선택 사항, 기본값(3, 3, 6, 4)) — Transformer의 각 레이어 깊이. - embed_dims (
list[int], 선택 사항, 기본값[48, 56, 112, 220]) — 각 단계의 임베딩 차원 - mlp_ratio (
int, 선택 사항, 기본값4) — MLP 은닉 차원과 임베딩 차원의 비율입니다. - downsamples (
list[bool], 선택 사항, 기본값[True, True, True, True]) — 두 단계 사이에 입력을 다운샘플링할지 여부입니다. - hidden_act (
str, 선택 사항, 기본값gelu) — 디코더에서 사용되는 비선형 활성화 함수(함수 또는 문자열)입니다. 예를 들어,"gelu","relu","silu"등이 있습니다. - down_patch_size (
int, 선택 사항, 기본값 3) — 하위 샘플링 레이어에서 패치의 크기입니다. - down_stride (
int, 선택 사항, 기본값 2) — 하위 샘플링 레이어에서 컨볼루션 커널의 스트라이드입니다. - down_pad (
int, 선택 사항, 기본값 1) — 하위 샘플링 레이어의 패딩. - drop_path_rate (
Union[float, int], 선택 사항, 기본값0.0) — 패치 융합에 사용할 드롭 패스 비율입니다. - drop_mlp_rate (
float, 선택 사항, 기본값 0.0) — SwiftFormer의 MLP 구성 요소에 적용되는 dropout rate입니다. - drop_conv_encoder_rate (
float, 선택 사항, 기본값 0.0) — SwiftFormer의 ConvEncoder 구성 요소에 적용되는 dropout rate입니다. - use_layer_scale (
bool, 선택 사항, 기본값True) — 토크 믹서 출력에 스케일링을 적용할지 여부. - layer_scale_init_value (
float, 선택 사항, 기본값1e-05) — self-attention 레이어에서 사용할 스케일 값입니다. base 모델은 0.1, large 모델은 1e-6을 사용합니다. layer scale을 비활성화하려면 0으로 설정하세요. - batch_norm_eps (
float, 선택 사항, 기본값1e-05) — batch normalization 레이어에서 사용되는 epsilon 값입니다.
이것은 SwiftFormerModel의 설정을 저장하기 위한 설정 클래스입니다. 지정된 인자에 따라 Swiftformer 모델을 인스턴스화하여 모델 아키텍처를 정의하는 데 사용됩니다. 기본값으로 설정을 인스턴스화하면 MBZUAI/swiftformer-xs와 유사한 설정이 생성됩니다.
Configuration 객체는 PreTrainedConfig를 상속하며 모델 출력을 제어하는 데 사용할 수 있습니다. 자세한 내용은 PreTrainedConfig의 문서를 참고하세요.
예:
>>> from transformers import SwiftFormerConfig, SwiftFormerModel
>>> # Initializing a SwiftFormer swiftformer-base-patch16-224 style configuration
>>> configuration = SwiftFormerConfig()
>>> # Initializing a model (with random weights) from the swiftformer-base-patch16-224 style configuration
>>> model = SwiftFormerModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configSwiftFormerModel
클래스 transformers.SwiftFormerModel
< source >( config: SwiftFormerConfig )
매개변수
- config (SwiftFormerConfig) — 모델의 모든 매개변수를 포함하는 모델 구성 클래스입니다. 구성 파일로 초기화하는 것은 모델과 관련된 가중치를 로드하지 않으며, 구성 정보만 로드합니다. 모델 가중치를 로드하려면 from_pretrained() 메서드를 확인하세요.
특정 헤드가 없는 맨 Swiftformer 모델로, 원시 hidden-states를 출력합니다.
이 모델은 PreTrainedModel에서 상속됩니다. 라이브러리가 모든 모델에 대해 구현하는 일반적 메서드(다운로드 또는 저장, 입력 임베딩 크기 조정, 헤드 프루닝 등)에 대한 세부 사항은 상위 클래스 문서를 확인하세요.
이 모델은 또한 PyTorch torch.nn.Module의 하위 클래스입니다. 일반적인 PyTorch Module처럼 사용하며, 일반적인 사용법 및 동작과 관련된 모든 사항은 PyTorch 문서를 참조하세요.
forward
< source >( pixel_values: typing.Optional[torch.Tensor] = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → BaseModelOutputWithNoAttention or tuple(torch.FloatTensor)
매개변수
- pixel_values (
torch.Tensor, shape(batch_size, num_channels, image_size, image_size), 선택 사항) — 입력 이미지에 해당하는 텐서입니다. 픽셀 값은 ViTImageProcessor를 사용하여 얻을 수 있습니다. 자세한 내용은 ViTImageProcessor.call()를 참조하세요 (processor_class는 이미지 처리에 ViTImageProcessor를 사용합니다). - output_hidden_states (
bool, 선택 사항) — 모든 레이어의 hidden states를 반환할지 여부입니다. 자세한 내용은 반환되는 텐서 중hidden_states항목을 참고하세요. - return_dict (
bool, 선택) — 일반 튜플 대신 ModelOutput를 반환할지 여부.
반환값
BaseModelOutputWithNoAttention 또는 tuple(torch.FloatTensor)
BaseModelOutputWithNoAttention 또는 torch.FloatTensor의 튜플(return_dict=False가 전달되었거나 config.return_dict=False인 경우)로, 구성(SwiftFormerConfig)과 입력에 따라 다양한 요소를 포함합니다.
SwiftFormerModel의 forward 메서드는 __call__ 특수 메서드를 오버라이드합니다.
이 함수 내에서 forward pass의 레시피를 정의해야 하지만, 이후에는 이 함수 대신
Module인스턴스를 호출해야 합니다. 전자는 전처리 및 후처리 단계를 실행하는 것을 처리하는 반면, 후자는 이를 조용히 무시하기 때문입니다.
last_hidden_state (
torch.FloatTensor, shape(batch_size, num_channels, height, width)) — 모델의 마지막 레이어 출력에서 생성된 hidden-state 시퀀스입니다.hidden_states (
tuple(torch.FloatTensor), 선택 사항,output_hidden_states=True가 전달되었거나config.output_hidden_states=True인 경우 반환됨) —torch.FloatTensor의 튜플(모델에 임베딩 레이어가 있는 경우 임베딩 출력용 1개 + 각 레이어의 출력용 1개)로, 모양은(batch_size, num_channels, height, width)입니다.각 레이어의 출력에서 모델의 Hidden-states와 선택적 초기 임베딩 출력을 포함합니다.
SwiftFormerForImageClassification
class transformers.SwiftFormerForImageClassification
< source >( config: SwiftFormerConfig )
매개변수
- config (SwiftFormerConfig) — 모델의 모든 매개변수를 포함하는 모델 구성 클래스입니다. 구성 파일로 초기화하는 것은 모델과 관련된 가중치를 로드하지 않으며, 구성 정보만 로드합니다. 모델 가중치를 로드하려면 from_pretrained() 메서드를 확인하세요.
ImageNet과 같은 작업에 사용되는 이미지 분류 헤드가 위에 있는 Swiftformer 모델.
이 모델은 PreTrainedModel에서 상속됩니다. 라이브러리가 모든 모델에 대해 구현하는 일반적 메서드(다운로드 또는 저장, 입력 임베딩 크기 조정, 헤드 프루닝 등)에 대한 세부 사항은 상위 클래스 문서를 확인하세요.
이 모델은 또한 PyTorch torch.nn.Module의 하위 클래스입니다. 일반적인 PyTorch Module처럼 사용하며, 일반적인 사용법 및 동작과 관련된 모든 사항은 PyTorch 문서를 참조하세요.
forward
< source >( pixel_values: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.Tensor] = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → ImageClassifierOutputWithNoAttention or tuple(torch.FloatTensor)
매개변수
- pixel_values (
torch.Tensor, shape(batch_size, num_channels, image_size, image_size), 선택 사항) — 입력 이미지에 해당하는 텐서입니다. 픽셀 값은 ViTImageProcessor를 사용하여 얻을 수 있습니다. 자세한 내용은 ViTImageProcessor.call()를 참조하세요 (processor_class는 이미지 처리에 ViTImageProcessor를 사용합니다). - labels (
torch.LongTensor, shape(batch_size,), 선택 사항) — 이미지 분류/회귀 손실을 계산하는 데 사용되는 라벨입니다. 인덱스는[0, ..., config.num_labels - 1]범위에 있어야 합니다.config.num_labels == 1인 경우 회귀 손실(평균 제곱 오차)이 계산되고,config.num_labels > 1인 경우 분류 손실(교차 엔트로피)이 계산됩니다. - output_hidden_states (
bool, 선택 사항) — 모든 레이어의 hidden states를 반환할지 여부입니다. 자세한 내용은 반환되는 텐서 중hidden_states항목을 참고하세요. - return_dict (
bool, 선택) — 일반 튜플 대신 ModelOutput를 반환할지 여부.
반환값
ImageClassifierOutputWithNoAttention 또는 tuple(torch.FloatTensor)
torch.FloatTensor의 튜플 또는 ImageClassifierOutputWithNoAttention입니다. return_dict=False가 전달되었거나 config.return_dict=False인 경우, SwiftFormerConfig와 입력에 따라 다양한 요소를 포함합니다.
SwiftFormerForImageClassification의 forward 메서드는 __call__ 특수 메서드를 오버라이드합니다.
이 함수 내에서 forward pass의 레시피를 정의해야 하지만, 이후에는 이 함수 대신
Module인스턴스를 호출해야 합니다. 전자는 전처리 및 후처리 단계를 실행하는 것을 처리하는 반면, 후자는 이를 조용히 무시하기 때문입니다.
- loss (
torch.FloatTensor, shape(1,), 선택 사항,labels가 제공될 때 반환됨) — 분류(또는 config.num_labels==1인 경우 회귀) 손실. - logits (
torch.FloatTensor, shape(batch_size, config.num_labels)) — SoftMax 적용 전 분류(또는 config.num_labels==1인 경우 회귀) 점수. - hidden_states (
tuple(torch.FloatTensor), 선택,output_hidden_states=True가 전달되었거나config.output_hidden_states=True인 경우 반환됨) —torch.FloatTensor의 튜플(모델에 임베딩 레이어가 있는 경우 임베딩 출력용 1개 + 각 단계의 출력용 1개)로, 모양은(batch_size, num_channels, height, width)입니다. 각 단계의 출력에서 모델의 히든 스테이트(피처 맵이라고도 함).
예:
>>> from transformers import AutoImageProcessor, SwiftFormerForImageClassification
>>> import torch
>>> from datasets import load_dataset
>>> dataset = load_dataset("huggingface/cats-image")
>>> image = dataset["test"]["image"][0]
>>> image_processor = AutoImageProcessor.from_pretrained("MBZUAI/swiftformer-xs")
>>> model = SwiftFormerForImageClassification.from_pretrained("MBZUAI/swiftformer-xs")
>>> inputs = image_processor(image, return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> # model predicts one of the 1000 ImageNet classes
>>> predicted_label = logits.argmax(-1).item()
>>> print(model.config.id2label[predicted_label])
...