Transformers documentation
MobileViTV2
このモデルは2022年6月6日にHF papersで公開され、2023年6月2日にHugging Face Transformersに貢献されました。
MobileViTV2
概要
MobileViTV2モデルは、Sachin Mehta氏とMohammad Rastegari氏によるSeparable Self-attention for Mobile Vision Transformersで提案されました。
MobileViTV2 は、MobileViT のマルチヘッド自己注意を分離可能自己注意に置き換えることで構築された、MobileViT の第2版です。
論文の抄録は以下の通りです。
Mobile vision transformers (MobileViT) は、分類や検出を含む複数のモバイルビジョンタスクにおいて、最先端の性能を実現できます。これらのモデルはパラメータ数が少ないものの、畳み込みニューラルネットワークベースのモデルと比較してレイテンシが高くなります。MobileViT の主な効率上のボトルネックは、transformers の multi-headed self-attention (MHA) です。これはトークン(またはパッチ)数 k に対して O(k2) の時間計算量を必要とします。さらに、MHA は自己注意の計算にコストのかかる演算(バッチ単位の行列積など)を必要とするため、リソースが制約されたデバイスでのレイテンシに影響を与えます。本論文では、線形計算量、すなわち O(k) の separable self-attention 手法を導入します。提案手法のシンプルかつ効果的な特徴は、自己注意の計算に要素ごとの演算を使用することであり、リソースが制約されたデバイスに適した選択肢となります。改良されたモデルである MobileViTV2 は、ImageNet オブジェクト分類や MS-COCO オブジェクト検出を含む複数のモバイルビジョンタスクで最先端の性能を達成しています。約 300 万パラメータの MobileViTV2 は、ImageNet データセットで 75.6% の top-1 精度を達成し、モバイルデバイス上で 3.2 倍高速に動作しながら、MobileViT より約 1% 高い精度を実現しています。
このモデルは shehan97 によって提供されました。 元のコードは こちら で確認できます。
使用のコツ
- MobileViTV2 は Transformer モデルというより、CNN に近いモデルです。シーケンスデータではなく、画像のバッチに対して動作します。ViT とは異なり、埋め込みはありません。バックボーンモデルは特徴マップを出力します。
- MobileViTImageProcessor を使用して、モデル用の画像を準備できます。独自の前処理を行う場合、事前学習済みチェックポイントは、画像が BGR ピクセル順序(RGB ではなく)であることを前提としています。
- 利用可能な画像分類のチェックポイントは、ImageNet-1k(ILSVRC 2012とも呼ばれ、130万枚の画像と1,000のクラスからなるデータセット)で事前学習されています。
- セグメンテーションモデルはDeepLabV3ヘッドを使用しています。利用可能なセマンティックセグメンテーションのチェックポイントは、PASCAL VOCで事前学習されています。
MobileViTV2Config
クラス transformers.MobileViTV2Config
< 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 = Nonenum_channels: int = 3image_size: int | list[int] | tuple[int, int] = 256patch_size: int | list[int] | tuple[int, int] = 2expand_ratio: float = 2.0hidden_act: str = 'swish'conv_kernel_size: int = 3output_stride: int = 32classifier_dropout_prob: float | int = 0.1initializer_range: float = 0.02layer_norm_eps: float = 1e-05aspp_out_channels: int = 512atrous_rates: list[int] | tuple[int, ...] = (6, 12, 18)aspp_dropout_prob: float | int = 0.1semantic_loss_ignore_index: int = 255n_attn_blocks: list[int] | tuple[int, ...] = (2, 4, 3)base_attn_unit_dims: list[int] | tuple[int, ...] = (128, 192, 256)width_multiplier: float | int = 1.0ffn_multiplier: int = 2attn_dropout: float | int = 0.0ffn_dropout: float | int = 0.0 )
パラメータ
- num_channels (
int、任意、デフォルトは3) — 入力チャネル数。 - image_size (
Union[int, list[int], tuple[int, int]]、任意、デフォルトは256) — 各画像のサイズ(解像度)です。 - patch_size (
Union[int, list[int], tuple[int, int]]、任意、デフォルトは2) — 各パッチのサイズ(解像度)。 - expand_ratio (
float、任意、デフォルトは2.0) — 拡張に使用する比率。出力の次元を設定するために使用します。 - hidden_act (
str、任意、デフォルトはswish) — デコーダーで使用する非線形活性化関数(関数または文字列)。例えば、"gelu"、"relu"、"silu"など。 - conv_kernel_size (
int、任意、デフォルトは3) — 畳み込みカーネルのサイズです。 - output_stride (
int、省略可、デフォルトは32) — 入力と出力のフィーチャマップの空間解像度の比率です。 - classifier_dropout_prob (
Union[float, int]、任意、デフォルトは0.1) — 分類器の dropout 率です。 - initializer_range (
float、任意、デフォルトは0.02) — すべての重み行列を初期化するための truncated_normal_initializer の標準偏差です。 - layer_norm_eps (
float、任意、デフォルトは1e-05) — レイヤーノーマル層で使用する epsilon です。 - aspp_out_channels (
int、任意、デフォルト値は 512) — セマンティックセグメンテーション用の ASPP レイヤーで使用する出力チャネル数。 - atrous_rates (
list[int]、任意、デフォルトは[6, 12, 18]) — セマンティックセグメンテーション用のASPP層で使用するDilation (atrous) 係数です。 - aspp_dropout_prob (
float、任意、デフォルト値は 0.1) — セマンティックセグメンテーション用の ASPP レイヤーの dropout 率です。 - semantic_loss_ignore_index (
int、任意、デフォルト値は255) — セマンティックセグメンテーションモデルの損失関数によって無視されるインデックスです。 - n_attn_blocks (
list[int]、任意、デフォルトは[2, 4, 3]) — 各 MobileViTV2Layer における attention ブロックの数 - base_attn_unit_dims (
list[int]、任意、デフォルトは[128, 192, 256]) — 各 MobileViTV2Layer 内のアテンションブロックの次元のベース倍率です。 - width_multiplier (
float、任意、デフォルトは 1.0) — MobileViTV2 の幅乗数です。 - ffn_multiplier (
int、任意、デフォルト値は 2) — MobileViTV2 の FFN 乗数です。 - attn_dropout (
Union[float, int]、任意、デフォルトは0.0) — アテンション確率のドロップアウト率です。 - ffn_dropout (
float、任意、デフォルト値は 0.0) — FFN レイヤー間の dropout 率です。
これは MobileViTV2Model の設定を保存するための設定クラスです。指定された引数に基づいて Mobilevitv2 モデルをインスタンス化し、モデルのアーキテクチャを定義するために使用されます。デフォルト値で設定をインスタンス化すると、apple/mobilevitv2-1.0 と同様の設定が得られます。
設定オブジェクトはPreTrainedConfigを継承し、モデルの出力を制御するために使用できます。詳細については、PreTrainedConfigのドキュメントを参照してください。
例:
>>> from transformers import MobileViTV2Config, MobileViTV2Model
>>> # Initializing a mobilevitv2-small style configuration
>>> configuration = MobileViTV2Config()
>>> # Initializing a model from the mobilevitv2-small style configuration
>>> model = MobileViTV2Model(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configMobileViTV2Model
クラス transformers.MobileViTV2Model
< source >( config: MobileViTV2Configexpand_output: bool = True )
パラメータ
- config (MobileViTV2Config) — モデルのパラメータをすべて含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連する重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、from_pretrained() メソッドを参照してください。
- expand_output (
bool、任意、デフォルトはTrue) — モデルの出力を拡張するかどうか。Trueの場合、モデルは hidden states に加えて pooled features も出力します。Falseの場合、hidden states のみが返されます。
Mobilevitv2のベースモデル。特定のヘッドを付加せず、生の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 ) → BaseModelOutputWithPoolingAndNoAttention or tuple(torch.FloatTensor)
パラメータ
- pixel_values (
torch.Tensor、形状(batch_size, num_channels, image_size, image_size)、任意) — 入力画像に対応するテンソルです。ピクセル値は MobileViTImageProcessor を使用して取得できます。詳細については MobileViTImageProcessor.call() を参照してください(processor_classは画像の処理に MobileViTImageProcessor を使用します)。 - output_hidden_states (
bool, 省略可) — すべての層の hidden states を返すかどうかを指定します。詳細は、返されるテンソルのhidden_statesを参照してください。 - return_dict (
bool, 任意) — プレーンなタプルではなく ModelOutput を返すかどうか。
戻り値
BaseModelOutputWithPoolingAndNoAttention または tuple(torch.FloatTensor)
BaseModelOutputWithPoolingAndNoAttention、またはtorch.FloatTensorのタプル(return_dict=Falseが渡された場合、またはconfig.return_dict=Falseの場合)。設定(MobileViTV2Config)と入力に応じて、さまざまな要素で構成されます。
MobileViTV2Modelのforwardメソッドは、__call__特殊メソッドをオーバーライドします。
この関数内でフォワードパスの手順を定義する必要がありますが、その後、この関数ではなく
Moduleインスタンスを呼び出すべきです。前者は前処理と後処理の実行を適切に処理するのに対し、後者はそれらを黙って無視するためです。
last_hidden_state (
torch.FloatTensor、shape(batch_size, num_channels, height, width)) — モデルの最終層の出力における隠れ状態のシーケンス。pooler_output (
torch.FloatTensor、shape(batch_size, hidden_size)) — 空間次元に対するプーリング操作を行った後の、最終層の隠れ状態です。hidden_states (
tuple(torch.FloatTensor)、optional、output_hidden_states=Trueが渡された場合またはconfig.output_hidden_states=Trueの場合に返される) —torch.FloatTensorのタプル(埋め込み層を持つモデルの場合、埋め込みの出力が 1 つ、各層の出力がそれぞれ 1 つずつ)で、形状は(batch_size, num_channels, height, width)です。各層の出力におけるモデルのHidden-states、および任意の初期埋め込み出力。
MobileViTV2ForImageClassification
クラス transformers.MobileViTV2ForImageClassification
< source >( config: MobileViTV2Config )
パラメータ
- config (MobileViTV2Config) — モデルのすべてのパラメータを含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連付けられた重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、from_pretrained() メソッドを参照してください。
MobileViTV2 モデルは、プーリングされた特徴量の上位に線形層を備えた画像分類ヘッドを備えています。例えば、ImageNet での使用に適しています。
このモデルは PreTrainedModel を継承しています。すべてのモデルに実装されている汎用的なメソッド(ダウンロードや保存、入力埋め込みのリサイズ、ヘッドのプルーニングなど)については、スーパークラスのドキュメントを参照してください。
このモデルは、PyTorchのtorch.nn.Moduleのサブクラスでもあります。 通常のPyTorch Moduleとして使用し、一般的な使用方法や動作に関する詳細については、PyTorchのドキュメントを参照してください。
forward
< source >( pixel_values: typing.Optional[torch.Tensor] = Noneoutput_hidden_states: bool | None = Nonelabels: typing.Optional[torch.Tensor] = Nonereturn_dict: bool | None = None**kwargs ) → ImageClassifierOutputWithNoAttention or tuple(torch.FloatTensor)
パラメータ
- pixel_values (
torch.Tensor、形状(batch_size, num_channels, image_size, image_size)、任意) — 入力画像に対応するテンソルです。ピクセル値は MobileViTImageProcessor を使用して取得できます。詳細については MobileViTImageProcessor.call() を参照してください(processor_classは画像の処理に MobileViTImageProcessor を使用します)。 - output_hidden_states (
bool, 省略可) — すべての層の hidden states を返すかどうかを指定します。詳細は、返されるテンソルのhidden_statesを参照してください。 - labels (
torch.LongTensor、shape(batch_size,)、任意) — 画像分類/回帰の損失を計算するためのラベル。インデックスは[0, ..., config.num_labels - 1]の範囲である必要があります。config.num_labels == 1の場合は回帰損失(平均二乗誤差)が計算され、config.num_labels > 1の場合は分類損失(クロスエントロピー)が計算されます。 - return_dict (
bool, 任意) — プレーンなタプルではなく ModelOutput を返すかどうか。
戻り値
ImageClassifierOutputWithNoAttention または tuple(torch.FloatTensor)
torch.FloatTensor のタプル(return_dict=False が渡された場合、または config.return_dict=False の場合)、または ImageClassifierOutputWithNoAttention。設定(MobileViTV2Config)や入力に応じて、さまざまな要素で構成されます。
MobileViTV2ForImageClassificationのforwardメソッドは、__call__特殊メソッドをオーバーライドします。
この関数内でフォワードパスの手順を定義する必要がありますが、その後、この関数ではなく
Moduleインスタンスを呼び出すべきです。前者は前処理と後処理の実行を適切に処理するのに対し、後者はそれらを黙って無視するためです。
- loss (
torch.FloatTensor、shape(1,)、optional、labelsが指定された場合に返されます) — 分類損失(config.num_labels==1 の場合は回帰損失)。 - logits (
torch.FloatTensor、shape(batch_size, config.num_labels)) — SoftMax 適用前の分類スコア(config.num_labels==1 の場合は回帰スコア)。 - hidden_states (
tuple(torch.FloatTensor)、optional、output_hidden_states=Trueが渡された場合またはconfig.output_hidden_states=Trueの場合に返される) —torch.FloatTensorのタプル(埋め込み層を持つモデルの場合、埋め込みの出力用が 1 つ、各ステージの出力用がそれぞれ 1 つずつ)で、形状は(batch_size, num_channels, height, width)です。各ステージの出力におけるモデルの隠れ状態(特徴マップとも呼ばれる)です。
例:
>>> from transformers import AutoImageProcessor, MobileViTV2ForImageClassification
>>> import torch
>>> from datasets import load_dataset
>>> dataset = load_dataset("huggingface/cats-image")
>>> image = dataset["test"]["image"][0]
>>> image_processor = AutoImageProcessor.from_pretrained("apple/mobilevitv2-1.0")
>>> model = MobileViTV2ForImageClassification.from_pretrained("apple/mobilevitv2-1.0")
>>> 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])
...MobileViTV2ForSemanticSegmentation
クラス transformers.MobileViTV2ForSemanticSegmentation
< source >( config: MobileViTV2Config )
パラメータ
- config (MobileViTV2Config) — モデルのパラメータをすべて含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連する重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、from_pretrained() メソッドを参照してください。
MobileViTV2 モデルにセマンティックセグメンテーションヘッドを付加したモデル。Pascal VOC などのタスクに使用できます。
このモデルは 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 ) → SemanticSegmenterOutput or tuple(torch.FloatTensor)
パラメータ
- pixel_values (
torch.Tensor、形状(batch_size, num_channels, image_size, image_size)、任意) — 入力画像に対応するテンソルです。ピクセル値は MobileViTImageProcessor を使用して取得できます。詳細については MobileViTImageProcessor.call() を参照してください(processor_classは画像の処理に MobileViTImageProcessor を使用します)。 - labels (
torch.LongTensor、shape(batch_size, height, width)、任意) — 損失の計算に使用する正解のセマンティックセグメンテーションマップです。インデックスは[0, ..., config.num_labels - 1]の範囲である必要があります。config.num_labels > 1の場合、分類損失(Cross-Entropy)が計算されます。 - output_hidden_states (
bool, 省略可) — すべての層の hidden states を返すかどうかを指定します。詳細は、返されるテンソルのhidden_statesを参照してください。 - return_dict (
bool, 任意) — プレーンなタプルではなく ModelOutput を返すかどうか。
戻り値
SemanticSegmenterOutput または tuple(torch.FloatTensor)
torch.FloatTensor のタプル(return_dict=False が渡された場合、または config.return_dict=False の場合)、または SemanticSegmenterOutput。設定(MobileViTV2Config)や入力に応じて、さまざまな要素で構成されます。
MobileViTV2ForSemanticSegmentationのforwardメソッドは、__call__特殊メソッドをオーバーライドします。
この関数内でフォワードパスの手順を定義する必要がありますが、その後、この関数ではなく
Moduleインスタンスを呼び出すべきです。前者は前処理と後処理の実行を適切に処理するのに対し、後者はそれらを黙って無視するためです。
loss (
torch.FloatTensor、shape(1,)、optional、labelsが指定された場合に返されます) — 分類損失(config.num_labels==1 の場合は回帰損失)。logits (
torch.FloatTensor、形状(batch_size, config.num_labels, logits_height, logits_width)) — 各ピクセルの分類スコアです。pixel_valuesとして入力に渡されたものと同じサイズであるとは限らない logits が返されます。これは、ユーザーが後処理として logits を元の画像サイズにリサイズする必要がある場合に、2回の補間処理を行って品質を失うことを避けるためです。常に logits の形状を確認し、必要に応じてリサイズしてください。hidden_states (
tuple(torch.FloatTensor)、optional、output_hidden_states=Trueが渡された場合またはconfig.output_hidden_states=Trueの場合に返される) —torch.FloatTensorのタプル(埋め込み層を持つモデルの場合、埋め込みの出力が 1 つ、各層の出力がそれぞれ 1 つずつ)で、形状は(batch_size, patch_size, hidden_size)です。各層の出力におけるモデルのHidden-states、および任意の初期埋め込み出力。
attentions (
tuple(torch.FloatTensor)、optional、output_attentions=Trueが渡された場合またはconfig.output_attentions=Trueの場合に返されます)—torch.FloatTensorのタプル(各レイヤーごとに1つ)、形状は(batch_size, num_heads, patch_size, sequence_length)。アテンションのsoftmax後のアテンション重み。自己アテンションヘッド内で加重平均を計算するために使用されます。
例:
>>> from huggingface_hub.utils import httpx
>>> from io import BytesIO
>>> import torch
>>> from PIL import Image
>>> from transformers import AutoImageProcessor, MobileViTV2ForSemanticSegmentation
>>> url = "http://images.cocodataset.org/val2017/000000039769.jpg"
>>> with httpx.stream("GET", url) as response:
... image = Image.open(BytesIO(response.read()))
>>> image_processor = AutoImageProcessor.from_pretrained("apple/mobilevitv2-1.0-imagenet1k-256")
>>> model = MobileViTV2ForSemanticSegmentation.from_pretrained("apple/mobilevitv2-1.0-imagenet1k-256")
>>> inputs = image_processor(images=image, return_tensors="pt")
>>> with torch.no_grad():
... outputs = model(**inputs)
>>> # logits are of shape (batch_size, num_labels, height, width)
>>> logits = outputs.logits