Transformers documentation

D-FINE

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

このモデルは2024年10月17日にHF papersで公開され、2025年4月29日にHugging Face Transformersに貢献されました。

D-FINE

概要

D-FINEモデルは、Yansong Peng、Hebei Li、Peixi Wu、Yueyi Zhang、Xiaoyan Sun、Feng Wu による D-FINE: Redefine Regression Task in DETRs as Fine-grained Distribution Refinement で提案されました。

論文の抄録は以下の通りです。

DETRモデルにおけるバウンディングボックス回帰タスクを再定義することで、優れたロカライズ精度を実現する強力なリアルタイムオブジェクトデテクタD-FINEを紹介します。D-FINEは、Fine-grained Distribution Refinement (FDR) と Global Optimal Localization Self-Distillation (GO-LSD) という2つの主要なコンポーネントで構成されています。 FDRは、回帰プロセスを固定座標の予測から確率分布の反復的な洗練へと変換し、ロカライズ精度を大幅に向上させる細粒度の中間表現を提供します。GO-LSDは、セルフディスティレーションを通じて洗練された分布から浅い層へロカライズ知識を転送する双方向最適化戦略であり、同時に深い層の残差予測タスクを簡素化します。さらに、D-FINEは計算負荷の高いモジュールや演算に軽量な最適化を組み込むことで、速度と精度のバランスをより良くしています。具体的には、D-FINE-L / XはNVIDIA T4 GPU上でCOCOデータセットにおいて124 / 78 FPSで54.0% / 55.8% APを達成します。Objects365で事前学習を行うと、D-FINE-L / Xは57.1% / 59.3% APに達し、既存のすべてのリアルタイムデテクタを上回ります。さらに、当社の手法は、追加のパラメータや学習コストをほとんど増やさずに、幅広いDETRモデルの性能を最大5.3% APまで向上させます。コードと事前学習済みモデル: this https URL.

このモデルは VladOS95-cyber によって提供されました。 元のコードは こちら で確認できます。

使用のコツ

import torch

from transformers import AutoImageProcessor, DFineForObjectDetection
from transformers.image_utils import load_image


url = 'http://images.cocodataset.org/val2017/000000039769.jpg'
image = load_image(url)

image_processor = AutoImageProcessor.from_pretrained("ustc-community/dfine_x_coco")
model = DFineForObjectDetection.from_pretrained("ustc-community/dfine_x_coco", device_map="auto")

inputs = image_processor(images=image, return_tensors="pt").to(model.device)

with torch.no_grad():
    outputs = model(**inputs)

results = image_processor.post_process_object_detection(outputs, target_sizes=[(image.height, image.width)], threshold=0.5)

for result in results:
    for score, label_id, box in zip(result["scores"], result["labels"], result["boxes"]):
        score, label = score.item(), label_id.item()
        box = [round(i, 2) for i in box.tolist()]
        print(f"{model.config.id2label[label]}: {score:.2f} {box}")
cat: 0.96 [344.49, 23.4, 639.84, 374.27]
cat: 0.96 [11.71, 53.52, 316.64, 472.33]
remote: 0.95 [40.46, 73.7, 175.62, 117.57]
sofa: 0.92 [0.59, 1.88, 640.25, 474.74]
remote: 0.89 [333.48, 77.04, 370.77, 187.3]

DFineConfig

class transformers.DFineConfig

< >

( 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 = 0id2label: 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 = Noneis_encoder_decoder: bool = Trueinitializer_range: float = 0.01initializer_bias_prior_prob: float | None = Nonelayer_norm_eps: float = 1e-05batch_norm_eps: float = 1e-05backbone_config: dict | transformers.configuration_utils.PreTrainedConfig | None = Nonefreeze_backbone_batch_norms: bool = Trueencoder_hidden_dim: int = 256encoder_in_channels: list[int] | tuple[int, ...] = (512, 1024, 2048)feat_strides: list[int] | tuple[int, ...] = (8, 16, 32)encoder_layers: int = 1encoder_ffn_dim: int = 1024encoder_attention_heads: int = 8dropout: float | int = 0.0activation_dropout: float | int = 0.0encode_proj_layers: list[int] | tuple[int, ...] = (2,)positional_encoding_temperature: int = 10000encoder_activation_function: str = 'gelu'activation_function: str = 'silu'eval_size: int | None = Nonenormalize_before: bool = Falsehidden_expansion: float = 1.0d_model: int = 256num_queries: int = 300decoder_in_channels: list[int] | tuple[int, ...] = (256, 256, 256)decoder_ffn_dim: int = 1024num_feature_levels: int = 3decoder_n_points: int | list[int] = 4decoder_layers: int = 6decoder_attention_heads: int = 8decoder_activation_function: str = 'relu'attention_dropout: float | int = 0.0num_denoising: int = 100label_noise_ratio: float = 0.5box_noise_scale: float = 1.0learn_initial_query: bool = Falseanchor_image_size: int | list[int] | None = Nonewith_box_refine: bool = Truematcher_alpha: float = 0.25matcher_gamma: float = 2.0matcher_class_cost: float = 2.0matcher_bbox_cost: float = 5.0matcher_giou_cost: float = 2.0use_focal_loss: bool = Trueauxiliary_loss: bool = Truefocal_loss_alpha: float = 0.75focal_loss_gamma: float = 2.0weight_loss_vfl: float = 1.0weight_loss_bbox: float = 5.0weight_loss_giou: float = 2.0weight_loss_fgl: float = 0.15weight_loss_ddf: float = 1.5eos_coefficient: float = 0.0001eval_idx: int = -1layer_scale: int | float = 1.0max_num_bins: int = 32reg_scale: float = 4.0depth_mult: float = 1.0top_prob_values: int = 4lqe_hidden_dim: int = 64lqe_layers: int = 2decoder_offset_scale: float = 0.5decoder_method: str = 'default'up: float = 0.5tie_word_embeddings: bool = True )

パラメータ

  • is_encoder_decoder (bool、任意、デフォルトはTrue) — モデルがエンコーダー/デコーダーとして使用されるかどうかを示します。
  • initializer_range (float、任意、デフォルトは 0.01) — すべての重み行列を初期化するための truncated_normal_initializer の標準偏差です。
  • initializer_bias_prior_prob (float, 省略可) — enc_score_head および class_embed のバイアスを初期化するために、バイアス初期化器が使用する事前確率です。 None の場合、モデルの重みを初期化する際に prior_prob は prior_prob = 1 / (num_labels + 1) として計算されます。
  • layer_norm_eps (float、任意、デフォルトは 1e-05) — レイヤーノーマル層で使用する epsilon です。
  • batch_norm_eps (float、任意、デフォルトは 1e-05) — バッチ正規化レイヤーで使用する epsilon です。
  • backbone_config (Union[dict, ~configuration_utils.PreTrainedConfig], 任意) — バックボーンモデルの設定です。
  • freeze_backbone_batch_norms (bool、任意、デフォルトはTrue) — バックボーン内のバッチ正規化レイヤーをフリーズするかどうかを指定します。
  • encoder_hidden_dim (int、任意、デフォルトは256) — 隠れ表現の次元数。
  • encoder_in_channels (list、任意、デフォルトは [512, 1024, 2048]) — エンコーダーへのマルチレベル特徴量入力。
  • feat_strides (list[int]、任意、デフォルトは [8, 16, 32]) — 各特徴量マップで使用するストライドです。
  • encoder_layers (int、任意、デフォルトは 1) — Transformer エンコーダーの隠れ層の数です。設定されていない場合は、num_layers と同じ値が使用されます。
  • encoder_ffn_dim (int、任意、デフォルトは 1024) — エンコーダー内の「中間」層(feed-forward 層と呼ばれることが多い)の次元数。
  • encoder_attention_heads (int、任意、デフォルトは 8) — Transformer エンコーダーの各アテンション層におけるアテンションヘッドの数。
  • dropout (Union[float, int]、省略可、デフォルト値は0.0) — すべての dropout レイヤーの比率です。
  • activation_dropout (Union[float, int]、任意、デフォルトは 0.0) — 全結合層内の活性化に対する dropout 率です。
  • encode_proj_layers (list[int]、任意、デフォルトは [2]) — エンコーダーで使用する投影レイヤーのインデックスです。
  • positional_encoding_temperature (int、任意、デフォルトは 10000) — 位置エンコーディングの作成に使用される温度パラメータです。
  • encoder_activation_function (str、省略可能、デフォルトは"gelu") — エンコーダーとプーラーで使用する非線形活性化関数(関数または文字列)です。文字列の場合、"gelu"、"relu"、"silu"、"gelu_new"がサポートされています。
  • activation_function (str、任意、デフォルトは silu) — デコーダーで使用する非線形活性化関数(関数または文字列)。例えば、"gelu"、 "relu"、"silu" など。
  • eval_size (tuple[int, int]、省略可) — ストライドを考慮した上で、位置埋め込みの有効な高さおよび幅を計算するために使用される高さおよび幅。
  • normalize_before (bool、任意、デフォルトは False) — Transformerエンコーダー層において、self-attentionモジュールとfeed-forwardモジュールの前にレイヤーノーマルを適用するかどうかを決定します。
  • hidden_expansion (float、任意、デフォルト値は 1.0) — RepVGGBlock と CSPRepLayer の次元サイズを拡大するための拡張比率です。
  • d_model (int、省略可、デフォルトは 256) — エンコーダ層とプーラ層のサイズ。
  • num_queries (int、任意、デフォルトは 300) — オブジェクトクエリの数。
  • decoder_in_channels (list、任意、デフォルトは [256, 256, 256]) — デコーダーのマルチレベル特徴量次元
  • decoder_ffn_dim (int、任意、デフォルトは 1024) — デコーダー内の「中間」層(feed-forward 層と呼ばれることが多い)の次元数。
  • num_feature_levels (int, 省略可、デフォルトは 3) — 入力特徴量のレベル数です。
  • decoder_n_points (int、省略可能、デフォルトは 4) — デコーダーの各アテンションヘッドにおいて、各特徴量レベルでサンプリングされるキーの数を指定します。
  • decoder_layers (int、任意、デフォルトは 6) — Transformer デコーダーの隠れ層の数です。設定されていない場合、num_layers と同じ値が使用されます。
  • decoder_attention_heads (int、任意、デフォルトは8) — Transformerデコーダーの各アテンション層におけるアテンションヘッドの数。
  • decoder_activation_function (str、任意、デフォルトは "relu") — デコーダーで使用する非線形活性化関数(関数または文字列)です。文字列の場合、"gelu"、"relu"、"silu"、"gelu_new" がサポートされています。
  • attention_dropout (Union[float, int]、任意、デフォルトは 0.0) — アテンション確率のドロップアウト率です。
  • num_denoising (int、任意、デフォルト値は 100)— 対照的デノイジングに使用するデノイジングタスクまたはクエリの総数。
  • label_noise_ratio (float、任意、デフォルト値は 0.5) — デノイジングラベルにランダムノイズを追加する割合です。
  • box_noise_scale (float、任意、デフォルト値は 1.0)— バウンディングボックスに追加するノイズのスケールまたは大きさ。
  • learn_initial_query (bool、任意、デフォルトはFalse) — デコーダーの初期クエリ埋め込みを学習中に学習するかどうかを示します
  • anchor_image_size (tuple[int, int], 任意) — 評価時にバウンディングボックスアンカーを生成するために使用される入力画像の高さと幅。None の場合、アンカーの自動生成が適用されます。
  • with_box_refine (bool、任意、デフォルトは True) — 各デコーダ層が前の層の予測に基づいてバウンディングボックスを改善する、反復的なバウンディングボックスの精緻化を適用するかどうか。
  • matcher_alpha (float、任意、デフォルト値は 0.25) — ハンガリアンマッチャーで使用されるパラメータ alpha。
  • matcher_gamma (float、任意、デフォルト値は 2.0) — ハンガリアンマッチャーで使用されるパラメータ gamma です。
  • matcher_class_cost (float、任意、デフォルト値は 2.0) — ハンガリアン Matcher が使用するクラス損失の相対的な重みです。
  • matcher_bbox_cost (float、任意、デフォルト値は 5.0) — ハンガリアン Matcher が使用するバウンディングボックス損失の相対的な重みです。
  • matcher_giou_cost (float、省略可、デフォルト値: 2.0) — ハンガリアン Matcher が使用する giou loss の相対的な重みです。
  • use_focal_loss (bool、省略可能、デフォルトは True) — focal loss を使用するかどうかを指定するパラメータです。
  • auxiliary_loss (bool、任意、デフォルトは True) — 補助デコーディング損失(各デコーダ層での損失)を使用するかどうかを指定します。
  • focal_loss_alpha (float、任意、デフォルト値は 0.75) — focal loss を計算するために使用されるパラメータ alpha。
  • focal_loss_gamma (float、任意、デフォルト値は 2.0) — focal loss を計算するために使用されるパラメータ gamma。
  • weight_loss_vfl (float、任意、デフォルト値は 1.0) — オブジェクト検出損失における varifocal loss の相対的な重み。
  • weight_loss_bbox (float、任意、デフォルト値は 5.0) — 物体検出損失における L1 バウンディングボックス損失の相対的な重み。
  • weight_loss_giou (float、任意、デフォルト値は 2.0)— オブジェクト検出損失における汎化 IoU 損失の相対的な重みです。
  • weight_loss_fgl (float、任意、デフォルト値は 0.15) — オブジェクト検出損失における、細粒度ローカライゼーション損失の相対的な重み。
  • weight_loss_ddf (float, 省略可能、デフォルト値は 1.5) — オブジェクト検出損失における、デカップルド蒸留フォーカル損失の相対的な重み。
  • eos_coefficient (float、任意、デフォルトは 0.0001) — 物体検出損失における「no-object」クラスの相対的な分類重み。
  • eval_idx (int, 任意、デフォルトは -1) — 評価に使用するデコーダ層のインデックスです。負の値を指定すると末尾から数えます(例:-1 は最後の層を使用することを意味します)。これにより、デコーダスタックの後続の層を訓練しながらも、デコーダスタック内で早期の予測を行うことができます。
  • layer_scale (float、任意、デフォルトは 1.0) — 後続のデコーダ層における隠れ次元のスケーリング係数です。評価層以降でモデルの容量を調整するために使用されます。
  • max_num_bins (int, 任意、デフォルト値は 32)— 分布ガイド型バウンディングボックスの精緻化における、ビン数の最大値。 値を大きくするとより細粒度の位置特定が可能になりますが、計算量が増加します。
  • reg_scale (float、任意、デフォルト値は 4.0)— 回帰分布のスケール係数。バウンディングボックスの精緻化プロセスの範囲と粒度を制御します。
  • depth_mult (float、任意、デフォルト値は 1.0)— RepNCSPELAN4 レイヤーのブロック数を乗算するための倍率です。アーキテクチャを維持したまま、モデルの深さをスケーリングするために使用されます。
  • top_prob_values (int、任意、デフォルトは 4) — 各コーナーの分布から考慮する上位確率値の数を指定します。
  • lqe_hidden_dim (int, 任意、デフォルトは 64) — Location Quality Estimator (LQE) ネットワークの隠れ層の次元サイズ。
  • lqe_layers (int、任意、デフォルトは 2) — Location Quality Estimator MLP の層数です。
  • decoder_offset_scale (float、任意、デフォルト値は 0.5) — deformable attention で使用されるオフセットのスケール。
  • decoder_method (str、省略可能、デフォルトは "default") — デコーダーに使用するメソッド: "default" または "discrete"。
  • up (float、任意、デフォルト値は 0.5) — Weighting Function の上限を制御します。
  • tie_word_embeddings (bool、任意、デフォルトは True) — モデルの tied_weights_keys マッピングに従って重み埋め込みを共有するかどうかを指定します。

これは DFineModel の設定を保存するための設定クラスです。指定された引数に基づいて D Fine モデルをインスタンス化し、モデルのアーキテクチャを定義するために使用されます。デフォルト値で設定をインスタンス化すると、ustc-community/dfine-xlarge-coco と同様の設定が得られます。

設定オブジェクトはPreTrainedConfigを継承し、モデルの出力を制御するために使用できます。詳細については、PreTrainedConfigのドキュメントを参照してください。

DFineModel

class transformers.DFineModel

< >

( config: DFineConfig )

パラメータ

  • config (DFineConfig) — モデルのすべてのパラメータを含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連付けられた重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、from_pretrained() メソッドを参照してください。

RT-DETRモデル(バックボーンとエンコーダー・デコーダーで構成)は、上部にヘッドを備えずに生の隠れ状態を出力します。

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

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

forward

< >

( pixel_values: Tensorpixel_mask: typing.Optional[torch.LongTensor] = Noneencoder_outputs: typing.Optional[torch.Tensor] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonelabels: list[dict] | None = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → DFineModelOutput or tuple(torch.Tensor)

パラメータ

  • pixel_values (torch.Tensor、形状 (batch_size, num_channels, image_size, image_size)) — 入力画像に対応するテンソルです。ピクセル値は image_processor_class を使用して取得できます。詳細は image_processor_class.__call__ を参照してください(processor_class は画像の処理に image_processor_class を使用します)。
  • pixel_mask (torch.LongTensor 形状 (batch_size, height, width), 省略可) — パディングピクセル値に対するアテンションの適用を回避するためのマスク。マスク値は [0, 1]:
    • 実在するピクセル(つまり、マスクされていない)に対して1
    • padding(つまり、マスクされている)ピクセルは0です。

    アテンションマスクとは?

  • encoder_outputs (torch.Tensor, 任意) — last_hidden_state、任意: hidden_states、任意: attentions のタプル last_hidden_state は形状 (batch_size, sequence_length, hidden_size)、任意)であり、エンコーダーの最終層の出力における隠れ状態のシーケンスです。デコーダーのクロスアテンションで使用されます。
  • inputs_embeds (torch.Tensor、形状 (batch_size, sequence_length, hidden_size)、任意) — フラット化された特徴マップ(バックボーンと投影層の出力)を渡す代わりに、画像のフラット化された表現を直接渡すこともできます。
  • labels (list[Dict]、長さ (batch_size,)、任意) — 二部マッチング損失を計算するためのラベル。辞書のリストで、各辞書には少なくとも以下の 2 つのキーが含まれます: ‘class_labels’ と ‘boxes’ (それぞれバッチ内の画像のクラスラベルとバウンディングボックス)。クラスラベル自体は長さ (number of bounding boxes in the image,) の torch.LongTensor であり、ボックスは形状 (number of bounding boxes in the image, 4) の torch.Tensor である必要があります。

戻り値

DFineModelOutput または tuple(torch.Tensor)

DFineModelOutput、またはtorch.Tensorのタプル(return_dict=Falseが渡された場合、またはconfig.return_dict=Falseの場合)。設定(None)や入力に応じて、さまざまな要素で構成されます。

DFineModelのforwardメソッドは、__call__特殊メソッドをオーバーライドします。

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

  • last_hidden_state (torch.Tensor、形状 (batch_size, num_queries, hidden_size)) — モデルのデコーダーの最終層の出力における、隠れ状態のシーケンスです。

  • intermediate_hidden_states (torch.Tensor、形状 (batch_size, config.decoder_layers, num_queries, hidden_size)) — 中間隠れ状態のスタック(デコーダーの各層の出力)。

  • intermediate_logits (torch.Tensor、形状 (batch_size, config.decoder_layers, sequence_length, config.num_labels)) — 積み重ねられた中間 logits(デコーダーの各層の logits)。

  • intermediate_reference_points (torch.Tensor、形状 (batch_size, config.decoder_layers, num_queries, 4)) — 中間参照点のスタック(デコーダーの各層の参照点)。

  • intermediate_predicted_corners (torch.Tensor、形状 (batch_size, config.decoder_layers, num_queries, 4)) — 積み重ねられた中間予測コーナー(デコーダーの各層の予測コーナー)。

  • initial_reference_points (torch.Tensor、形状 (batch_size, num_queries, 4)) — 最初のデコーダ層で使用する初期参照点。

  • decoder_hidden_states (tuple[torch.Tensor]、optional、output_hidden_states=True が渡された場合または config.output_hidden_states=True の場合に返されます) — torch.Tensor のタプル(埋め込み層を持つモデルの場合、埋め込みの出力が 1 つ、各層の出力がそれぞれ 1 つずつ)で、形状は (batch_size, sequence_length, hidden_size) です。

    各層の出力および初期埋め込み出力における、デコーダーの隠れ状態。

  • decoder_attentions (tuple[torch.Tensor]、optional、output_attentions=True が渡された場合または config.output_attentions=True の場合に返されます) — torch.Tensor のタプル(各レイヤーごとに1つ)、形状は (batch_size, num_heads, sequence_length, sequence_length)。

    自己アテンションヘッドにおける加重平均を計算するために使用される、アテンションのsoftmax後のデコーダーのアテンション重み。

  • cross_attentions (tuple[torch.Tensor]、optional、output_attentions=True が渡された場合または config.output_attentions=True の場合に返されます) — torch.Tensor のタプル(各レイヤーごとに1つ)、形状は (batch_size, num_heads, sequence_length, sequence_length)。

    クロスアテンション層のアテンション重みは、アテンションのsoftmax適用後に計算され、クロスアテンションヘッドにおける加重平均の計算に使用されます。

  • encoder_last_hidden_state (torch.Tensor、形状 (batch_size, sequence_length, hidden_size)、任意) — モデルのエンコーダーの最終層の出力における隠れ状態のシーケンス。

  • encoder_hidden_states (tuple[torch.Tensor]、optional、output_hidden_states=True が渡された場合または config.output_hidden_states=True の場合に返されます) — torch.Tensor のタプル(埋め込み層を持つモデルの場合、埋め込みの出力が 1 つ、各層の出力がそれぞれ 1 つずつ)で、形状は (batch_size, sequence_length, hidden_size) です。

    各層の出力および初期埋め込み出力におけるエンコーダーの隠れ状態。

  • encoder_attentions (tuple[torch.Tensor]、optional、output_attentions=True が渡された場合または config.output_attentions=True の場合に返されます) — torch.Tensor のタプル(各レイヤーごとに1つ)、形状は (batch_size, num_heads, sequence_length, sequence_length)。

    アテンションのsoftmaxを適用した後のエンコーダーのアテンション重み。自己アテンションヘッドにおける加重平均の計算に使用されます。

  • init_reference_points (torch.Tensor、形状 (batch_size, num_queries, 4)) — Transformerデコーダーに渡される初期の参照点。

  • enc_topk_logits (torch.Tensor、形状 (batch_size, sequence_length, config.num_labels)) — エンコーダ段階で、スコアが上位の config.two_stage_num_proposals 個のバウンディングボックスがリージョンプロポーザルとして選択される、予測されたバウンディングボックスのスコアです。バウンディングボックスの二値分類(すなわち、フォアグラウンドとバックグラウンド)の出力です。

  • enc_topk_bboxes (torch.Tensor、shape (batch_size, sequence_length, 4)) — エンコーダ段階で予測されるバウンディングボックス座標のLogits。

  • enc_outputs_class (torch.Tensor、形状 (batch_size, sequence_length, config.num_labels)、任意、config.with_box_refine=True かつ config.two_stage=True の場合に返されます) — 第1段階でスコア上位の config.two_stage_num_proposals 個のバウンディングボックスがリージョンプロポーザルとして選択される、予測されたバウンディングボックスのスコアです。バウンディングボックスの二値分類(すなわち、フォアグラウンドとバックグラウンド)の出力です。

  • enc_outputs_coord_logits (torch.Tensor、形状 (batch_size, sequence_length, 4)、任意、config.with_box_refine=True かつ config.two_stage=True の場合に返されます) — 第1段階で予測されるバウンディングボックス座標のロジット。

  • denoising_meta_values (dict、任意) — デノイジング関連の値を格納する追加の辞書。

例:

>>> from transformers import AutoImageProcessor, DFineModel
>>> 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("PekingU/DFine_r50vd")
>>> model = DFineModel.from_pretrained("PekingU/DFine_r50vd")

>>> inputs = image_processor(images=image, return_tensors="pt")

>>> outputs = model(**inputs)

>>> last_hidden_states = outputs.last_hidden_state
>>> list(last_hidden_states.shape)
[1, 300, 256]

DFineForObjectDetection

class transformers.DFineForObjectDetection

< >

( config: DFineConfig )

パラメータ

  • config (DFineConfig) — モデルのすべてのパラメータを含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連付けられた重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、from_pretrained() メソッドを参照してください。

RT-DETR モデル(バックボーンとエンコーダー・デコーダーで構成)は、バウンディングボックスと、スコアとクラスにさらにデコードされるための logits を出力します。

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

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

forward

< >

( pixel_values: Tensorpixel_mask: typing.Optional[torch.LongTensor] = Noneencoder_outputs: typing.Optional[torch.Tensor] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonelabels: list[dict] | None = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → DFineObjectDetectionOutput or tuple(torch.Tensor)

パラメータ

  • pixel_values (torch.Tensor、形状 (batch_size, num_channels, image_size, image_size)) — 入力画像に対応するテンソルです。ピクセル値は image_processor_class を使用して取得できます。詳細は image_processor_class.__call__ を参照してください(processor_class は画像の処理に image_processor_class を使用します)。
  • pixel_mask (torch.LongTensor 形状 (batch_size, height, width), 省略可) — パディングピクセル値に対するアテンションの適用を回避するためのマスク。マスク値は [0, 1]:
    • 実在するピクセル(つまり、マスクされていない)に対して1
    • padding(つまり、マスクされている)ピクセルは0です。

    アテンションマスクとは?

  • encoder_outputs (torch.Tensor, 任意) — last_hidden_state、任意: hidden_states、任意: attentions のタプル last_hidden_state は形状 (batch_size, sequence_length, hidden_size)、任意)であり、エンコーダーの最終層の出力における隠れ状態のシーケンスです。デコーダーのクロスアテンションで使用されます。
  • inputs_embeds (torch.Tensor、形状 (batch_size, sequence_length, hidden_size)、任意) — input_ids を渡す代わりに、埋め込み表現を直接渡すこともできます。これは、モデル内部の埋め込み参照行列よりも、input_ids のインデックスを対応するベクトルに変換する方法をより細かく制御したい場合に有用です。
  • labels (list[Dict]、長さ (batch_size,)、任意) — 二部マッチング損失を計算するためのラベル。辞書のリストで、各辞書には少なくとも以下の 2 つのキーが含まれます: ‘class_labels’ と ‘boxes’ (それぞれバッチ内の画像のクラスラベルとバウンディングボックス)。クラスラベル自体は長さ (number of bounding boxes in the image,) の torch.LongTensor であり、ボックスは形状 (number of bounding boxes in the image, 4) の torch.Tensor である必要があります。

戻り値

DFineObjectDetectionOutput または tuple(torch.Tensor)

DFineObjectDetectionOutput、またはtorch.Tensorのタプル(return_dict=Falseが渡された場合、またはconfig.return_dict=Falseの場合)。設定(None)や入力に応じて、さまざまな要素で構成されます。

DFineForObjectDetectionのforwardメソッドは、__call__特殊メソッドをオーバーライドします。

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

  • loss (torch.Tensor、形状 (1,)、任意、labels が提供された場合に返されます) — クラス予測の負の対数尤度(クロスエントロピー)とバウンディングボックス損失の線形結合による総損失です。後者は、L1損失と汎用スケール不変IoU損失の線形結合として定義されます。

  • loss_dict (Dict, 任意) — 個別の損失を含む辞書です。ログ出力に便利です。

  • logits (torch.Tensor、形状 (batch_size, num_queries, num_classes + 1)) — すべてのクエリに対する分類 logits(no-object を含む)。

  • pred_boxes (torch.Tensor、shape (batch_size, num_queries, 4)) — すべてのクエリに対する正規化されたボックス座標です。(center_x, center_y, width, height) で表されます。これらの値は、バッチ内の各画像のサイズに対して [0, 1] の範囲で正規化されています(パディングは考慮されません)。~DFineImageProcessor.post_process_object_detection を使用すると、正規化されていない(絶対座標の)バウンディングボックスを取得できます。

  • auxiliary_outputs (list[Dict]、optional) — オプション。補助損失が有効化されている場合(つまり config.auxiliary_loss が True に設定されている場合)かつラベルが提供されている場合にのみ返されます。各デコーダ層について、上記の2つのキー(logits と pred_boxes)を含む辞書のリストです。

  • last_hidden_state (torch.Tensor、形状 (batch_size, num_queries, hidden_size)) — モデルのデコーダーの最終層の出力における、隠れ状態のシーケンスです。

  • intermediate_hidden_states (torch.Tensor、形状 (batch_size, config.decoder_layers, num_queries, hidden_size)) — 中間隠れ状態のスタック(デコーダーの各層の出力)。

  • intermediate_logits (torch.Tensor、形状 (batch_size, config.decoder_layers, num_queries, config.num_labels)) — 中間層のロジットのスタック(デコーダーの各層のロジット)。

  • intermediate_reference_points (torch.Tensor、形状 (batch_size, config.decoder_layers, num_queries, 4)) — 中間参照点のスタック(デコーダーの各層の参照点)。

  • intermediate_predicted_corners (torch.Tensor、形状 (batch_size, config.decoder_layers, num_queries, 4)) — 積み重ねられた中間予測コーナー(デコーダーの各層の予測コーナー)。

  • initial_reference_points (torch.Tensor、形状 (batch_size, config.decoder_layers, num_queries, 4)) — 初期参照点のスタック(デコーダーの各層の初期参照点)。

  • decoder_hidden_states (tuple[torch.Tensor]、optional、output_hidden_states=True が渡された場合または config.output_hidden_states=True の場合に返されます) — torch.Tensor のタプル(埋め込み層を持つモデルの場合、埋め込みの出力が 1 つ、各層の出力がそれぞれ 1 つずつ)で、形状は (batch_size, sequence_length, hidden_size) です。

    各層の出力および初期埋め込み出力における、デコーダーの隠れ状態。

  • decoder_attentions (tuple[torch.Tensor]、optional、output_attentions=True が渡された場合または config.output_attentions=True の場合に返されます) — torch.Tensor のタプル(各レイヤーごとに1つ)、形状は (batch_size, num_heads, sequence_length, sequence_length)。

    自己アテンションヘッドにおける加重平均を計算するために使用される、アテンションのsoftmax後のデコーダーのアテンション重み。

  • cross_attentions (tuple[torch.Tensor]、optional、output_attentions=True が渡された場合または config.output_attentions=True の場合に返されます) — torch.Tensor のタプル(各レイヤーごとに1つ)、形状は (batch_size, num_heads, sequence_length, sequence_length)。

    クロスアテンション層のアテンション重みは、アテンションのsoftmax適用後に計算され、クロスアテンションヘッドにおける加重平均の計算に使用されます。

  • encoder_last_hidden_state (torch.Tensor、形状 (batch_size, sequence_length, hidden_size)、任意) — モデルのエンコーダーの最終層の出力における隠れ状態のシーケンス。

  • encoder_hidden_states (tuple[torch.Tensor]、optional、output_hidden_states=True が渡された場合または config.output_hidden_states=True の場合に返されます) — torch.Tensor のタプル(埋め込み層を持つモデルの場合、埋め込みの出力が 1 つ、各層の出力がそれぞれ 1 つずつ)で、形状は (batch_size, sequence_length, hidden_size) です。

    各層の出力および初期埋め込み出力におけるエンコーダーの隠れ状態。

  • encoder_attentions (tuple[torch.Tensor]、optional、output_attentions=True が渡された場合または config.output_attentions=True の場合に返されます) — torch.Tensor のタプル(各レイヤーごとに1つ)、形状は (batch_size, num_heads, sequence_length, sequence_length)。

    アテンションのsoftmaxを適用した後のエンコーダーのアテンション重み。自己アテンションヘッドにおける加重平均の計算に使用されます。

  • init_reference_points (torch.Tensor、形状 (batch_size, num_queries, 4)) — Transformerデコーダーに渡される初期の参照点。

  • enc_topk_logits (torch.Tensor、形状 (batch_size, sequence_length, config.num_labels)、任意、config.with_box_refine=True かつ config.two_stage=True の場合に返されます) — エンコーダーにおける予測バウンディングボックス座標の logits。

  • enc_topk_bboxes (torch.Tensor、shape (batch_size, sequence_length, 4)、optional、config.with_box_refine=True かつ config.two_stage=True の場合に返されます) — エンコーダにおける予測されたバウンディングボックス座標の logits。

  • enc_outputs_class (torch.Tensor、形状 (batch_size, sequence_length, config.num_labels)、任意、config.with_box_refine=True かつ config.two_stage=True の場合に返されます) — 第1段階でスコア上位の config.two_stage_num_proposals 個のバウンディングボックスがリージョンプロポーザルとして選択される、予測されたバウンディングボックスのスコアです。バウンディングボックスの二値分類(すなわち、フォアグラウンドとバックグラウンド)の出力です。

  • enc_outputs_coord_logits (torch.Tensor、形状 (batch_size, sequence_length, 4)、任意、config.with_box_refine=True かつ config.two_stage=True の場合に返されます) — 第1段階で予測されるバウンディングボックス座標のロジット。

  • denoising_meta_values (dict, 任意) — デノイジング関連の値を格納するための追加の辞書

例:

>>> import torch
>>> from transformers.image_utils import load_image
>>> from transformers import AutoImageProcessor, DFineForObjectDetection

>>> url = "http://images.cocodataset.org/val2017/000000039769.jpg"
>>> image = load_image(url)

>>> image_processor = AutoImageProcessor.from_pretrained("ustc-community/dfine-xlarge-coco")
>>> model = DFineForObjectDetection.from_pretrained("ustc-community/dfine-xlarge-coco")

>>> # prepare image for the model
>>> inputs = image_processor(images=image, return_tensors="pt")

>>> # forward pass
>>> outputs = model(**inputs)

>>> logits = outputs.logits
>>> list(logits.shape)
[1, 300, 80]

>>> boxes = outputs.pred_boxes
>>> list(boxes.shape)
[1, 300, 4]

>>> # convert outputs (bounding boxes and class logits) to Pascal VOC format (xmin, ymin, xmax, ymax)
>>> target_sizes = torch.tensor([image.size[::-1]])
>>> results = image_processor.post_process_object_detection(outputs, threshold=0.9, target_sizes=target_sizes)
>>> result = results[0]  # first image in batch

>>> for score, label, box in zip(result["scores"], result["labels"], result["boxes"]):
...     box = [round(i, 2) for i in box.tolist()]
...     print(
...         f"Detected {model.config.id2label[label.item()]} with confidence "
...         f"{round(score.item(), 3)} at location {box}"
...     )
Detected cat with confidence 0.958 at location [344.49, 23.4, 639.84, 374.27]
Detected cat with confidence 0.956 at location [11.71, 53.52, 316.64, 472.33]
Detected remote with confidence 0.947 at location [40.46, 73.7, 175.62, 117.57]
Detected sofa with confidence 0.918 at location [0.59, 1.88, 640.25, 474.74]
Update on GitHub