Transformers documentation

SwiftFormer

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

Mô hình này được công bố trên HF papers vào ngày 27-03-2023 và được đóng góp cho Hugging Face Transformers vào ngày 12-05-2023.

SwiftFormer

Tổng quan

Mô hình SwiftFormer được đề xuất trong SwiftFormer: Efficient Additive Attention for Transformer-based Real-time Mobile Vision Applications bởi Abdelrahman Shaker, Muhammad Maaz, Hanoona Rasheed, Salman Khan, Ming-Hsuan Yang, Fahad Shahbaz Khan.

Bài báo SwiftFormer giới thiệu một cơ chế chú ý cộng hiệu quả mới, thay thế hiệu quả các phép nhân ma trận bậc hai trong tính toán tự chú ý bằng các phép nhân từng phần tử tuyến tính. Một loạt các mô hình có tên ‘SwiftFormer’ được xây dựng dựa trên cơ chế này, đạt hiệu suất tiên tiến về cả độ chính xác lẫn tốc độ suy luận trên thiết bị di động. Ngay cả biến thể nhỏ của chúng cũng đạt độ chính xác top-1 78,5% trên ImageNet1K với độ trễ chỉ 0,8 ms trên iPhone 14, chính xác hơn và nhanh gấp 2 lần so với MobileViT-v2.

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

Self-attention đã trở thành lựa chọn mặc định để nắm bắt ngữ cảnh toàn cục trong nhiều ứng dụng thị giác. Tuy nhiên, độ phức tạp tính toán bậc hai của nó theo độ phân giải ảnh hạn chế việc sử dụng trong các ứng dụng thời gian thực, đặc biệt là khi triển khai trên các thiết bị di động có tài nguyên hạn chế. Mặc dù các phương pháp lai đã được đề xuất để kết hợp ưu điểm của convolution và self-attention nhằm đạt được sự đánh đổi tốc độ - độ chính xác tốt hơn, các phép nhân ma trận đắt đỏ trong self-attention vẫn là nút thắt cổ chai. Trong công việc này, chúng tôi giới thiệu một cơ chế additive attention hiệu quả mới, thay thế hiệu quả các phép nhân ma trận bậc hai bằng các phép nhân từng phần tử tuyến tính. Thiết kế của chúng tôi cho thấy tương tác key-value có thể được thay thế bằng một lớp tuyến tính mà không làm giảm bất kỳ độ chính xác nào. Khác với các phương pháp tiên tiến trước đây, công thức self-attention hiệu quả của chúng tôi cho phép sử dụng nó ở tất cả các giai đoạn của mạng. Sử dụng additive attention hiệu quả do chúng tôi đề xuất, chúng tôi xây dựng một loạt các mô hình gọi là “SwiftFormer”, đạt hiệu suất tiên tiến về cả độ chính xác và tốc độ suy luận trên di động. Biến thể nhỏ của chúng tôi đạt độ chính xác top-1 78,5% trên ImageNet-1K với độ trễ chỉ 0,8 ms trên iPhone 14, chính xác hơn và nhanh gấp 2 lần so với MobileViT-v2.

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

SwiftFormerConfig

lớp transformers.SwiftFormerConfig

< >

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

Tham số

  • image_size (Union[int, list[int], tuple[int, int]], tùy chọn, mặc định là 224) — Kích thước (độ phân giải) của mỗi hình ảnh.
  • num_channels (int, tùy chọn, mặc định là 3) — Số lượng kênh đầu vào.
  • depths (Union[list[int], tuple[int, ...]], tùy chọn, mặc định là (3, 3, 6, 4)) — Độ sâu của từng lớp trong Transformer.
  • embed_dims (list[int], tùy chọn, mặc định là [48, 56, 112, 220]) — Kích thước embedding ở mỗi giai đoạn
  • mlp_ratio (int, tùy chọn, mặc định là 4) — Tỷ lệ giữa chiều ẩn của MLP và chiều nhúng.
  • downsamples (list[bool], tùy chọn, mặc định là [True, True, True, True]) — Có giảm mẫu đầu vào giữa hai giai đoạn hay khô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.
  • down_patch_size (int, tùy chọn, mặc định là 3) — Kích thước của các patch trong các lớp hạ mẫu.
  • down_stride (int, tùy chọn, mặc định là 2) — Bước nhảy (stride) của các nhân (kernel) tích chập trong các lớp hạ mẫu (downsampling).
  • down_pad (int, tùy chọn, mặc định là 1) — Đệm trong các lớp hạ mẫu.
  • drop_path_rate (Union[float, int], tùy chọn, mặc định là 0.0) — Tỷ lệ drop path cho việc hợp nhất patch.
  • drop_mlp_rate (float, tùy chọn, mặc định là 0.0) — Tỷ lệ dropout cho thành phần MLP của SwiftFormer.
  • drop_conv_encoder_rate (float, tùy chọn, mặc định là 0.0) — Tỷ lệ dropout cho thành phần ConvEncoder của SwiftFormer.
  • use_layer_scale (bool, tùy chọn, mặc định là True) — Có nên nhân các đầu ra từ bộ trộn token (token mixers) hay không.
  • layer_scale_init_value (float, tùy chọn, mặc định là 1e-05) — Hệ số tỷ lệ sử dụng trong các lớp self-attention. 0.1 cho base, 1e-6 cho large. Đặt 0 để vô hiệu hóa layer scale.
  • batch_norm_eps (float, tùy chọn, mặc định là 1e-05) — Giá trị epsilon được sử dụng bởi các lớp chuẩn hóa theo lô (batch normalization).

Đây là lớp cấu hình để lưu trữ cấu hình của một SwiftFormerModel. Nó được sử dụng để khởi tạo một mô hình Swiftformer 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 MBZUAI/swiftformer-xs

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 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.config

SwiftFormerModel

lớp transformers.SwiftFormerModel

< >

( config: SwiftFormerConfig )

Tham số

  • config (SwiftFormerConfig) — 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 Swiftformer cơ bản, xuất ra các hidden-states thô mà không có bất kỳ head cụ thể 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] = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → BaseModelOutputWithNoAttention 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 ViTImageProcessor. Xem ViTImageProcessor.call() để biết chi tiết (processor_class sử dụng ViTImageProcessor để xử lý hình ảnh).
  • output_hidden_states (bool, tùy chọn) — Có trả về trạng thái ẩn (hidden states) của tất cả các lớp hay không. Xem hidden_states trong phần tensor trả về để biết thêm chi tiết.
  • return_dict (bool, tùy chọn) — Có nên trả về một ModelOutput thay vì một tuple thông thường hay không.

Trả về

BaseModelOutputWithNoAttention hoặc tuple(torch.Tensor)

Một BaseModelOutputWithNoAttention 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 (SwiftFormerConfig) và đầu vào.

Phương thức forward của SwiftFormerModel ghi đè lên 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.

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

  • 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) — 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, num_channels, height, width).

    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.

Ví dụ:

SwiftFormerForImageClassification

lớp transformers.SwiftFormerForImageClassification

< >

( config: SwiftFormerConfig )

Tham số

  • config (SwiftFormerConfig) — 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 Swiftformer với đầu phân loại hình ảnh phía trên, ví dụ cho ImageNet.

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] = Nonelabels: typing.Optional[torch.Tensor] = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → ImageClassifierOutputWithNoAttention 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 ViTImageProcessor. Xem ViTImageProcessor.call() để biết chi tiết (processor_class sử dụng ViTImageProcessor để xử lý hình ảnh).
  • labels (torch.LongTensor có shape (batch_size,), tùy chọn) — Nhãn để tính loss phân loại/hồi quy ảnh. Các chỉ số phải nằm trong [0, ..., config.num_labels - 1]. Nếu config.num_labels == 1, loss hồi quy sẽ được tính (Mean-Square loss). Nếu config.num_labels > 1, loss phân loại sẽ được tính (Cross-Entropy).
  • output_hidden_states (bool, tùy chọn) — Có trả về trạng thái ẩn (hidden states) của tất cả các lớp hay không. Xem hidden_states trong phần tensor trả về để biết thêm chi tiết.
  • return_dict (bool, tùy chọn) — Có nên trả về một ModelOutput thay vì một tuple thông thường hay không.

Trả về

ImageClassifierOutputWithNoAttention hoặc tuple(torch.Tensor)

Một ImageClassifierOutputWithNoAttention 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 (SwiftFormerConfig) và đầu vào.

Phương thức forward của SwiftFormerForImageClassification ghi đè lên 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.

  • loss (torch.Tensor có shape (1,), optional, được trả về khi labels được cung cấp) — Loss phân loại (hoặc hồi quy nếu config.num_labels==1).
  • logits (torch.Tensor có hình dạng (batch_size, config.num_labels)) — Điểm phân loại (hoặc hồi quy nếu config.num_labels==1) (trước SoftMax).
  • 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) — 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 giai đoạn) có hình dạng (batch_size, num_channels, height, width). Hidden-states (còn được gọi là feature maps) của mô hình tại đầu ra của mỗi giai đoạn.

Ví dụ:

>>> 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])
...
Update on GitHub