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

이 모델은 2020-03-30에 HF papers에 게시되었으며, 2022-04-07에 Hugging Face Transformers에 기여되었습니다.

RegNet

개요

RegNet 모델은 Ilija Radosavovic, Raj Prateek Kosaraju, Ross Girshick, Kaiming He, Piotr Dollár이 Designing Network Design Spaces에서 제안했습니다.

저자들은 Neural Architecture Search(NAS)를 수행하기 위한 탐색 공간을 설계합니다. 먼저 고차원 탐색 공간에서 시작하여, 현재 탐색 공간에서 샘플링된 최고 성능 모델에 기반한 제약 조건을 경험적으로 적용하면서 탐색 공간을 반복적으로 축소합니다.

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

본 연구에서는 새로운 네트워크 설계 패러다임을 제시합니다. 우리의 목표는 네트워크 설계에 대한 이해를 진전시키고, 다양한 환경에서 일반화되는 설계 원리를 발견하는 것입니다. 개별 네트워크 인스턴스를 설계하는 데 초점을 맞추는 대신, 네트워크 집합을 매개변수화하는 네트워크 설계 공간을 설계합니다. 전체 과정은 네트워크의 고전적인 수동 설계와 유사하지만, 설계 공간 수준으로 확장된 것입니다. 우리의 방법론을 사용하여 네트워크 설계의 구조적 측면을 탐구한 결과, 단순하고 규칙적인 네트워크로 구성된 저차원 설계 공간에 도달했으며, 이를 RegNet이라고 부릅니다. RegNet 매개변수화의 핵심 통찰은 놀라울 정도로 단순합니다. 좋은 네트워크의 폭과 깊이는 양자화된 선형 함수로 설명할 수 있습니다. RegNet 설계 공간을 분석한 결과, 현재 네트워크 설계 관행과 일치하지 않는 흥미로운 발견을 얻었습니다. RegNet 설계 공간은 다양한 flop 범위에서 잘 작동하는 단순하고 빠른 네트워크를 제공합니다. 유사한 학습 설정과 flop 조건에서, RegNet 모델은 인기 있는 EfficientNet 모델보다 우수한 성능을 보여주며, GPU에서 최대 5배 더 빠릅니다.

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

The huge 10B model from Self-supervised Pretraining of Visual Features in the Wild, trained on one billion Instagram images, is available on the hub

리소스

RegNet을 시작하는 데 도움이 되는 공식 Hugging Face 및 커뮤니티(🌎로 표시) 리소스 목록입니다.

Image Classification

여기에 포함할 리소스를 제출하고 싶으시면 Pull Request를 열어 주시면 검토하겠습니다! 기존 리소스와 중복되지 않고 새로운 것을 보여주는 것이 이상적입니다.

RegNetConfig

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

매개변수

  • num_channels (int, 선택 사항, 기본값 3) — 입력 채널의 수입니다.
  • embedding_size (int, 선택 사항, 기본값 32) — 임베딩 및 숨겨진 상태의 차원.
  • hidden_sizes (Union[list[int], tuple[int, ...]], 선택 사항, 기본값 (128, 192, 512, 1088)) — 모델의 각 단계에서의 차원(숨김 크기).
  • depths (Union[list[int], tuple[int, ...]], 선택 사항, 기본값 (2, 6, 12, 2)) — Transformer의 각 레이어 깊이.
  • groups_width (int, 선택 사항, 기본값 64) — 각 단계별 그룹의 폭입니다.
  • 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, 선택 사항, 기본값 relu) — 디코더의 비선형 활성화 함수(함수 또는 문자열)입니다. 예를 들어, "gelu", "relu", "silu" 등이 있습니다.
  • downsample_in_first_stage (bool, 선택 사항, 기본값 False) — True인 경우, 첫 번째 단계에서 stride 2를 사용하여 입력을 다운샘플링합니다.

이것은 RegNetModel의 설정을 저장하기 위한 설정 클래스입니다. 지정된 인자에 따라 Regnet 모델을 초기화하여 모델 아키텍처를 정의하는 데 사용됩니다. 기본값으로 설정을 초기화하면 facebook/regnet-y-040과 유사한 설정이 생성됩니다.

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

예:

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

class transformers.RegNetModel

< >

( config: RegNetConfig )

매개변수

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

특정 헤드가 위에 없는 상태의 raw hidden-states를 출력하는 bare Regnet Model입니다.

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

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

forward

< >

( pixel_values: Tensoroutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → BaseModelOutputWithPoolingAndNoAttention or tuple(torch.Tensor)

매개변수

  • pixel_values (torch.Tensor, shape (batch_size, num_channels, image_size, image_size)) — 입력 이미지에 해당하는 텐서입니다. 픽셀 값은 ConvNextImageProcessor를 사용하여 얻을 수 있습니다. 자세한 내용은 ConvNextImageProcessor.call()를 참조하세요 (processor_class는 이미지 처리에 ConvNextImageProcessor를 사용합니다).
  • output_hidden_states (bool, 선택 사항) — 모든 레이어의 hidden states를 반환할지 여부입니다. 자세한 내용은 반환되는 텐서 중 hidden_states 항목을 참고하세요.
  • return_dict (bool, 선택) — 일반 튜플 대신 ModelOutput를 반환할지 여부.

반환값

BaseModelOutputWithPoolingAndNoAttention 또는 tuple(torch.Tensor)

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

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

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

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

  • pooler_output (torch.Tensor, shape (batch_size, hidden_size)) — 공간 차원에 대해 풀링 연산을 수행한 후의 마지막 레이어 hidden-state입니다.

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

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

예:

RegNetForImageClassification

class transformers.RegNetForImageClassification

< >

( config: RegNetConfig )

매개변수

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

이미지 분류 헤드가 위에 있는 RegNet 모델(풀링된 특징 위에 선형 레이어가 있는 경우), 예: ImageNet

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

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

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)

매개변수

  • pixel_values (torch.Tensor, shape (batch_size, num_channels, image_size, image_size), 선택 사항) — 입력 이미지에 해당하는 텐서입니다. 픽셀 값은 ConvNextImageProcessor를 사용하여 얻을 수 있습니다. 자세한 내용은 ConvNextImageProcessor.call()를 참조하세요 (processor_class는 이미지 처리에 ConvNextImageProcessor를 사용합니다).
  • labels (torch.LongTensor, shape (batch_size,), 선택 사항) — 이미지 분류/회귀 손실을 계산하는 데 사용되는 라벨. 인덱스는 [0, ..., config.num_labels - 1] 범위에 있어야 합니다. config.num_labels > 1인 경우 분류 손실(Cross-Entropy)이 계산됩니다.
  • output_hidden_states (bool, 선택 사항) — 모든 레이어의 hidden states를 반환할지 여부입니다. 자세한 내용은 반환되는 텐서 중 hidden_states 항목을 참고하세요.
  • return_dict (bool, 선택) — 일반 튜플 대신 ModelOutput를 반환할지 여부.

반환값

ImageClassifierOutputWithNoAttention 또는 tuple(torch.Tensor)

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

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

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

  • loss (torch.Tensor, shape (1,), 선택 사항, labels이 제공될 때 반환됨) — 분류 (또는 config.num_labels==1인 경우 회귀) 손실.
  • logits (torch.Tensor, shape (batch_size, config.num_labels)) — SoftMax 적용 전 분류(또는 config.num_labels==1인 경우 회귀) 점수.
  • hidden_states (tuple(torch.Tensor), 선택 사항, output_hidden_states=True가 전달되었거나 config.output_hidden_states=True인 경우 반환됨) — torch.Tensor의 튜플(모델에 임베딩 레이어가 있는 경우 임베딩의 출력에 대한 것 1개 + 각 단계의 출력에 대한 것 1개)로, 모양은 (batch_size, num_channels, height, width)입니다. 각 단계의 출력에서 모델의 히든 스테이트(피처 맵이라고도 함).

예:

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