Transformers documentation

ResNet

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

Эта модель была опубликована в HF papers 10.12.2015 и добавлена в Hugging Face Transformers 14.03.2022.

ResNet

Обзор

Модель ResNet была предложена в работе Deep Residual Learning for Image Recognition Kaiming He, Xiangyu Zhang, Shaoqing Ren и Jian Sun. Наша реализация следует небольшим изменениям, внесённым Nvidia: мы применяем stride=2 для даунсемплинга в 3x3-свёртке bottleneck, а не в первой 1x1. Это решение обычно известно как «ResNet v1.5».

ResNet ввёл остаточные соединения, которые позволяют обучать сети с беспрецедентным числом слоёв (до 1000). ResNet одержал победу на конкурсе ILSVRC & COCO 2015 года, что стало важной вехой в области глубокого компьютерного зрения.

Аннотация из статьи следующая:

Более глубокие нейронные сети сложнее обучать. Мы предлагаем фреймворк остаточного обучения, который облегчает обучение сетей, значительно более глубоких, чем те, что использовались ранее. Мы явно переформулируем слои как обучение остаточных функций относительно входов слоя, а не обучение функций без ссылки на вход. Мы приводим исчерпывающие эмпирические доказательства того, что эти остаточные сети легче оптимизировать и могут повышать точность за счет значительно увеличенной глубины. На наборе данных ImageNet мы оцениваем остаточные сети глубиной до 152 слоев — в 8 раз глубже сетей VGG, но при этом с меньшей сложностью. Ансамбль этих остаточных сетей достигает ошибки 3,57% на тестовом наборе ImageNet. Этот результат занял 1-е место в задаче классификации ILSVRC 2015. Мы также представляем анализ на CIFAR-10 с 100 и 1000 слоями. Глубина представлений имеет центральное значение для многих задач визуального распознавания. Исключительно благодаря нашим сверхглубоким представлениям мы получаем относительное улучшение на 28% на наборе данных COCO для обнаружения объектов. Глубокие остаточные сети являются основой наших работ, поданных на конкурсы ILSVRC & COCO 2015, где мы также заняли 1-е места в задачах обнаружения на ImageNet, локализации на ImageNet, обнаружения на COCO и сегментации на COCO.

На рисунке ниже представлена архитектура ResNet. Источник — оригинальная статья.

Эта модель была предоставлена Francesco. Исходный код можно найти здесь.

Ресурсы

Список официальных ресурсов Hugging Face и сообщества (отмечены значком 🌎), которые помогут вам начать работу с ResNet.

Image Classification

Если вы хотите предложить ресурс для включения в этот раздел, пожалуйста, создайте Pull Request, и мы его рассмотрим! В идеале ресурс должен демонстрировать что-то новое, а не дублировать уже имеющийся.

ResNetConfig

класс transformers.ResNetConfig

< >

( 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 = 64hidden_sizes: list[int] | tuple[int, ...] | None = (256, 512, 1024, 2048)depths: list[int] | tuple[int, ...] | None = (3, 4, 6, 3)layer_type: str = 'bottleneck'hidden_act: str = 'relu'downsample_in_first_stage: bool = Falsedownsample_in_bottleneck: bool = False )

Параметры

  • num_channels (int, необязательный, по умолчанию 3) — Количество входных каналов.
  • embedding_size (int, необязательный, по умолчанию 64) — Размерность эмбеддингов и скрытых состояний.
  • hidden_sizes (Union[list[int], tuple[int, ...]], необязательный, по умолчанию (256, 512, 1024, 2048)) — Размерность (скрытый размер) на каждом этапе модели.
  • depths (Union[list[int], tuple[int, ...]], необязательный, по умолчанию (3, 4, 6, 3)) — Глубина каждого слоя в Transformer.
  • layer_type (str, необязательный, по умолчанию "bottleneck") — Тип слоя, который можно выбрать: "basic" (используется для небольших моделей, таких как resnet-18 или resnet-34) или "bottleneck" (используется для более крупных моделей, начиная с resnet-50).
  • hidden_act (str, необязательный, по умолчанию relu) — Нелинейная функция активации (функция или строка) в декодере. Например, "gelu", "relu", "silu" и т. д.
  • downsample_in_first_stage (bool, необязательный, по умолчанию False) — Если True, первый этап выполняет даунсемплинг входных данных с stride, равным 2.
  • downsample_in_bottleneck (bool, необязательный, по умолчанию False) — Если True, первый свёрточный слой 1x1 в ResNetBottleNeckLayer выполняет даунсемплинг входных данных с stride, равным 2.

Это класс конфигурации для хранения настроек модели ResNetModel. Он используется для создания модели Resnet в соответствии с указанными аргументами, определяя архитектуру модели. Создание конфигурации с параметрами по умолчанию даст конфигурацию, аналогичную конфигурации microsoft/resnet-50

Объекты конфигурации наследуются от PreTrainedConfig и могут использоваться для управления выводами модели. Подробнее читайте в документации PreTrainedConfig.

Пример:

>>> from transformers import ResNetConfig, ResNetModel

>>> # Initializing a ResNet resnet-50 style configuration
>>> configuration = ResNetConfig()

>>> # Initializing a model (with random weights) from the resnet-50 style configuration
>>> model = ResNetModel(configuration)

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

validate_layer_type

< >

( )

Убедитесь, что layer_types определена корректно.

ResNetModel

класс transformers.ResNetModel

< >

( config: ResNetConfig )

Параметры

  • config (ResNetConfig) — Класс конфигурации модели, содержащий все параметры модели. Инициализация по файлу конфигурации не загружает веса, связанные с моделью, только конфигурацию. Используйте метод from_pretrained() для загрузки весов модели.

Модель Resnet без дополнительных слоёв, выводящая необработанные скрытые состояния.

Эта модель наследуется от PreTrainedModel. См. документацию родительского класса для общих методов, которые библиотека реализует для всех своих моделей (например, загрузка или сохранение, изменение размера входных эмбеддингов, обрезка голов и т. д.)

Эта модель также является подклассом torch.nn.Module в PyTorch. Используйте её как обычный модуль PyTorch и обращайтесь к документации PyTorch по всем вопросам, связанным с общим использованием и поведением.

forward

< >

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

Параметры

  • pixel_values (torch.Tensor формы (batch_size, num_channels, image_size, image_size)) — Тензоры, соответствующие входным изображениям. Значения пикселей можно получить с помощью ConvNextImageProcessor. Подробности см. в ConvNextImageProcessor.call() (processor_class использует ConvNextImageProcessor для обработки изображений).
  • output_hidden_states (bool, необязательный) — Указывает, следует ли возвращать скрытые состояния всех слоев. Подробности см. в описании hidden_states среди возвращаемых тензоров.
  • return_dict (bool, необязательный) — Указывает, следует ли возвращать ModelOutput вместо обычного кортежа.

Возвращает

BaseModelOutputWithPoolingAndNoAttention или tuple(torch.Tensor)

BaseModelOutputWithPoolingAndNoAttention или кортеж из torch.Tensor (если передано return_dict=False или если config.return_dict=False), содержащий различные элементы в зависимости от конфигурации (ResNetConfig) и входных данных.

Метод forward класса ResNetModel переопределяет специальный метод __call__.

Хотя рецепт для прямого прохода должен быть определён внутри этой функции, после этого следует вызывать экземпляр Module, а не эту функцию, поскольку первый вариант обеспечивает выполнение шагов предварительной и последующей обработки, тогда как второй молча их игнорирует.

  • last_hidden_state (torch.Tensor формы (batch_size, num_channels, height, width)) — Последовательность скрытых состояний на выходе последнего слоя модели.

  • pooler_output (torch.Tensor формы (batch_size, hidden_size)) — Скрытое состояние последнего слоя после операции пулинга по пространственным измерениям.

  • hidden_states (tuple(torch.Tensor), необязательный, возвращается, если передано output_hidden_states=True или если config.output_hidden_states=True) — Кортеж из torch.Tensor (один для вывода слоя встраиваний, если модель имеет слой встраиваний, + один для вывода каждого слоя) формы (batch_size, num_channels, height, width).

    Скрытые состояния модели на выходе каждого слоя, а также необязательные выходные значения начального слоя встраивания.

Пример:

ResNetForImageClassification

класс transformers.ResNetForImageClassification

< >

( config: ResNetConfig )

Параметры

  • config (ResNetConfig) — Класс конфигурации модели, содержащий все параметры модели. Инициализация по файлу конфигурации не загружает веса, связанные с моделью, только конфигурацию. Используйте метод from_pretrained() для загрузки весов модели.

Модель ResNet с головной частью для классификации изображений (линейный слой поверх пуллованных признаков), например, для ImageNet.

Эта модель наследуется от PreTrainedModel. См. документацию родительского класса для общих методов, которые библиотека реализует для всех своих моделей (например, загрузка или сохранение, изменение размера входных эмбеддингов, обрезка голов и т. д.)

Эта модель также является подклассом torch.nn.Module в PyTorch. Используйте её как обычный модуль PyTorch и обращайтесь к документации 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 формы (batch_size, num_channels, image_size, image_size), необязательный) — Тензоры, соответствующие входным изображениям. Значения пикселей можно получить с помощью ConvNextImageProcessor. Подробности см. в ConvNextImageProcessor.call() (processor_class использует ConvNextImageProcessor для обработки изображений).
  • labels (torch.LongTensor формы (batch_size,), необязательный) — Метки для вычисления функции потерь классификации/регрессии изображений. Индексы должны находиться в диапазоне [0, ..., config.num_labels - 1]. Если config.num_labels > 1, вычисляется функция потерь классификации (Cross-Entropy).
  • output_hidden_states (bool, необязательный) — Указывает, следует ли возвращать скрытые состояния всех слоев. Подробности см. в описании hidden_states среди возвращаемых тензоров.
  • return_dict (bool, необязательный) — Указывает, следует ли возвращать ModelOutput вместо обычного кортежа.

Возвращает

ImageClassifierOutputWithNoAttention или tuple(torch.Tensor)

Объект ImageClassifierOutputWithNoAttention или кортеж torch.Tensor (если передано return_dict=False или если config.return_dict=False), содержащий различные элементы в зависимости от конфигурации (ResNetConfig) и входных данных.

Метод forward класса ResNetForImageClassification переопределяет специальный метод __call__.

Хотя рецепт для прямого прохода должен быть определён внутри этой функции, после этого следует вызывать экземпляр Module, а не эту функцию, поскольку первый вариант обеспечивает выполнение шагов предварительной и последующей обработки, тогда как второй молча их игнорирует.

  • loss (torch.Tensor формы (1,), необязательный, возвращается, если задан labels) — Потери классификации (или регрессии, если config.num_labels==1).
  • logits (torch.Tensor формы (batch_size, config.num_labels)) — Оценки для классификации (или регрессии, если config.num_labels==1) до применения SoftMax.
  • hidden_states (tuple(torch.Tensor), необязательный, возвращается при передаче output_hidden_states=True или при config.output_hidden_states=True) — Кортеж из torch.Tensor (один для вывода слоя встраиваний, если модель имеет слой встраиваний, + один для вывода каждого этапа) формы (batch_size, num_channels, height, width). Скрытые состояния (также называемые картами признаков) модели на выходе каждого этапа.

Пример:

>>> from transformers import AutoImageProcessor, ResNetForImageClassification
>>> import torch
>>> from datasets import load_dataset

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

>>> image_processor = AutoImageProcessor.from_pretrained("microsoft/resnet-50")
>>> model = ResNetForImageClassification.from_pretrained("microsoft/resnet-50")

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