Transformers documentation

RegNet

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 30/03/2020 và được đóng góp cho Hugging Face Transformers vào ngày 07/04/2022.

RegNet

Tổng quan

Mô hình RegNet được đề xuất trong Designing Network Design Spaces bởi Ilija Radosavovic, Raj Prateek Kosaraju, Ross Girshick, Kaiming He, Piotr Dollár.

Các tác giả thiết kế các không gian tìm kiếm để thực hiện Tìm kiếm Kiến trúc Mạng nơ-ron (Neural Architecture Search - NAS). Họ bắt đầu từ một không gian tìm kiếm có số chiều cao và sau đó giảm dần không gian tìm kiếm một cách lặp lại bằng cách áp dụng các ràng buộc dựa trên thực nghiệm, được rút ra từ các mô hình có hiệu suất tốt nhất được lấy mẫu bởi không gian tìm kiếm hiện tại.

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

Trong công trình này, chúng tôi trình bày một nguyên tắc thiết kế mạng mới. Mục tiêu của chúng tôi là giúp thúc đẩy sự hiểu biết về thiết kế mạng và khám phá các nguyên tắc thiết kế có khả năng khái quát hóa qua nhiều bối cảnh. Thay vì tập trung vào việc thiết kế các phiên bản mạng riêng lẻ, chúng tôi thiết kế các không gian thiết kế mạng tham số hóa các quần thể mạng. Quy trình tổng thể tương tự như việc thiết kế thủ công truyền thống các mạng, nhưng được nâng lên cấp độ không gian thiết kế. Sử dụng phương pháp luận của chúng tôi, chúng tôi khám phá khía cạnh cấu trúc của thiết kế mạng và đạt được một không gian thiết kế có số chiều thấp, bao gồm các mạng đơn giản, đều đặn mà chúng tôi gọi là RegNet. Ý tưởng cốt lõi của tham số hóa RegNet lại đơn giản đến bất ngờ: bề rộng và độ sâu của các mạng tốt có thể được giải thích bằng một hàm tuyến tính lượng tử hóa. Chúng tôi phân tích không gian thiết kế RegNet và đạt được những phát hiện thú vị không khớp với thực hành thiết kế mạng hiện tại. Không gian thiết kế RegNet cung cấp các mạng đơn giản và nhanh, hoạt động tốt trên một phạm vi rộng các chế độ flop. Với các cài đặt huấn luyện và số flop tương đương, các mô hình RegNet vượt trội hơn các mô hình EfficientNet phổ biến trong khi nhanh hơn tới 5 lần trên GPU.

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

Mô hình 10B lớn từ Self-supervised Pretraining of Visual Features in the Wild, được huấn luyện trên một tỷ hình ảnh Instagram, có sẵn trên hub

Tài nguyên

Danh sách các tài nguyên chính thức của Hugging Face và cộng đồng (được đánh dấu bằng 🌎) để giúp bạn bắt đầu với RegNet.

Image Classification

Nếu bạn quan tâm đến việc gửi một tài nguyên để được đưa vào đây, hãy thoải mái mở một Pull Request và chúng tôi sẽ xem xét! Lý tưởng nhất là tài nguyên nên minh họa một điều gì đó mới thay vì sao chép một tài nguyên hiện có.

RegNetConfig

lớp transformers.RegNetConfig

< >

( 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 = Nonenum_channels: int = 3embedding_size: int = 32hidden_sizes: list[int] | tuple[int, ...] = (128, 192, 512, 1088)depths: list[int] | tuple[int, ...] = (2, 6, 12, 2)groups_width: int = 64layer_type: str = 'y'hidden_act: str = 'relu'downsample_in_first_stage: bool = True )

Tham số

  • num_channels (int, tùy chọn, mặc định là 3) — Số lượng kênh đầu vào.
  • embedding_size (int, tùy chọn, mặc định là 32) — Kích thước của các embedding và hidden states.
  • hidden_sizes (Union[list[int], tuple[int, ...]], tùy chọn, mặc định là (128, 192, 512, 1088)) — Kích thước ẩn (hidden size) ở mỗi giai đoạn của mô hình.
  • depths (Union[list[int], tuple[int, ...]], tùy chọn, mặc định là (2, 6, 12, 2)) — Độ sâu của từng lớp trong Transformer.
  • groups_width (int, tùy chọn, mặc định là 64) — Chiều rộng của nhóm cho mỗi giai đoạn.
  • layer_type (str, optional, defaults to "y") — The layer to use, it can be either "x" or “y”. An xlayer is a ResNet's BottleNeck layer withreductionfixed to1. While a ylayer is ax` but with squeeze and excitation. Please refer to the paper for a detailed explanation of how these layers were constructed.
  • hidden_act (str, tùy chọn, mặc định là relu) — 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.
  • downsample_in_first_stage (bool, tùy chọn, mặc định là False) — Nếu True, giai đoạn đầu tiên sẽ giảm mẫu các đầu vào bằng cách sử dụng stride là 2.

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

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 RegNetConfig, RegNetModel

>>> # Initializing a RegNet regnet-y-40 style configuration
>>> configuration = RegNetConfig()
>>> # Initializing a model from the regnet-y-40 style configuration
>>> model = RegNetModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config

RegNetModel

lớp transformers.RegNetModel

< >

( config: RegNetConfig )

Tham số

  • config (RegNetConfig) — 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 Regnet 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: Tensoroutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → BaseModelOutputWithPoolingAndNoAttention or tuple(torch.Tensor)

Tham số

  • pixel_values (torch.Tensor có hình dạng (batch_size, num_channels, image_size, image_size)) — 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 ConvNextImageProcessor. Xem ConvNextImageProcessor.call() để biết chi tiết (processor_class sử dụng ConvNextImageProcessor để 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ề

BaseModelOutputWithPoolingAndNoAttention hoặc tuple(torch.Tensor)

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

Phương thức forward của RegNetModel 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.

  • 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 sau khi thực hiện phép pooling trên các chiều không gian.

  • 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ụ:

RegNetForImageClassification

lớp transformers.RegNetForImageClassification

< >

( config: RegNetConfig )

Tham số

  • config (RegNetConfig) — 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 RegNet với đầu phân loại hình ảnh phía trên (một lớp tuyến tính phía trên các đặc trưng đã được pool), 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.LongTensor] = 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 ConvNextImageProcessor. Xem ConvNextImageProcessor.call() để biết chi tiết (processor_class sử dụng ConvNextImageProcessor để 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 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 (RegNetConfig) và đầu vào.

Phương thức forward của RegNetForImageClassification 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, RegNetForImageClassification
>>> import torch
>>> from datasets import load_dataset

>>> dataset = load_dataset("huggingface/cats-image")
>>> image = dataset["test"]["image"][0]

>>> image_processor = AutoImageProcessor.from_pretrained("facebook/regnet-y-040")
>>> model = RegNetForImageClassification.from_pretrained("facebook/regnet-y-040")

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