パラメータ

• images (`) -- Image to preprocess. Expects a single or batch of images with pixel values ranging from 0 to 255. If passing in images with pixel values between 0 and 1, set do_rescale=False`.
• do_convert_rgb (bool、kwargs、任意) — 画像を RGB に変換するかどうかを指定します。
• do_resize (bool、kwargs、optional) — 画像をリサイズするかどうか。
• size (Annotated[int | list[int] | tuple[int, ...] | dict[str, int] | None, None], kwargs) — モデルへの最大入力次元を記述します。
• default_to_square (bool、kwargs、任意) — サイズが整数の場合、リサイズ時に正方形の画像をデフォルトとするかどうか。
• crop_size (Annotated[int | list[int] | tuple[int, ...] | dict[str, int] | None, None], kwargs) — center_crop を適用した後の出力画像のサイズ。
• resample (Annotated[Union[int, PILImageResampling, NoneType], None], kwargs) — 画像のリサイズ時に使用するリサンプリングフィルタ。PILImageResampling の列挙型のいずれかを使用できます。do_resize が True に設定されている場合のみ有効です。
• do_rescale (bool、kwargs、optional) — 画像をリスケールするかどうかを指定します。
• rescale_factor (float、kwargs、任意) — do_rescale が True に設定されている場合、画像をリスケールするための係数。
• do_normalize (bool, kwargs, optional) — 画像を正規化するかどうかを指定します。
• image_mean (Union[float, list[float], tuple[float, ...]]、kwargs、optional) — 正規化に使用する画像の平均値。do_normalize が True に設定されている場合のみ有効です。
• image_std (Union[float, list[float], tuple[float, ...]], kwargs, optional) — 正規化に使用する画像の標準偏差。do_normalize が True に設定されている場合のみ有効です。
• do_pad (bool, kwargs, optional) — 画像をパディングするかどうかを指定します。パディングは、バッチ内の最大サイズに合わせるか、画像ごとに固定の正方形サイズに合わせるかのいずれかで行われます。具体的なパディング戦略はモデルによって異なります。
• pad_size (Annotated[int | list[int] | tuple[int, ...] | dict[str, int] | None, None], kwargs) — 画像をパディングする {"height": int, "width" int} のサイズです。前処理に提供されるすべての画像サイズより大きくなければなりません。pad_size が指定されない場合、バッチ内の最大の幅と高さにパディングされます。do_pad=True. の場合のみ適用されます。
• do_center_crop (bool, kwargs, optional) — 画像を中央クロップするかどうかを指定します。
• data_format (Union[str, ~image_utils.ChannelDimension]、kwargs、任意) — サポートされているのは ChannelDimension.FIRST のみです。slow processors との互換性のために追加されました。
• input_data_format (Union[str, ~image_utils.ChannelDimension], kwargs, 省略可) — 入力画像のチャネル次元の形式です。設定されていない場合、入力画像からチャネル次元の形式が推測されます。次のいずれかになります:
  • "channels_first" または ChannelDimension.FIRST: (num_channels, height, width) 形式の画像。
  • "channels_last" または ChannelDimension.LAST: (高さ, 幅, チャネル数) 形式の画像。
  • "none" または ChannelDimension.NONE: (height, width) 形式の画像。
• device (Annotated[Union[str, torch.device, NoneType], None], kwargs) — 動画を処理するデバイスです。未設定の場合、入力動画からデバイスが推論されます。
• return_tensors (Annotated[str | ~utils.generic.TensorType | None, None], kwargs) — 'pt' に設定されている場合はスタックされたテンソルを返し、それ以外の場合はテンソルのリストを返します。
• disable_grouping (bool、kwargs、任意) — サイズごとに画像をグループ化してバッチ処理するのではなく、個別に処理するためにグループ化を無効にするかどうか。None の場合、画像が CPU にある場合は True、それ以外の場合は False に設定されます。この選択は、https://github.com/huggingface/transformers/pull/38157 に詳しく記載されている経験則に基づいています。
• image_seq_length (int、kwargs、任意) — 入力内の各画像に使用される画像トークンの数です。 後方互換性のために追加されましたが、将来のモデルではプロセッサの属性として設定されるべきです。
• patch_size (int、kwargs、任意、デフォルト値は 16)— ビジョン・タワーの 1 つのパッチの辺の長さ（ピクセル単位）。
• downsample_ratio (float、kwargs、任意、デフォルト値は 0.5) — モデルが適用するピクセルシャッフルによる空間的下位サンプリング比率です。パッチグリッドの各辺は、この比率の逆数の整数倍になります。
• min_num_patches (int、kwargs、任意、デフォルト値は 1024) — 画像をリサイズする際の、patch_size のパッチの最小数。
• max_num_patches (int、kwargs、任意、デフォルト値は 13312)— 画像をリサイズする際の patch_size パッチの最大数。0 を指定すると、この上限が無効になります。
• max_model_len (int、kwargs、任意、デフォルト値は 16384) — 言語モデルのコンテキスト長です。1 回の呼び出しにおける画像のパッチ予算の上限を決定します。

パラメータ

• input_ids (torch.LongTensor の形状 (batch_size, sequence_length), 、省略可) — 語彙における入力シーケンスのトークンインデックスです。デフォルトではパディングは無視されます。

  インデックスはAutoTokenizerを使用して取得できます。詳細については、PreTrainedTokenizer.encode()およびPreTrainedTokenizer.call()を参照してください。

  入力IDとは何ですか？

• pixel_values (torch.FloatTensor、shape (total_patches, num_channels * patch_size**2)、任意) — 画像プロセッサによって返される、すべての画像のフラット化されたパッチを連結したもの。
• image_grid_hw (torch.LongTensor、形状 (num_images, 2)、任意) — pixel_values 内の各画像のパッチグリッド (height, width)。
• pixel_values_videos (torch.FloatTensor、形状 (batch_size, num_frames, num_channels, frame_size, frame_size)、任意) — 入力動画に対応するテンソルです。動画のピクセル値は、NemotronH_Omni_Reasoning_V3VideoProcessor を使用して取得できます。詳細については、NemotronH_Omni_Reasoning_V3VideoProcessor.call() を参照してください（NemotronH_Omni_Reasoning_V3Processor は、動画の処理に NemotronH_Omni_Reasoning_V3VideoProcessor を使用します）。
• input_features (torch.FloatTensor、shape (batch_size, num_frames, num_mel_bins)、任意) — プロセッサによって生成され、音声プレースホルダトークンにエンコードおよび配置された Mel 特徴量。
• input_features_mask (torch.Tensor、shape (batch_size, num_frames)、任意) — パディングされたクリップの各実メルフレームを示すマスク。
• attention_mask (torch.Tensor の形状 (batch_size, sequence_length), 、任意) — パディングトークンのインデックスに対するアテンションを回避するためのマスク。 [0, 1]:
  • マスクされていないトークンに対して1
  • マスクされたトークンに対しては 0 です。

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

• position_ids (torch.LongTensor の形状 (batch_size, sequence_length), 、任意) — 各入力シーケンスのトークンが位置埋め込み内で占める位置のインデックス。範囲 [0, config.n_positions - 1].

  ポジションIDとは?

• past_key_values (~cache_utils.Cache, 省略可) — 逐次デコードを高速化するために使用できる、事前計算された隠れ状態(自己アテンションブロックおよびクロスアテンションブロックのキーとバリュー)。通常、これはデコードの以前の段階でモデルが返した past_key_values であり、 use_cache=True または config.use_cache=True.

  入力として許可されるのは Cache インスタンスのみです。kv cache ガイドを参照してください。 past_key_values が渡されない場合、デフォルトで DynamicCache が初期化されます。

  モデルは、入力として与えられたのと同じキャッシュ形式を出力します。

  past_key_values を使用する場合、すべての input_ids（形状 (batch_size, sequence_length)）ではなく、このモデルに過去のキー・バリュー状態が与えられていない未処理の input_ids（形状 (batch_size, unprocessed_length)）のみを入力することになります。

• labels (torch.LongTensor、shape (batch_size, sequence_length)、任意) — マスク言語モデリング損失を計算するためのラベルです。インデックスは [0, ..., config.vocab_size] の範囲内であるか、-100 である必要があります（input_ids の docstring を参照）。インデックスが -100 に設定されたトークンは無視（マスク）され、損失は [0, ..., config.vocab_size] の範囲内のラベルを持つトークンに対してのみ計算されます。
• inputs_embeds (torch.FloatTensor、形状 (batch_size, sequence_length, hidden_size)、任意) — input_ids を渡す代わりに、埋め込み表現を直接渡すこともできます。これは、モデル内部の埋め込みルックアップ行列よりも、input_ids のインデックスを対応するベクトルに変換する方法をより細かく制御したい場合に有用です。
• use_cache (bool、任意) — True に設定すると、past_key_values のキーバリュー状態が返され、デコーディングの高速化に利用できます（past_key_values を参照）。
• mm_encoder_outputs (dict[str, ~modeling_outputs.BaseModelOutputWithPooling], 省略可) — キーがサポートされているモダリティ、値がそのモダリティのエンコード済み出力である辞書。各エンコード済み出力は、(pooler_output, 省略可: last_hidden_states, 省略可: hidden_states, 省略可: attentions) pooler_output (形状 (batch_size, sequence_length, hidden_size), 省略可) からなるタプルです。pooler_output は、エンコーダーのマルチモーダル特徴量をテキスト埋め込みにマージしたシーケンスです。

パラメータ

• inputs（torch.Tensor、モダリティによって形状が異なり、省略可） — 生成のプロンプトとして使用されるシーケンス、またはエンコーダーへのモデル入力です。None の場合、bos_token_id とバッチサイズ 1 で初期化されます。デコーダー専用モデルでは、inputs は input_ids の形式である必要があります。エンコーダーデコーダーモデルでは、inputs は input_ids、input_values、input_features、または pixel_values のいずれかを表すことができます。
• generation_config (GenerationConfig、任意) — 生成呼び出しのベースパラメータ化として使用される生成設定です。**kwargs で generate に渡され、generation_config の属性と一致するものは、それらをオーバーライドします。 generation_config が指定されない場合、デフォルトが使用されます。その読み込み優先順位は以下の通りです: 1) 存在する場合、generation_config.json モデルファイルから; 2) モデル設定から。未指定のパラメータは GenerationConfig のデフォルト値を継承することに注意してください。生成をパラメータ化するには、そのドキュメントを確認する必要があります。
• logits_processor (LogitsProcessorList、省略可) — 引数や生成設定から構築されるデフォルトの logits プロセッサを補完する、カスタムの logits プロセッサです。引数や生成設定によってすでに作成済みの logits プロセッサが渡された場合、エラーが発生します。この機能は上級ユーザー向けに設計されています。
• stopping_criteria (StoppingCriteriaList、省略可) — 引数と生成設定から構築されるデフォルトの停止条件を補完する、カスタムの停止条件です。引数や生成設定からすでに作成された停止条件が渡された場合、エラーが発生します。停止条件がscores入力を参照する場合、generateにreturn_dict_in_generate=True, output_scores=Trueを渡すことを確認してください。この機能は上級ユーザー向けです。
• prefix_allowed_tokens_fn (Callable[[int, torch.Tensor], list[int]], 省略可) — 指定された場合、この関数は各ステップにおいてビームサーチを許可されたトークンのみに制限します。指定されない場合、制限は適用されません。この関数は 2 つの引数を受け取ります: バッチ ID batch_id と input_ids です。バッチ ID batch_id と以前に生成されたトークン inputs_ids に基づいて、次の生成ステップで許可されるトークンのリストを返す必要があります。この引数は、Autoregressive Entity Retrieval に記載されているような、プレフィックスに条件付けられた制約付き生成に有用です。
• synced_gpus (bool, 省略可) — max_length まで while ループの実行を継続するかどうか。上書きされない場合、FullyShardedDataParallel または DeepSpeed ZeRO Stage 3 を複数の GPU で使用している場合は、ある GPU が他の GPU より先に生成を終了した場合のデッドロックを回避するために、このフラグは True に設定されます。それ以外の場合は、デフォルトで False になります。
• assistant_model (PreTrainedModel, 任意) — 生成を高速化するために使用できるアシスタントモデルです。アシスタントモデルは、呼び出し元のモデルと完全に同一のトークナイザーを持つ必要があります。アシスタントモデルによる候補トークンの予測が、呼び出し元のモデルで generate を実行するよりもはるかに高速な場合に、高速化が実現されます。そのため、アシスタントモデルは呼び出し元のモデルよりもはるかに小さいものである必要があります。
• streamer (BaseStreamer、任意) — 生成されたシーケンスをストリーミングするために使用される Streamer オブジェクトです。生成されたトークンは streamer.put(token_ids) を介して渡され、その後の処理はすべて streamer が担当します。
• negative_prompt_ids (torch.LongTensor、形状 (batch_size, sequence_length)、任意) — CFG などの一部のプロセッサに必要となるネガティブプロンプトです。バッチサイズは、入力バッチサイズと一致する必要があります。これは実験的な機能であり、将来のバージョンで API が破壊的に変更される可能性があります。
• negative_prompt_attention_mask (torch.LongTensor、形状 (batch_size, sequence_length)、任意) — negative_prompt_ids 用の Attention_mask です。
• custom_generate (str または Callable, 省略可) — 次のいずれか:
  • str（Hugging Face Hub リポジトリ名）: 標準の generate メソッドではなく、そのリポジトリ内の custom_generate/generate.py で定義されたカスタムの generate 関数を実行します。リポジトリが生成ロジックを完全に置き換え、戻り値の型が異なる場合があります。
  • str（ローカルリポジトリのパス）：上記と同様ですが、ローカルパスから読み込みます。ローカルディレクトリの場合も、ローカルのcustom_generate/generate.pyが実行されるため、trust_remote_code=Trueが必要です。
  • Callable: generate は通常の入力準備手順を実行し、その後、デコーディングループを実行するために指定された callable を呼び出します。詳細については、ドキュメントを参照してください。
• kwargs (dict[str, Any]、省略可) — generation_config のアドホックなパラメータ化、およびモデルの forward 関数に転送されるモデル固有の追加 kwargs です。モデルがエンコーダー・デコーダーモデルの場合、エンコーダー固有の kwargs にはプレフィックスを付与せず、デコーダー固有の kwargs には decoder_ をプレフィックスとして付与してください。