Transformers documentation
Hiera
このモデルは2023年6月1日にHF papersで公開され、2024年7月12日にHugging Face Transformersに貢献されました。
Hiera
概要
Hieraは、Chaitanya Ryali、Yuan-Ting Hu、Daniel Bolya、Chen Wei、Haoqi Fan、Po-Yao Huang、Vaibhav Aggarwal、Arkabandhu Chowdhury、Omid Poursaeed、Judy Hoffman、Jitendra Malik、Yanghao Li、Christoph Feichtenhofer による Hiera: A Hierarchical Vision Transformer without the Bells-and-Whistles で提案されました。
本論文では、階層型 Vision Transformer「Hiera」を紹介しています。Hiera は、精度や効率を損なうことなく、不要なコンポーネントを除去することで、最新の階層型 Vision Transformer のアーキテクチャを簡素化します。従来の Transformer が、教師あり分類の性能を向上させるために複雑なビジョン固有のコンポーネントを追加するのに対し、Hiera は、しばしば「bells-and-whistles」と呼ばれるこうした追加が、高い精度には不可欠ではないことを示しています。強力な視覚的な事前タスク(MAE)を活用して事前学習を行うことで、Hiera は簡素さを保ちつつ、さまざまな画像および動画認識タスクにおいて、推論と学習の両方で優れた精度と速度を実現します。このアプローチは、ビジョンタスクに必要な空間的バイアスが、適切な事前学習を通じて効果的に学習できることを示唆しており、アーキテクチャの複雑さを追加する必要性を排除します。
論文の抄録は以下の通りです。
最新の階層型ビジョン・トランスフォーマーは、教師あり分類の性能向上を目的として、ビジョン固有のコンポーネントをいくつか追加しています。これらのコンポーネントは高い精度と魅力的なFLOP数をもたらしますが、追加された複雑さにより、実際にはこれらのトランスフォーマーはバニラ版ViTよりも遅くなります。本論文では、この追加の複雑さは不要であると主張します。強力な視覚的プレテキストタスク(MAE)による事前学習により、最先端のマルチステージ・ビジョン・トランスフォーマーからすべての装飾的な要素を除去しても、精度を維持できます。この過程で、Hieraという極めてシンプルな階層型ビジョン・トランスフォーマーを作成しました。Hieraは、従来のモデルよりも高精度でありながら、推論時と学習時の両方で大幅に高速です。Hieraは、画像認識と動画認識のさまざまなタスクで評価しました。コードとモデルはhttps://github.com/facebookresearch/hieraで入手できます。
Hiera architecture. Taken from the original paper. このモデルは、EduardoPacheco と namangarg110 による共同貢献です。元のコードは[こちら] (https://github.com/facebookresearch/hiera) で確認できます。
リソース
Hieraの入門を支援するための、Hugging Face公式およびコミュニティ(🌎で示されます)のリソースのリストです。ここにリソースを掲載していただくことを希望される場合は、Pull Requestをオープンしてください。レビューいたします。リソースは、既存のリソースと重複するのではなく、新しい内容をデモンストレーションするものが望ましいです。
- HieraForImageClassification は、この ノートブック でサポートされています。
- 関連項目: 画像分類タスクガイド
HieraConfig
class transformers.HieraConfig
< 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 = Noneembed_dim: int = 96image_size: list[int] | tuple[int, ...] = (224, 224)patch_size: list[int] | tuple[int, ...] = (7, 7)patch_stride: list[int] | tuple[int, ...] = (4, 4)patch_padding: list[int] | tuple[int, ...] = (3, 3)mlp_ratio: float = 4.0depths: list[int] | tuple[int, ...] = (2, 3, 16, 3)num_heads: list[int] | tuple[int, ...] = (1, 2, 4, 8)embed_dim_multiplier: float | int = 2.0num_query_pool: int = 3query_stride: list[int] | tuple[int, ...] = (2, 2)masked_unit_size: list[int] | tuple[int, ...] = (8, 8)masked_unit_attention: list[bool] | tuple[bool, ...] = (True, True, False, False)drop_path_rate: float | int = 0.0num_channels: int = 3hidden_act: str = 'gelu'initializer_range: float = 0.02layer_norm_init: float = 1.0layer_norm_eps: float = 1e-06decoder_hidden_size: int | None = Nonedecoder_depth: int | None = Nonedecoder_num_heads: int | None = Nonenormalize_pixel_loss: bool | None = Truemask_ratio: float = 0.6_out_features: list[str] | None = None_out_indices: list[int] | None = None )
パラメータ
- embed_dim (
int、任意、デフォルトは96) — 埋め込みおよび隠れ状態の次元数。 - image_size (
Union[list[int], tuple[int, ...]]、任意、デフォルトは(224, 224)) — 各画像のサイズ(解像度)。 - patch_size (
Union[list[int], tuple[int, ...]]、任意、デフォルトは(7, 7)) — 各パッチのサイズ(解像度)です。 - patch_stride (
list(int)、任意、デフォルトは[4, 4]) — パッチのストライドです。 - patch_padding (
list(int)、任意、デフォルトは[3, 3]) — パッチのpaddingです。 - mlp_ratio (
float、任意、デフォルトは4.0) — MLP の隠れ層の次元と埋め込み次元の比率です。 - depths (
Union[list[int], tuple[int, ...]]、任意、デフォルトは(2, 3, 16, 3)) — Transformer の各層の深さ。 - num_heads (
list(int)、任意、デフォルトは[1, 2, 4, 8]) — Transformerエンコーダーの各レイヤーにおけるアテンションヘッドの数です。 - embed_dim_multiplier (
float、任意、デフォルトは 2.0) — Transformer エンコーダーの各層におけるパッチ埋め込みの次元数に掛ける倍率です。 - num_query_pool (
int、省略可、デフォルト値は 3)— クエリプールのステージ数です。 - query_stride (
list(int)、任意、デフォルトは[2, 2]) — クエリプールのストライドです。 - masked_unit_size (
list(int)、任意、デフォルトは[8, 8]) — マスク対象のユニットのサイズです。 - masked_unit_attention (
list(bool)、任意、デフォルトは[True, True, False, False]) — Transformerエンコーダーの各層でマスク付きユニットアテンションを使用するかどうか。 - drop_path_rate (
Union[float, int]、任意、デフォルトは0.0) — パッチ融合におけるドロップパスの率。 - num_channels (
int、任意、デフォルトは3) — 入力チャネル数。 - hidden_act (
str、任意、デフォルトはgelu) — デコーダーで使用する非線形活性化関数(関数または文字列)。例えば、"gelu"、"relu"、"silu"など。 - initializer_range (
float、任意、デフォルトは0.02) — すべての重み行列を初期化するための truncated_normal_initializer の標準偏差です。 - layer_norm_init (
float、任意、デフォルト値は 1.0) — レイヤーノーマル層の初期重み値です。 - layer_norm_eps (
float、任意、デフォルトは1e-06) — レイヤーノーマル層で使用する epsilon です。 - decoder_hidden_size (
int, 省略可) — 隠れ表現の次元数。 - decoder_depth (
int, 任意) — MAE事前学習用のデコーダーの深さ。 - decoder_num_heads (
int, 省略可) — Transformer デコーダーの各アテンション層におけるアテンションヘッドの数。 - normalize_pixel_loss (
bool、任意、デフォルトはTrue) — ピクセル数を基準としてピクセル損失を正規化するかどうかを指定します。 - mask_ratio (
float、任意、デフォルト値は 0.6)— 入力におけるマスクされたトークンの比率です。
これは HieraModel の設定を保存するための設定クラスです。指定された引数に基づいて Hiera モデルをインスタンス化し、モデルのアーキテクチャを定義するために使用されます。デフォルト値で設定をインスタンス化すると、facebook/hiera-base-224 と同様の設定が得られます。
設定オブジェクトはPreTrainedConfigを継承し、モデルの出力を制御するために使用できます。詳細については、PreTrainedConfigのドキュメントを参照してください。
例:
>>> from transformers import HieraConfig, HieraModel
>>> # Initializing a Hiera hiera-base-patch16-224 style configuration
>>> configuration = HieraConfig()
>>> # Initializing a model (with random weights) from the hiera-base-patch16-224 style configuration
>>> model = HieraModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configHieraModel
class transformers.HieraModel
< source >( config: HieraConfigadd_pooling_layer: bool = Trueis_mae: bool = False )
パラメータ
- config (HieraConfig) — モデルのパラメータをすべて含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連する重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、from_pretrained() メソッドを参照してください。
- add_pooling_layer (
bool、任意、デフォルトはTrue) — プーリング層を適用するかどうか。 - is_mae (
bool、省略可能、デフォルトはFalse) — モデルを MAE モードで実行するかどうか。
…
このモデルは PreTrainedModel を継承しています。すべてのモデルに実装されている汎用的なメソッド(ダウンロードや保存、入力埋め込みのリサイズ、ヘッドのプルーニングなど)については、スーパークラスのドキュメントを参照してください。
このモデルは、PyTorchのtorch.nn.Moduleのサブクラスでもあります。 通常のPyTorch Moduleとして使用し、一般的な使用方法や動作に関する詳細については、PyTorchのドキュメントを参照してください。
forward
< source >( pixel_values: typing.Optional[torch.Tensor] = Nonenoise: typing.Optional[torch.FloatTensor] = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Noneinterpolate_pos_encoding: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → BaseModelOutputWithPooling or tuple(torch.FloatTensor)
パラメータ
- pixel_values (
torch.Tensor、形状(batch_size, num_channels, image_size, image_size)、任意) — 入力画像に対応するテンソルです。ピクセル値は BitImageProcessor を使用して取得できます。詳細は BitImageProcessor.call() を参照してください(processor_classは画像の処理に BitImageProcessor を使用します)。 - noise (
torch.FloatTensor、形状(batch_size, num_mask_units)、省略可) — 主にテスト目的で使用され、ランダム性を制御して再現性を保つために用いられます - output_attentions (
bool, 省略可) — すべてのアテンション層のアテンションテンソルを返すかどうかを指定します。詳細は、返されるテンソルのattentionsを参照してください。 - output_hidden_states (
bool, 省略可) — すべての層の hidden states を返すかどうかを指定します。詳細は、返されるテンソルのhidden_statesを参照してください。 - interpolate_pos_encoding (
bool, 任意) — 事前学習済みの位置エンコーディングを補間するかどうかを指定します。 - return_dict (
bool, 任意) — プレーンなタプルではなく ModelOutput を返すかどうか。
戻り値
BaseModelOutputWithPooling または tuple(torch.FloatTensor)
torch.FloatTensor のタプル(return_dict=False が渡された場合、または config.return_dict=False の場合)、または BaseModelOutputWithPooling。設定(HieraConfig)や入力に応じて、さまざまな要素で構成されます。
HieraModelのforwardメソッドは、__call__特殊メソッドをオーバーライドします。
この関数内でフォワードパスの手順を定義する必要がありますが、その後、この関数ではなく
Moduleインスタンスを呼び出すべきです。前者は前処理と後処理の実行を適切に処理するのに対し、後者はそれらを黙って無視するためです。
last_hidden_state (
torch.FloatTensor、shape(batch_size, sequence_length, hidden_size)) — モデルの最終層の出力における隠れ状態のシーケンス。pooler_output (
torch.FloatTensor、shape(batch_size, hidden_size)) — 補助事前学習タスクに使用される層をさらに通して処理された後、シーケンスの最初のトークン(分類トークン)の最終層の隠れ状態。例えば、BERT 系のモデルでは、線形層と tanh 活性化関数を経て処理された後の分類トークンを返します。この線形層の重みは、事前学習中の次文予測(分類)目的から学習されます。hidden_states (
tuple(torch.FloatTensor)、optional、output_hidden_states=Trueが渡された場合またはconfig.output_hidden_states=Trueの場合に返されます)—torch.FloatTensorのタプル(埋め込み層を持つモデルの場合、埋め込みの出力が 1 つ、各層の出力がそれぞれ 1 つずつ)で、形状は(batch_size, sequence_length, hidden_size)です。各層の出力におけるモデルのHidden-states、および任意の初期埋め込み出力。
attentions (
tuple(torch.FloatTensor)、optional、output_attentions=Trueが渡された場合またはconfig.output_attentions=Trueの場合に返されます)—torch.FloatTensorのタプル(各レイヤーごとに1つ)、形状は(batch_size, num_heads, sequence_length, sequence_length)。アテンションのsoftmax後のアテンション重み。自己アテンションヘッド内で加重平均を計算するために使用されます。
HieraForPreTraining
class transformers.HieraForPreTraining
< source >( config: HieraConfig )
パラメータ
- config (HieraConfig) — モデルのパラメータをすべて含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連付けられた重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、from_pretrained() メソッドを参照してください。
自己教師あり事前学習のためにデコーダーを上に配置した Hiera Model トランスフォーマー。
このモデルは PreTrainedModel を継承しています。すべてのモデルに実装されている汎用的なメソッド(ダウンロードや保存、入力埋め込みのリサイズ、ヘッドのプルーニングなど)については、スーパークラスのドキュメントを参照してください。
このモデルは、PyTorchのtorch.nn.Moduleのサブクラスでもあります。 通常のPyTorch Moduleとして使用し、一般的な使用方法や動作に関する詳細については、PyTorchのドキュメントを参照してください。
forward
< source >( pixel_values: typing.Optional[torch.Tensor] = Nonenoise: typing.Optional[torch.FloatTensor] = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Noneinterpolate_pos_encoding: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → HieraForPreTrainingOutput or tuple(torch.FloatTensor)
パラメータ
- pixel_values (
torch.Tensor、形状(batch_size, num_channels, image_size, image_size)、任意) — 入力画像に対応するテンソルです。ピクセル値は BitImageProcessor を使用して取得できます。詳細は BitImageProcessor.call() を参照してください(processor_classは画像の処理に BitImageProcessor を使用します)。 - noise (
torch.FloatTensor、形状(batch_size, num_mask_units)、省略可) — 主にテスト目的で使用され、ランダム性を制御して再現性を保つために用いられます - output_attentions (
bool, 省略可) — すべてのアテンション層のアテンションテンソルを返すかどうかを指定します。詳細は、返されるテンソルのattentionsを参照してください。 - output_hidden_states (
bool, 省略可) — すべての層の hidden states を返すかどうかを指定します。詳細は、返されるテンソルのhidden_statesを参照してください。 - interpolate_pos_encoding (
bool, 任意) — 事前学習済みの位置エンコーディングを補間するかどうかを指定します。 - return_dict (
bool, 任意) — プレーンなタプルではなく ModelOutput を返すかどうか。
戻り値
HieraForPreTrainingOutput または tuple(torch.FloatTensor)
HieraForPreTrainingOutput、またはtorch.FloatTensorのタプル(return_dict=Falseが渡された場合、またはconfig.return_dict=Falseの場合)。設定(HieraConfig)や入力に応じて、さまざまな要素で構成されます。
HieraForPreTrainingのforwardメソッドは、__call__特殊メソッドをオーバーライドします。
この関数内でフォワードパスの手順を定義する必要がありますが、その後、この関数ではなく
Moduleインスタンスを呼び出すべきです。前者は前処理と後処理の実行を適切に処理するのに対し、後者はそれらを黙って無視するためです。
loss (
torch.FloatTensor、shape(1,)) — ピクセル再構成損失。logits (
torch.FloatTensor、shape(batch_size, sequence_length, patch_size ** 2 * num_channels)) — ピクセル再構成の logits。bool_masked_pos (
torch.BoolTensor、shape(batch_size, sequence_length)) — どのパッチがマスクされているか(0)、されていないか(1)を示すテンソル。ids_restore (
torch.LongTensor、shape(batch_size, sequence_length)) — シャッフルされたマスク済みパッチの元のインデックスを含むテンソル。hidden_states (
tuple[torch.FloatTensor]、optional、output_hidden_states=Trueが渡された場合またはconfig.output_hidden_states=Trueの場合に返される) —torch.FloatTensorのタプル(埋め込み層を持つモデルの場合、埋め込みの出力用が 1 つ、各層の出力用が 1 つずつ)で、形状は(batch_size, sequence_length, hidden_size)です。各層の出力におけるモデルのHidden-states、および任意の初期埋め込み出力。
attentions (
tuple[torch.FloatTensor]、optional、output_attentions=Trueが渡された場合またはconfig.output_attentions=Trueの場合に返されます) —torch.FloatTensorのタプル(各レイヤーごとに1つ)、形状は(batch_size, num_heads, sequence_length, sequence_length)。アテンションのsoftmax後のアテンション重み。自己アテンションヘッド内で加重平均を計算するために使用されます。
reshaped_hidden_states (
tuple(torch.FloatTensor)、optional、output_hidden_states=Trueが渡された場合またはconfig.output_hidden_states=Trueの場合に返される) —torch.FloatTensorのタプル(埋め込みの出力用 1 つ + 各層の出力用 1 つ)、shape は(batch_size, height, width, hidden_size)。各層の出力におけるモデルの hidden-states に、空間次元を含むようにリシェイプされた初期埋め込み出力を加えたもの。
例:
>>> from transformers import AutoImageProcessor, HieraForPreTraining
>>> import torch
>>> from PIL import Image
>>> from huggingface_hub.utils import httpx
>>> from io import BytesIO
>>> 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("facebook/hiera-tiny-224-mae-hf")
>>> model = HieraForPreTraining.from_pretrained("facebook/hiera-tiny-224-mae-hf")
>>> inputs = image_processor(images=image, return_tensors="pt")
>>> outputs = model(**inputs)
>>> logits = outputs.logits
>>> loss = outputs.loss
>>> print(list(logits.shape))
[1, 196, 768]HieraForImageClassification
クラス transformers.HieraForImageClassification
< source >( config: HieraConfig )
パラメータ
- config (HieraConfig) — モデルのパラメータをすべて含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連付けられた重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、from_pretrained() メソッドを参照してください。
Hiera Modelは、最終的な隠れ状態の上に平均プーリングを施した線形層を配置した画像分類ヘッドを備えたTransformerです。ImageNetなどの用途に適しています。
モデルの forward で
interpolate_pos_encodingをTrueに設定することで、学習時に使用した解像度よりも高い解像度の画像で Hiera をファインチューニングできます。これにより、事前学習済みの位置埋め込みがより高い解像度に補間されます。
このモデルは PreTrainedModel を継承しています。すべてのモデルに実装されている汎用的なメソッド(ダウンロードや保存、入力埋め込みのリサイズ、ヘッドのプルーニングなど)については、スーパークラスのドキュメントを参照してください。
このモデルは、PyTorchのtorch.nn.Moduleのサブクラスでもあります。 通常のPyTorch Moduleとして使用し、一般的な使用方法や動作に関する詳細については、PyTorchのドキュメントを参照してください。
forward
< source >( pixel_valueslabels: typing.Optional[torch.Tensor] = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Noneinterpolate_pos_encoding: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → HieraForImageClassificationOutput or tuple(torch.FloatTensor)
パラメータ
- pixel_values (`
of shape(batch_size, num_channels, image_size, image_size)) -- The tensors corresponding to the input images. Pixel values can be obtained using [BitImageProcessor](/docs/transformers/main/en/model_doc/bit#transformers.BitImageProcessor). See [BitImageProcessor.__call__()](/docs/transformers/main/en/model_doc/molmo2#transformers.Molmo2ImageProcessor.__call__) for details (processor_class` uses BitImageProcessor for processing images). - labels (
torch.LongTensor、shape(batch_size,)、任意) — 画像分類/回帰の損失を計算するためのラベル。インデックスは[0, ..., config.num_labels - 1]の範囲である必要があります。config.num_labels == 1の場合は回帰損失(平均二乗誤差)が計算され、config.num_labels > 1の場合は分類損失(クロスエントロピー)が計算されます。 - output_attentions (
bool, 省略可) — すべてのアテンション層のアテンションテンソルを返すかどうかを指定します。詳細は、返されるテンソルのattentionsを参照してください。 - output_hidden_states (
bool, 省略可) — すべての層の hidden states を返すかどうかを指定します。詳細は、返されるテンソルのhidden_statesを参照してください。 - interpolate_pos_encoding (
bool, 任意) — 事前学習済みの位置エンコーディングを補間するかどうかを指定します。 - return_dict (
bool, 任意) — プレーンなタプルではなく ModelOutput を返すかどうか。
戻り値
HieraForImageClassificationOutput または tuple(torch.FloatTensor)
HieraForImageClassificationOutput、またはtorch.FloatTensorのタプル(return_dict=Falseが渡された場合、またはconfig.return_dict=Falseの場合)。設定(HieraConfig)と入力に応じて、さまざまな要素で構成されます。
HieraForImageClassificationの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, sequence_length, hidden_size)です。各ステージの出力におけるモデルの隠れ状態(特徴マップとも呼ばれます)。attentions (
tuple(torch.FloatTensor)、optional、output_attentions=Trueが渡された場合またはconfig.output_attentions=Trueの場合に返されます)—torch.FloatTensorのタプル(各レイヤーごとに1つ)、形状は(batch_size, num_heads, patch_size, sequence_length)。アテンションのsoftmax後のアテンション重み。自己アテンションヘッド内で加重平均を計算するために使用されます。
reshaped_hidden_states (
tuple(torch.FloatTensor)、optional) —torch.FloatTensorのタプル(埋め込みの出力用 1 つと、各ステージの出力用 1 つずつ)で、形状は(batch_size, height, width, hidden_size)です。これはモデルの再整形およびロールバックされた隠れ状態です。各層の出力におけるモデルのHidden-states、および空間次元を含むように整形された初期埋め込み出力。
例:
>>> from transformers import AutoImageProcessor, HieraForImageClassification
>>> import torch
>>> from datasets import load_dataset
>>> dataset = load_dataset("huggingface/cats-image")
>>> image = dataset["test"]["image"][0]
>>> image_processor = AutoImageProcessor.from_pretrained("facebook/hiera-base-224")
>>> model = HieraForImageClassification.from_pretrained("facebook/hiera-base-224")
>>> 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])
...