# PPLCNetV3

[PPLCNetV3](https://huggingface.co/papers/2109.15099)は、効率的な画像分類および下流のビジョンタスク向けに設計された、軽量でCPU最適化された畳み込みバックボーンです。PP-LCNetアーキテクチャを基盤とし、CPUハードウェア上で精度とレイテンシのトレードオフを改善するために、トレーニング戦略の向上と構造の改良を加えています。

## 注記

- PPLCNetV3はバックボーンネットワークとしてのみ提供されています。事前学習済みの画像分類チェックポイントは正式にリリースされていません。

## PPLCNetV3Config[[transformers.PPLCNetV3Config]]

#### transformers.PPLCNetV3Config[[transformers.PPLCNetV3Config]]

```python
transformers.PPLCNetV3Config(transformers_version: str | None = None, architectures: list[str] | None = None, output_hidden_states: bool | None = False, return_dict: bool | None = True, dtype: str | torch.dtype | None = None, chunk_size_feed_forward: int = 0, is_encoder_decoder: bool = False, id2label: dict[int, str] | dict[str, str] | None = None, label2id: dict[str, int] | dict[str, str] | None = None, problem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = None, scale: float | int = 1.0, block_configs: list | None = None, stem_channels: int = 16, stem_stride: int = 2, reduction: int = 4, divisor: int = 8, hidden_act: str = 'hardswish', _out_features: list[str] | None = None, _out_indices: list[int] | None = None, conv_symmetric_num: int = 4)
```

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/pp_lcnet_v3/configuration_pp_lcnet_v3.py#L31)

**パラメータ:**

scale (`float`, *optional*, デフォルト値は 1.0) : モデルのチャネル次元のスケーリング係数です。全体のアーキテクチャを変更せずに、モデルサイズと計算コストを調整するために使用されます（例: 0.25、0.5、1.0、1.5）。

block_configs (`list[list[tuple]]`、*任意*、デフォルトは`None`) : 各ステージの各ブロックの設定。各タプルには以下が含まれます: (kernel_size, in_channels, out_channels, stride, use_squeeze_excitation)。`None`の場合、デフォルトのPP-LCNet設定が使用されます。

stem_channels (`int`、*任意*、デフォルトは 16) : stem レイヤーの出力チャネル数。

stem_stride (`int`、*optional*、デフォルトは 2) : stem 畳み込み層のストライドです。

reduction (`int`, *optional*, デフォルトは 4) : squeeze-and-excitation (SE) ブロックにおける特徴チャネル次元の縮小係数です。特徴の表現力を維持しつつ、モデルのパラメータ数と計算複雑度を低減するために使用されます。

divisor (`int`, *optional*, デフォルトは 8) : 各種モデルパラメータ（チャネル次元やカーネルサイズなど）がこの値の倍数であることを保証するために使用される除数です。これにより、モデルの実装とリソースの効率的な利用が促進されます。

hidden_act (`str`、*任意*、デフォルトは`hardswish`) : デコーダーで使用する非線形活性化関数（関数または文字列）。例えば、`"gelu"`、`"relu"`、`"silu"`など。

conv_symmetric_num (`int`, *optional*, デフォルトは `4`) : 学習可能な再パラメータ化レイヤーにおける kxk 畳み込みブランチの数です。学習時にはマルチブランチアーキテクチャを通じて特徴抽出能力を強化し、推論時には構造再パラメータ化により効率的な推論を可能にするために使用されます。

これは、Pp Lcnet V3Model の設定を保存するための設定クラスです。指定された引数に基づいて Pp Lcnet V3 モデルをインスタンス化し、モデルのアーキテクチャを定義するために使用されます。デフォルト値で設定をインスタンス化すると、[PaddlePaddle/Not_yet_released](https://huggingface.co/PaddlePaddle/Not_yet_released) と同様の設定が得られます。

設定オブジェクトは [PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig) を継承し、モデルの出力を制御するために使用できます。詳細については、[PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig) のドキュメントを参照してください。

## PPLCNetV3Backbone[[transformers.PPLCNetV3Backbone]]

#### transformers.PPLCNetV3Backbone[[transformers.PPLCNetV3Backbone]]

```python
transformers.PPLCNetV3Backbone(config: PPLCNetV3Config)
```

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/pp_lcnet_v3/modeling_pp_lcnet_v3.py#L327)

**パラメータ:**

config ([PPLCNetV3Config](/docs/transformers/main/ja/model_doc/pp_lcnet_v3#transformers.PPLCNetV3Config)) : モデルのパラメータをすべて含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連する重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、[from_pretrained()](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel.from_pretrained) メソッドを確認してください。

特徴量抽出用のPPLCNetV3バックボーンモデル。

このモデルは [PreTrainedModel](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel) を継承しています。ライブラリがすべてのモデルに対して実装している汎用的なメソッド（ダウンロードや保存、入力埋め込みのリサイズ、ヘッドのプルーニングなど）については、スーパークラスのドキュメントを参照してください。

このモデルは、PyTorchの[torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module)のサブクラスでもあります。通常のPyTorch Moduleとして使用し、一般的な使用方法や動作に関する詳細については、PyTorchのドキュメントを参照してください。

#### forward[[transformers.PPLCNetV3Backbone.forward]]

```python
forward(pixel_values: Tensor, **kwargs: *<class 'transformers.utils.generic.TransformersKwargs'>)
```

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/pp_lcnet_v3/modeling_pp_lcnet_v3.py#L340)

**パラメータ:**

pixel_values (`torch.Tensor`、shape `(batch_size, num_channels, image_size, image_size)`) : 入力画像に対応するテンソルです。ピクセル値は `image_processor_class` を使用して取得できます。詳細は `image_processor_class.__call__` を参照してください（`processor_class` は画像の処理に `image_processor_class` を使用します）。

**戻り値:** `BackboneOutput` または `tuple(torch.FloatTensor)`

`BackboneOutput`または`torch.FloatTensor`のタプル（`return_dict=False`が渡された場合、または`config.return_dict=False`の場合）。[PPLCNetV3Config](/docs/transformers/main/ja/model_doc/pp_lcnet_v3#transformers.PPLCNetV3Config)および入力に応じて、さまざまな要素で構成されます。

[PPLCNetV3Backbone](/docs/transformers/main/ja/model_doc/pp_lcnet_v3#transformers.PPLCNetV3Backbone)のforwardメソッドは、`__call__`特殊メソッドをオーバーライドします。

この関数内でフォワードパスの手順を定義する必要がありますが、その後、この関数ではなく`Module`インスタンスを呼び出すべきです。前者は前処理と後処理の実行を適切に処理するのに対し、後者はそれらを無視してしまいます。

- **feature_maps** (`tuple(torch.FloatTensor)`、形状 `(batch_size, num_channels, height, width)`) -- 各ステージのフィーチャマップ。
- **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)` または `(batch_size, num_channels, height, width)` になります。

  各ステージの出力におけるモデルの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後のアテンション重み。自己アテンションヘッド内で加重平均を計算するために使用されます。

例:

```python
>>> from transformers import PPLCNetV3Config, PPLCNetV3Backbone
>>> import torch

>>> config = PPLCNetV3Config()
>>> model = PPLCNetV3Backbone(config)

>>> pixel_values = torch.randn(1, 3, 224, 224)

>>> with torch.no_grad():
...     outputs = model(pixel_values)

>>> feature_maps = outputs.feature_maps
>>> list(feature_maps[-1].shape)
```