Transformers documentation

Auto クラス

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v5.23.0).
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Auto クラス

多くの場合、from_pretrained() メソッドに渡される事前学習済みモデルの名前またはパスから、使用するアーキテクチャを推測できます。 AutoConfig、AutoModel、または AutoTokenizer をインスタンス化すると、適切なアーキテクチャクラスが自動的に作成されます。例:

model = AutoModel.from_pretrained("google-bert/bert-base-cased", device_map="auto")

これにより、BertModelのモデルインスタンスが作成されます。

各タスクには対応するAutoModelクラスがあります。

Autoクラスの拡張

各 auto クラスには、カスタムクラスで拡張するためのメソッドが用意されています。例えば、カスタムモデルクラス NewModel を定義する場合は、対応する NewModelConfig も定義してください。その後、以下の例のように auto クラスに登録できます。

from transformers import AutoConfig, AutoModel


AutoConfig.register("new-model", NewModelConfig)
AutoModel.register(NewModelConfig, NewModel)

その後、通常どおり auto クラスを使用できます。

NewModelConfig が PreTrainedConfig のサブクラスである場合、その model_type 属性が、config を登録する際に使用するキー(ここでは "new-model")と同じ値に設定されていることを確認してください。

同様に、NewModelがPreTrainedModelのサブクラスである場合、config_class属性が、モデルを登録する際に使用するクラス(ここではNewModelConfig)に設定されていることを確認してください。

AutoConfig

class transformers.AutoConfig

< >

( )

これは汎用の設定クラスであり、from_pretrained()クラスメソッドで生成された場合、ライブラリの設定クラスのいずれかとしてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_pretrained

< >

( pretrained_model_name_or_path: str | os.PathLike[str]**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co上のモデルリポジトリにホストされている事前学習済みモデル設定のmodel idを表す文字列。
    • save_pretrained() メソッドまたは save_pretrained() メソッドを使用して設定ファイルを保存した ディレクトリ へのパス。例: ./my_model_directory/
    • 保存済みの設定 JSON ファイルへのパス。例: ./my_model_directory/configuration.json
  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制し、キャッシュされたバージョンが存在する場合にそれを上書きするかどうかを指定します。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • return_unused_kwargs (bool, 省略可, デフォルトは False) — が False, の場合、この関数は最終的な設定オブジェクトのみを返します。

    Trueの場合、この関数はTuple(config, unused_kwargs)を返します。unused_kwargsは、キーが設定属性でないキー/値のペアで構成される辞書です。つまり、configの更新に使用されず、それ以外は無視されるkwargsの部分です。

  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • kwargs(additional keyword arguments, optional) — kwargs の値のうち、キーが設定属性であるものは、読み込まれた値の上書きに使用されます。キーが設定属性ではないキー/値ペアの動作は、return_unused_kwargs キーワード引数によって制御されます。

事前学習済みモデルの設定から、ライブラリの設定クラスのいずれかをインスタンス化します。

読み込まれる config オブジェクトの model_type プロパティに基づいて、インスタンス化される設定クラスが選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_path に対するパターンマッチングにフォールバックします。

例:

>>> from transformers import AutoConfig

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-uncased")

>>> # Download configuration from huggingface.co (user-uploaded) and cache.
>>> config = AutoConfig.from_pretrained("dbmdz/bert-base-german-cased")

>>> # If configuration file is in a directory (e.g., was saved using *save_pretrained('./test/saved_model/')*).
>>> config = AutoConfig.from_pretrained("./test/bert_saved_model/")

>>> # Load a specific configuration file.
>>> config = AutoConfig.from_pretrained("./test/bert_saved_model/my_configuration.json")

>>> # Change some config attributes when loading a pretrained config.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-uncased", output_attentions=True, foo=False)
>>> config.output_attentions
True

>>> config, unused_kwargs = AutoConfig.from_pretrained(
...     "google-bert/bert-base-uncased", output_attentions=True, foo=False, return_unused_kwargs=True
... )
>>> config.output_attentions
True

>>> unused_kwargs
{'foo': False}

register

< >

( model_typeconfigexist_ok = False )

パラメータ

  • model_type (str) — “bert” や “gpt” のようなモデルタイプ。
  • config (PreTrainedConfig) — 登録する設定。

このクラス用の新しい設定を登録します。

AutoTokenizer

class transformers.AutoTokenizer

< >

( )

これは汎用的なトークナイザークラスであり、AutoTokenizer.from_pretrained()クラスメソッドで生成された場合、ライブラリのトークナイザークラスのいずれかとしてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_pretrained

< >

( pretrained_model_name_or_path*inputs**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co上のモデルリポジトリにホストされている事前定義されたトークナイザーのmodel idを表す文字列。
    • トークナイザーに必要とされる語彙ファイルを含むディレクトリへのパス。例えば、save_pretrained()メソッドを使用して保存されたものなど、./my_model_directory/のようなパスを指定します。
    • トークナイザーが単一の語彙ファイルのみを必要とする場合(Bert や XLNet など)に限り、保存された単一の語彙ファイルへのパスを指定します。例: ./my_model_directory/vocab.txt。(すべての派生クラスに適用されるわけではありません)
  • inputs(追加の位置引数、任意)— Tokenizer の __init__() メソッドに渡されます。
  • config (PreTrainedConfig、任意) — インスタンス化されるトークナイザークラスを決定するために使用される設定オブジェクトです。
  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制し、キャッシュされたバージョンが存在する場合にそれを上書きするかどうかを指定します。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • subfolder (str, 省略可) — huggingface.co 上のモデルリポジトリのサブフォルダ内に該当するファイルが配置されている場合(例: facebook/rag-token-base)に、ここで指定します。
  • tokenizer_type (str, 省略可) — 読み込む Tokenizer の種類。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • kwargs(追加のキーワード引数、任意)— Tokenizer の __init__() メソッドに渡されます。bos_token、eos_token、unk_token、sep_token、pad_token、cls_token、mask_token、additional_special_tokens などの特殊トークンを設定するために使用できます。詳細については、__init__() のパラメータを参照してください。

事前学習済みモデルの語彙から、ライブラリのトークナイザークラスのいずれかをインスタンス化します。

インスタンス化されるトークナイザーのクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

例:

>>> from transformers import AutoTokenizer

>>> # Download vocabulary from huggingface.co and cache.
>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")

>>> # Download vocabulary from huggingface.co (user-uploaded) and cache.
>>> tokenizer = AutoTokenizer.from_pretrained("dbmdz/bert-base-german-cased")

>>> # If vocabulary files are in a directory (e.g. tokenizer was saved using *save_pretrained('./test/saved_model/')*)
>>> # tokenizer = AutoTokenizer.from_pretrained("./test/bert_saved_model/")

>>> # Download vocabulary from huggingface.co and define model-specific arguments
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/roberta-base", add_prefix_space=True)

register

< >

( config_classtokenizer_class = Noneslow_tokenizer_class = Nonefast_tokenizer_class = Noneexist_ok = False )

パラメータ

  • config_class (PreTrainedConfig) — 登録対象のモデルに対応する設定です。
  • tokenizer_class — 登録するトークナイザークラス(V5 - 推奨パラメータ)。
  • slow_tokenizer_class — (非推奨) 登録するスロートークナイザ
  • fast_tokenizer_class — (非推奨) 登録する fast tokenizer。

このマッピングに新しいトークナイザーを登録します。

AutoFeatureExtractor

クラス transformers.AutoFeatureExtractor

< >

( )

これは汎用の特徴量抽出クラスであり、AutoFeatureExtractor.from_pretrained() クラスメソッドで生成された場合、ライブラリの特徴量抽出クラスのいずれかとしてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_pretrained

< >

( pretrained_model_name_or_path**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 次のいずれかです:
    • 文字列、huggingface.co上のモデルリポジトリにホストされている事前学習済みfeature_extractorのmodel id
    • save_pretrained()メソッドを使用して保存されたフィーチャーエクストラクターファイルを含むディレクトリへのパス。例: ./my_model_directory/
    • 保存されたフィーチャーエクストラクターの./my_model_directory/preprocessor_config.jsonのようなファイルへのパス
  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルのフィーチャーエクストラクターをキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — feature extractor のファイルを(再)ダウンロードを強制し、キャッシュされたバージョンが存在する場合にそれを上書きするかどうかを指定します。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}. 各リクエストでこれらのプロキシが使用されます。
  • token (str または bool、省略可) — リモートファイルの HTTP ベアラ認証に使用するトークン。True の場合、hf auth login を実行した際に生成されたトークン(~/.huggingface に保存)を使用します。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • return_unused_kwargs (bool、任意、デフォルトは False) — False の場合、この関数は最終的な feature extractor オブジェクトのみを返します。True の場合、この関数は Tuple(feature_extractor, unused_kwargs) を返します。ここで unused_kwargs は、キーが feature extractor の属性でないキー/値のペアで構成される辞書です。つまり、feature_extractor の更新に使用されず、それ以外は無視される kwargs の部分です。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • kwargs (dict[str, Any], 任意) — kwargs 内の、feature extractor の属性であるキーの値は、読み込まれた値の上書きに使用されます。キーが feature extractor の属性でないキー/値ペアの動作は、return_unused_kwargs キーワード引数によって制御されます。

事前学習済みモデルの語彙から、ライブラリのフィーチャーエクストラクタークラスのいずれかをインスタンス化します。

インスタンス化されるフィーチャーエクストラクターのクラスは、設定オブジェクトのmodel_typeプロパティに基づいて選択されます(引数として渡された場合、またはpretrained_model_name_or_pathから読み込むことが可能な場合)。model_typeが欠落している場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックします。

プライベートモデルを使用する場合は、token=True を渡す必要があります。

例:

>>> from transformers import AutoFeatureExtractor

>>> # Download feature extractor from huggingface.co and cache.
>>> feature_extractor = AutoFeatureExtractor.from_pretrained("facebook/wav2vec2-base-960h")

>>> # If feature extractor files are in a directory (e.g. feature extractor was saved using *save_pretrained('./test/saved_model/')*)
>>> # feature_extractor = AutoFeatureExtractor.from_pretrained("./test/saved_model/")

register

< >

( config_classfeature_extractor_classexist_ok = False )

パラメータ

  • config_class (PreTrainedConfig) — 登録対象のモデルに対応する設定です。
  • feature_extractor_class (FeatureExtractorMixin) — 登録するフィーチャーエクストラクター。

このクラスに新しいフィーチャーエクストラクターを登録します。

AutoImageProcessor

クラス transformers.AutoImageProcessor

< >

( )

これは汎用の画像プロセッサクラスであり、AutoImageProcessor.from_pretrained() クラスメソッドで生成された場合、ライブラリの画像プロセッサクラスのいずれかとしてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_pretrained

< >

( pretrained_model_name_or_path*inputs**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下いずれかです:
    • 文字列、huggingface.co上のモデルリポジトリにホストされている事前学習済みimage_processorのmodel id。
    • a path to a directory containing a image processor file saved using the save_pretrained() method, e.g., ./my_model_directory/.
    • 保存された画像プロセッサの JSON ファイルへのパス。例: ./my_model_directory/preprocessor_config.json
  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの画像プロセッサをキャッシュするディレクトリのパス。
  • force_download (bool、省略可、デフォルトは False) — イメージプロセッサのファイルを(再)ダウンロードを強制し、キャッシュされたバージョンが存在する場合にそれを上書きするかどうか。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}. 各リクエストでこれらのプロキシが使用されます。
  • token (str または bool、省略可) — リモートファイルの HTTP ベアラ認証に使用するトークン。True の場合、hf auth login を実行した際に生成されたトークン(~/.huggingface に保存)を使用します。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • use_fast (bool、省略可、デフォルトは False) — 非推奨: backend="torchvision" を使用してください。このパラメータは後方互換性のために残されています。 指定されたモデルがサポートしている場合、高速な torchvision ベースの画像プロセッサを使用します。 指定されたモデルに高速な画像プロセッサが利用できない場合、代わりに通常の numpy ベースの画像プロセッサが返されます。
  • backend (str, 省略可, デフォルトは None) — 画像処理に使用するバックエンド。以下のいずれかを指定できます:
    • None: 利用可能な最適なバックエンドを自動的に選択します(利用可能な場合は torchvision、それ以外は pil)
    • "torchvision": Torchvision バックエンドを使用します(GPU 加速により高速です)
    • "pil": PIL バックエンドを使用(ポータブル、CPU のみ)
    • register() メソッドを介して登録された任意のカスタムバックエンド名
  • return_unused_kwargs (bool、省略可、デフォルトは False) — False の場合、この関数は最終的な image processor オブジェクトのみを返します。True の場合、この関数は Tuple(image_processor, unused_kwargs) を返します。ここで unused_kwargs は、キーが image processor の属性でないキー/値のペアで構成される辞書です。つまり、image_processor の更新に使用されず、それ以外は無視される kwargs の部分です。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • image_processor_filename (str、任意、デフォルトは "config.json") — モデルディレクトリ内で、画像プロセッサの設定として使用するファイルの名前です。
  • kwargs (dict[str, Any], 省略可) — kwargs 内の、キーが image processor の属性である値は、読み込まれた値の上書きに使用されます。キーが image processor の属性でないキー/値ペアの動作は、return_unused_kwargs キーワード引数によって制御されます。

事前学習済みモデルの語彙から、ライブラリの画像プロセッサクラスのいずれかをインスタンス化します。

インスタンス化される画像プロセッサクラスは、設定オブジェクトのmodel_typeプロパティに基づいて選択されます(引数として渡されるか、可能な場合はpretrained_model_name_or_pathから読み込まれます)。model_typeが欠落している場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックします。

  • aimv2 — {'torchvision': 'CLIPImageProcessor', 'pil': 'CLIPImageProcessorPil'} (Aimv2Config モデル)
  • aimv2_vision_model — {'torchvision': 'CLIPImageProcessor', 'pil': 'CLIPImageProcessorPil'} (Aimv2VisionConfig モデル)
  • align — {'torchvision': 'EfficientNetImageProcessor', 'pil': 'EfficientNetImageProcessorPil'} (AlignConfig モデル)
  • altclip — {'torchvision': 'CLIPImageProcessor', 'pil': 'CLIPImageProcessorPil'}(AltCLIPConfig モデル)
  • apertus1p5 — {'torchvision': 'Apertus1p5ImageProcessor'}(Apertus1p5Config モデル)
  • aria — {'pil': 'AriaImageProcessorPil', 'torchvision': 'AriaImageProcessor'}(AriaConfig モデル)
  • aya_vision — {'torchvision': 'GotOcr2ImageProcessor', 'pil': 'GotOcr2ImageProcessorPil'}(AyaVisionConfig モデル)
  • beit — {'pil': 'BeitImageProcessorPil', 'torchvision': 'BeitImageProcessor'} (BeitConfig モデル)
  • bit — {'pil': 'BitImageProcessorPil', 'torchvision': 'BitImageProcessor'}(BitConfig モデル)
  • blip — {'pil': 'BlipImageProcessorPil', 'torchvision': 'BlipImageProcessor'}(BlipConfig モデル)
  • blip-2 — {'torchvision': 'BlipImageProcessor', 'pil': 'BlipImageProcessorPil'}(Blip2Config モデル)
  • bridgetower — {'pil': 'BridgeTowerImageProcessorPil', 'torchvision': 'BridgeTowerImageProcessor'}(BridgeTowerConfig モデル)
  • chameleon — {'pil': 'ChameleonImageProcessorPil', 'torchvision': 'ChameleonImageProcessor'}(ChameleonConfig モデル)
  • chinese_clip — {'pil': 'ChineseCLIPImageProcessorPil', 'torchvision': 'ChineseCLIPImageProcessor'} (ChineseCLIPConfig モデル)
  • chmv2 — {'torchvision': 'CHMv2ImageProcessor'} (CHMv2Config モデル)
  • clip — {'pil': 'CLIPImageProcessorPil', 'torchvision': 'CLIPImageProcessor'} (CLIPConfig モデル)
  • clipseg — {'torchvision': 'ViTImageProcessor', 'pil': 'ViTImageProcessorPil'} (CLIPSegConfig モデル)
  • cohere2_vision — {'torchvision': 'Cohere2VisionImageProcessor'} (Cohere2VisionConfig モデル)
  • cohere_compass — {'pil': 'CohereCompassImageProcessorPil', 'torchvision': 'CohereCompassImageProcessor'} (CohereCompassConfig モデル)
  • colpali — {'torchvision': 'SiglipImageProcessor', 'pil': 'SiglipImageProcessorPil'}(ColPaliConfig モデル)
  • colqwen2 — {'torchvision': 'Qwen2VLImageProcessor', 'pil': 'Qwen2VLImageProcessorPil'}(ColQwen2Configモデル)
  • conditional_detr — {'pil': 'ConditionalDetrImageProcessorPil', 'torchvision': 'ConditionalDetrImageProcessor'} (ConditionalDetrConfig モデル)
  • convnext — {'pil': 'ConvNextImageProcessorPil', 'torchvision': 'ConvNextImageProcessor'} (ConvNextConfig モデル)
  • convnextv2 — {'torchvision': 'ConvNextImageProcessor', 'pil': 'ConvNextImageProcessorPil'} (ConvNextV2Config モデル)
  • cosmos3_edge — {'pil': 'Cosmos3EdgeImageProcessorPil', 'torchvision': 'Cosmos3EdgeImageProcessor'} (Cosmos3EdgeConfig モデル)
  • cosmos3_omni — {'torchvision': 'Qwen2VLImageProcessor', 'pil': 'Qwen2VLImageProcessorPil'}(Cosmos3OmniConfig モデル)
  • cvt — {'torchvision': 'ConvNextImageProcessor', 'pil': 'ConvNextImageProcessorPil'} (CvtConfig モデル)
  • data2vec-vision — {'torchvision': 'BeitImageProcessor', 'pil': 'BeitImageProcessorPil'}(Data2VecVisionConfig モデル)
  • deepseek_ocr2 — {'pil': 'DeepseekOcr2ImageProcessorPil', 'torchvision': 'DeepseekOcr2ImageProcessor'} (DeepseekOcr2Config モデル)
  • deepseek_vl — {'pil': 'DeepseekVLImageProcessorPil', 'torchvision': 'DeepseekVLImageProcessor'} (DeepseekVLConfig モデル)
  • deepseek_vl_hybrid — {'pil': 'DeepseekVLHybridImageProcessorPil', 'torchvision': 'DeepseekVLHybridImageProcessor'} (DeepseekVLHybridConfig モデル)
  • deformable_detr — {'pil': 'DeformableDetrImageProcessorPil', 'torchvision': 'DeformableDetrImageProcessor'} (DeformableDetrConfig モデル)
  • deimv2 — {'torchvision': 'RTDetrImageProcessor', 'pil': 'RTDetrImageProcessorPil'} (Deimv2Config モデル)
  • deit — {'pil': 'DeiTImageProcessorPil', 'torchvision': 'DeiTImageProcessor'} (DeiTConfig モデル)
  • depth_anything — {'torchvision': 'DPTImageProcessor', 'pil': 'DPTImageProcessorPil'}(DepthAnythingConfig モデル)
  • depth_pro — {'torchvision': 'DepthProImageProcessor'} (DepthProConfig モデル)
  • detr — {'pil': 'DetrImageProcessorPil', 'torchvision': 'DetrImageProcessor'}(DetrConfigモデル)
  • dinat — {'torchvision': 'ViTImageProcessor', 'pil': 'ViTImageProcessorPil'} (DinatConfig モデル)
  • dinov2 — {'torchvision': 'BitImageProcessor', 'pil': 'BitImageProcessorPil'}(Dinov2Config モデル)
  • dinov3_vit — {'torchvision': 'DINOv3ViTImageProcessor'} (DINOv3ViTConfig モデル)
  • donut-swin — {'torchvision': 'DonutImageProcessor', 'pil': 'DonutImageProcessorPil'}(DonutSwinConfig モデル)
  • dots3_note — {'torchvision': 'Qwen2VLImageProcessor', 'pil': 'Qwen2VLImageProcessorPil'} (Dots3NoteConfig モデル)
  • dpt — {'pil': 'DPTImageProcessorPil', 'torchvision': 'DPTImageProcessor'}(DPTConfig モデル)
  • edgetam — {'torchvision': 'Sam2ImageProcessor'}(EdgeTamConfig モデル)
  • efficientloftr — {'pil': 'EfficientLoFTRImageProcessorPil', 'torchvision': 'EfficientLoFTRImageProcessor'} (EfficientLoFTRConfig モデル)
  • efficientnet — {'pil': 'EfficientNetImageProcessorPil', 'torchvision': 'EfficientNetImageProcessor'} (EfficientNetConfig モデル)
  • embedding_gemma2 — {'pil': 'Gemma4ImageProcessorPil', 'torchvision': 'Gemma4ImageProcessor'} (EmbeddingGemma2Config モデル)
  • emu3 — {'pil': 'Emu3ImageProcessor'}(Emu3Config モデル)
  • eomt — {'pil': 'EomtImageProcessorPil', 'torchvision': 'EomtImageProcessor'} (EomtConfig モデル)
  • eomt_dinov3 — {'torchvision': 'EomtImageProcessor', 'pil': 'EomtImageProcessorPil'}(EomtDinov3Config モデル)
  • ernie4_5_vl_moe — {'pil': 'Ernie4_5_VLMoeImageProcessorPil', 'torchvision': 'Ernie4_5_VLMoeImageProcessor'}(Ernie4_5_VLMoeConfig モデル)
  • exaone4_5 — {'torchvision': 'Qwen2VLImageProcessor', 'pil': 'Qwen2VLImageProcessorPil'}(Exaone4_5_Config モデル)
  • flava — {'pil': 'FlavaImageProcessorPil', 'torchvision': 'FlavaImageProcessor'}(FlavaConfig モデル)
  • florence2 — {'torchvision': 'CLIPImageProcessor', 'pil': 'CLIPImageProcessorPil'}(Florence2Config モデル)
  • focalnet — {'torchvision': 'BitImageProcessor', 'pil': 'BitImageProcessorPil'}(FocalNetConfig モデル)
  • fuyu — {'pil': 'FuyuImageProcessorPil', 'torchvision': 'FuyuImageProcessor'} (FuyuConfig モデル)
  • gemma3 — {'pil': 'Gemma3ImageProcessorPil', 'torchvision': 'Gemma3ImageProcessor'} (Gemma3Config モデル)
  • gemma3n — {'torchvision': 'SiglipImageProcessor', 'pil': 'SiglipImageProcessorPil'}(Gemma3nConfig モデル)
  • gemma4 — {'pil': 'Gemma4ImageProcessorPil', 'torchvision': 'Gemma4ImageProcessor'} (Gemma4Config モデル)
  • gemma4_unified — {'torchvision': 'Gemma4UnifiedImageProcessor'} (Gemma4UnifiedConfig モデル)
  • git — {'torchvision': 'CLIPImageProcessor', 'pil': 'CLIPImageProcessorPil'}(GitConfig モデル)
  • glm46v — {'pil': 'Glm46VImageProcessorPil', 'torchvision': 'Glm46VImageProcessor'} (Glm46VConfig モデル)
  • glm4v — {'pil': 'Glm4vImageProcessorPil', 'torchvision': 'Glm4vImageProcessor'}(Glm4vConfig モデル)
  • glm5_next — {'pil': 'Glm5NextImageProcessorPil', 'torchvision': 'Glm5NextImageProcessor'}(Glm5NextConfig モデル)
  • glm_image — {'pil': 'GlmImageImageProcessorPil', 'torchvision': 'GlmImageImageProcessor'} (GlmImageConfig モデル)
  • glmga — {'pil': 'GlmgaImageProcessorPil', 'torchvision': 'GlmgaImageProcessor'} (GlmgaConfig モデル)
  • glpn — {'pil': 'GLPNImageProcessorPil', 'torchvision': 'GLPNImageProcessor'}(GLPNConfig モデル)
  • got_ocr2 — {'pil': 'GotOcr2ImageProcessorPil', 'torchvision': 'GotOcr2ImageProcessor'} (GotOcr2Config モデル)
  • granite4_vision — {'torchvision': 'LlavaNextImageProcessor', 'pil': 'LlavaNextImageProcessorPil'}(Granite4VisionConfig モデル)
  • granite_docling — {'pil': 'GraniteDoclingImageProcessorPil', 'torchvision': 'GraniteDoclingImageProcessor'}(GraniteDoclingConfig モデル)
  • grounding-dino — {'pil': 'GroundingDinoImageProcessorPil', 'torchvision': 'GroundingDinoImageProcessor'} (GroundingDinoConfig モデル)
  • groupvit — {'torchvision': 'CLIPImageProcessor', 'pil': 'CLIPImageProcessorPil'} (GroupViTConfig モデル)
  • hiera — {'torchvision': 'BitImageProcessor', 'pil': 'BitImageProcessorPil'} (HieraConfig モデル)
  • hunyuan_vl — {'pil': 'HunYuanVLImageProcessorPil', 'torchvision': 'HunYuanVLImageProcessor'}(HunYuanVLConfig モデル)
  • hy_v4_vl — {'pil': 'HYV4VLImageProcessorPil', 'torchvision': 'HYV4VLImageProcessor'} (HYV4VLConfig モデル)
  • hyperclovax_vision_v2 — {'torchvision': 'Qwen2VLImageProcessor', 'pil': 'Qwen2VLImageProcessorPil'}(HyperCLOVAXVisionV2Config モデル)
  • idefics — {'pil': 'IdeficsImageProcessorPil', 'torchvision': 'IdeficsImageProcessor'}(IdeficsConfig モデル)
  • idefics2 — {'pil': 'Idefics2ImageProcessorPil', 'torchvision': 'Idefics2ImageProcessor'}(Idefics2Config モデル)
  • idefics3 — {'pil': 'Idefics3ImageProcessorPil', 'torchvision': 'Idefics3ImageProcessor'}(Idefics3Config モデル)
  • ijepa — {'torchvision': 'ViTImageProcessor', 'pil': 'ViTImageProcessorPil'} (IJepaConfig モデル)
  • imagegpt — {'pil': 'ImageGPTImageProcessorPil', 'torchvision': 'ImageGPTImageProcessor'}(ImageGPTConfig モデル)
  • inkling2 — {'torchvision': 'Inkling2ImageProcessor'} (Inkling2Config モデル)
  • inkling_mm_model — {'torchvision': 'InklingImageProcessor'} (InklingConfig モデル)
  • instructblip — {'torchvision': 'BlipImageProcessor', 'pil': 'BlipImageProcessorPil'} (InstructBlipConfig モデル)
  • internvl — {'torchvision': 'GotOcr2ImageProcessor', 'pil': 'GotOcr2ImageProcessorPil'}(InternVLConfig モデル)
  • janus — {'pil': 'JanusImageProcessorPil', 'torchvision': 'JanusImageProcessor'}(JanusConfig モデル)
  • kimi_k25 — {'torchvision': 'Kimi_K25ImageProcessor'}(Kimi_K25Config モデル)
  • kosmos-2 — {'torchvision': 'CLIPImageProcessor', 'pil': 'CLIPImageProcessorPil'}(Kosmos2Config モデル)
  • kosmos-2.5 — {'torchvision': 'Kosmos2_5ImageProcessor', 'pil': 'Kosmos2_5ImageProcessorPil'} (Kosmos2_5Config モデル)
  • layoutlmv2 — {'pil': 'LayoutLMv2ImageProcessorPil', 'torchvision': 'LayoutLMv2ImageProcessor'}(LayoutLMv2Config モデル)
  • layoutlmv3 — {'pil': 'LayoutLMv3ImageProcessorPil', 'torchvision': 'LayoutLMv3ImageProcessor'}(LayoutLMv3Config モデル)
  • layoutxlm — {'torchvision': 'LayoutLMv2ImageProcessor', 'pil': 'LayoutLMv2ImageProcessorPil'} (LayoutXLMConfig モデル)
  • levit — {'pil': 'LevitImageProcessorPil', 'torchvision': 'LevitImageProcessor'}(LevitConfig モデル)
  • lfm2_vl — {'torchvision': 'Lfm2VlImageProcessor'}(Lfm2VlConfig モデル)
  • lfm3_vl — {'torchvision': 'Qwen2VLImageProcessor', 'pil': 'Qwen2VLImageProcessorPil'}(Lfm3VlConfig モデル)
  • lightglue — {'pil': 'LightGlueImageProcessorPil', 'torchvision': 'LightGlueImageProcessor'}(LightGlueConfig モデル)
  • lighton_ocr — {'torchvision': 'PixtralImageProcessor', 'pil': 'PixtralImageProcessorPil'}(LightOnOcrConfigモデル)
  • llama4 — {'torchvision': 'Llama4ImageProcessor'}(Llama4Config モデル)
  • llava — {'pil': 'LlavaImageProcessorPil', 'torchvision': 'LlavaImageProcessor'}(LlavaConfigモデル)
  • llava_next — {'pil': 'LlavaNextImageProcessorPil', 'torchvision': 'LlavaNextImageProcessor'} (LlavaNextConfig モデル)
  • llava_next_video — {'torchvision': 'LlavaNextImageProcessor', 'pil': 'LlavaNextImageProcessorPil'} (LlavaNextVideoConfig モデル)
  • llava_onevision — {'pil': 'LlavaOnevisionImageProcessorPil', 'torchvision': 'LlavaOnevisionImageProcessor'}(LlavaOnevisionConfig モデル)
  • lw_detr — {'torchvision': 'DeformableDetrImageProcessor', 'pil': 'DeformableDetrImageProcessorPil'} (LwDetrConfig モデル)
  • mask2former — {'pil': 'Mask2FormerImageProcessorPil', 'torchvision': 'Mask2FormerImageProcessor'}(Mask2FormerConfig モデル)
  • maskformer — {'pil': 'MaskFormerImageProcessorPil', 'torchvision': 'MaskFormerImageProcessor'}(MaskFormerConfigモデル)
  • metaclip_2 — {'torchvision': 'CLIPImageProcessor', 'pil': 'CLIPImageProcessorPil'} (MetaClip2Config モデル)
  • mgp-str — {'torchvision': 'ViTImageProcessor', 'pil': 'ViTImageProcessorPil'} (MgpstrConfig モデル)
  • minicpm_ocr — {'torchvision': 'MiniCPMOcrImageProcessor'}(MiniCPMOcrConfig モデル)
  • minicpmv4_6 — {'pil': 'MiniCPMV4_6ImageProcessorPil', 'torchvision': 'MiniCPMV4_6ImageProcessor'}(MiniCPMV4_6Config モデル)
  • minicpmv4_7 — {'pil': 'MiniCPMV4_6ImageProcessorPil', 'torchvision': 'MiniCPMV4_6ImageProcessor'}(MiniCPMV4_7Config モデル)
  • minimax_m3_vl — {'torchvision': 'MiniMaxM3VLImageProcessor'}(MiniMaxM3VLConfig モデル)
  • mistral3 — {'torchvision': 'PixtralImageProcessor', 'pil': 'PixtralImageProcessorPil'}(Mistral3Config モデル)
  • mistral_large4 — {'torchvision': 'PixtralImageProcessor', 'pil': 'PixtralImageProcessorPil'} (MistralLarge4Config モデル)
  • mlcd — {'torchvision': 'CLIPImageProcessor', 'pil': 'CLIPImageProcessorPil'} (MLCDVisionConfig モデル)
  • mllama — {'pil': 'MllamaImageProcessorPil', 'torchvision': 'MllamaImageProcessor'}(MllamaConfig モデル)
  • mm-grounding-dino — {'torchvision': 'GroundingDinoImageProcessor', 'pil': 'GroundingDinoImageProcessorPil'}(MMGroundingDinoConfig モデル)
  • mobilenet_v1 — {'pil': 'MobileNetV1ImageProcessorPil', 'torchvision': 'MobileNetV1ImageProcessor'} (MobileNetV1Config モデル)
  • mobilenet_v2 — {'pil': 'MobileNetV2ImageProcessorPil', 'torchvision': 'MobileNetV2ImageProcessor'} (MobileNetV2Config モデル)
  • mobilevit — {'pil': 'MobileViTImageProcessorPil', 'torchvision': 'MobileViTImageProcessor'} (MobileViTConfig モデル)
  • mobilevitv2 — {'torchvision': 'MobileViTImageProcessor', 'pil': 'MobileViTImageProcessorPil'} (MobileViTV2Config モデル)
  • molmo2 — {'torchvision': 'Molmo2ImageProcessor'} (Molmo2Config モデル)
  • muse_glimmer — {'torchvision': 'MuseGlimmerImageProcessor'}(MuseGlimmerConfig モデル)
  • muse_spark — {'torchvision': 'MuseGlimmerImageProcessor'} (MuseSparkConfig モデル)
  • nemotron_h_omni — {'torchvision': 'NemotronH_Omni_Reasoning_V3ImageProcessor'} (NemotronH_Omni_Reasoning_V3_Config モデル)
  • neomme — {'torchvision': 'NeoMMEImageProcessor'}(NeoMMEConfig モデル)
  • nougat — {'pil': 'NougatImageProcessorPil', 'torchvision': 'NougatImageProcessor'}(NougatConfigモデル)
  • omdet-turbo — {'torchvision': 'DetrImageProcessor', 'pil': 'DetrImageProcessorPil'}(OmDetTurboConfig モデル)
  • oneformer — {'pil': 'OneFormerImageProcessorPil', 'torchvision': 'OneFormerImageProcessor'} (OneFormerConfig モデル)
  • ovis2 — {'pil': 'Ovis2ImageProcessorPil', 'torchvision': 'Ovis2ImageProcessor'} (Ovis2Config モデル)
  • owlv2 — {'pil': 'Owlv2ImageProcessorPil', 'torchvision': 'Owlv2ImageProcessor'}(Owlv2Config モデル)
  • owlvit — {'pil': 'OwlViTImageProcessorPil', 'torchvision': 'OwlViTImageProcessor'} (OwlViTConfig モデル)
  • paddleocr_vl — {'pil': 'PaddleOCRVLImageProcessorPil', 'torchvision': 'PaddleOCRVLImageProcessor'}(PaddleOCRVLConfig モデル)
  • paligemma — {'torchvision': 'SiglipImageProcessor', 'pil': 'SiglipImageProcessorPil'} (PaliGemmaConfig モデル)
  • perceiver — {'pil': 'PerceiverImageProcessorPil', 'torchvision': 'PerceiverImageProcessor'}(PerceiverConfig モデル)
  • perception_lm — {'torchvision': 'PerceptionLMImageProcessor'}(PerceptionLMConfig モデル)
  • phi4_multimodal — {'torchvision': 'Phi4MultimodalImageProcessor'}(Phi4MultimodalConfig モデル)
  • pi0 — {'torchvision': 'PI0ImageProcessor'}(PI0Config モデル)
  • pix2struct — {'pil': 'Pix2StructImageProcessorPil', 'torchvision': 'Pix2StructImageProcessor'} (Pix2StructConfig モデル)
  • pixio — {'torchvision': 'BitImageProcessor', 'pil': 'BitImageProcessorPil'}(PixioConfig モデル)
  • pixtral — {'pil': 'PixtralImageProcessorPil', 'torchvision': 'PixtralImageProcessor'}(PixtralVisionConfig モデル)
  • poolformer — {'pil': 'PoolFormerImageProcessorPil', 'torchvision': 'PoolFormerImageProcessor'}(PoolFormerConfig モデル)
  • pp_chart2table — {'pil': 'PPChart2TableImageProcessorPil', 'torchvision': 'PPChart2TableImageProcessor'}(PPChart2TableConfig モデル)
  • pp_doclayout_v2 — {'torchvision': 'PPDocLayoutV2ImageProcessor'} (PPDocLayoutV2Config モデル)
  • pp_doclayout_v3 — {'torchvision': 'PPDocLayoutV3ImageProcessor'}(PPDocLayoutV3Config モデル)
  • pp_doclayout_v4 — {'torchvision': 'PPDocLayoutV4ImageProcessor'}(PPDocLayoutV4Config モデル)
  • pp_formulanet — {'torchvision': 'PPFormulaNetImageProcessor'} (PPFormulaNetConfig モデル)
  • pp_lcnet — {'torchvision': 'PPLCNetImageProcessor'}(PPLCNetConfig モデル)
  • pp_ocrv5_mobile_det — {'torchvision': 'PPOCRV5ServerDetImageProcessor'}(PPOCRV5MobileDetConfig モデル)
  • pp_ocrv5_mobile_rec — {'torchvision': 'PPOCRV5ServerRecImageProcessor'}(PPOCRV5MobileRecConfig モデル)
  • pp_ocrv5_server_det — {'torchvision': 'PPOCRV5ServerDetImageProcessor'}(PPOCRV5ServerDetConfig モデル)
  • pp_ocrv5_server_rec — {'torchvision': 'PPOCRV5ServerRecImageProcessor'} (PPOCRV5ServerRecConfig モデル)
  • pp_ocrv6_medium_det — {'torchvision': 'PPOCRV5ServerDetImageProcessor'}(PPOCRV6MediumDetConfig モデル)
  • pp_ocrv6_small_det — {'torchvision': 'PPOCRV5ServerDetImageProcessor'}(PPOCRV6SmallDetConfig モデル)
  • pp_ocrv6_small_rec — {'torchvision': 'PPOCRV6SmallRecImageProcessor'}(PPOCRV6SmallRecConfig モデル)
  • pp_ocrv6_tiny_rec — {'torchvision': 'PPOCRV6SmallRecImageProcessor'}(PPOCRV6TinyRecConfig モデル)
  • prompt_depth_anything — {'pil': 'PromptDepthAnythingImageProcessorPil', 'torchvision': 'PromptDepthAnythingImageProcessor'}(PromptDepthAnythingConfig モデル)
  • pvt — {'pil': 'PvtImageProcessorPil', 'torchvision': 'PvtImageProcessor'} (PvtConfig モデル)
  • pvt_v2 — {'torchvision': 'PvtImageProcessor', 'pil': 'PvtImageProcessorPil'}(PvtV2Config モデル)
  • qianfan_ocr — {'torchvision': 'GotOcr2ImageProcessor', 'pil': 'GotOcr2ImageProcessorPil'}(QianfanOCRConfig モデル)
  • qwen2_5_omni — {'torchvision': 'Qwen2VLImageProcessor', 'pil': 'Qwen2VLImageProcessorPil'} (Qwen2_5OmniConfig モデル)
  • qwen2_5_vl — {'torchvision': 'Qwen2VLImageProcessor', 'pil': 'Qwen2VLImageProcessorPil'}(Qwen2_5_VLConfig モデル)
  • qwen2_vl — {'pil': 'Qwen2VLImageProcessorPil', 'torchvision': 'Qwen2VLImageProcessor'} (Qwen2VLConfig モデル)
  • qwen3_5 — {'torchvision': 'Qwen2VLImageProcessor', 'pil': 'Qwen2VLImageProcessorPil'}(Qwen3_5Config モデル)
  • qwen3_5_moe — {'torchvision': 'Qwen2VLImageProcessor', 'pil': 'Qwen2VLImageProcessorPil'}(Qwen3_5MoeConfig モデル)
  • qwen3_omni_moe — {'torchvision': 'Qwen2VLImageProcessor', 'pil': 'Qwen2VLImageProcessorPil'} (Qwen3OmniMoeConfig モデル)
  • qwen3_vl — {'torchvision': 'Qwen2VLImageProcessor', 'pil': 'Qwen2VLImageProcessorPil'}(Qwen3VLConfig モデル)
  • qwen4_exp — {'torchvision': 'Qwen2VLImageProcessor', 'pil': 'Qwen2VLImageProcessorPil'}(Qwen4ExpConfig モデル)
  • regnet — {'torchvision': 'ConvNextImageProcessor', 'pil': 'ConvNextImageProcessorPil'}(RegNetConfigモデル)
  • resnet — {'torchvision': 'ConvNextImageProcessor', 'pil': 'ConvNextImageProcessorPil'}(ResNetConfig モデル)
  • rf_detr — {'torchvision': 'RfDetrImageProcessor'} (RfDetrConfig モデル)
  • rt_detr — {'pil': 'RTDetrImageProcessorPil', 'torchvision': 'RTDetrImageProcessor'}(RTDetrConfig モデル)
  • sam — {'pil': 'SamImageProcessorPil', 'torchvision': 'SamImageProcessor'} (SamConfig モデル)
  • sam2 — {'torchvision': 'Sam2ImageProcessor'} (Sam2Config モデル)
  • sam2_video — {'torchvision': 'Sam2ImageProcessor'}(Sam2VideoConfig モデル)
  • sam3 — {'torchvision': 'Sam3ImageProcessor'} (Sam3Config モデル)
  • sam3_lite_text — {'torchvision': 'Sam3ImageProcessor'} (Sam3LiteTextConfig モデル)
  • sam3_tracker — {'torchvision': 'Sam3ImageProcessor'} (Sam3TrackerConfig モデル)
  • sam3_tracker_video — {'torchvision': 'Sam3ImageProcessor'} (Sam3TrackerVideoConfig モデル)
  • sam3_video — {'torchvision': 'Sam3ImageProcessor'} (Sam3VideoConfig モデル)
  • sam_hq — {'torchvision': 'SamImageProcessor', 'pil': 'SamImageProcessorPil'}(SamHQConfig モデル)
  • sapiens2 — {'torchvision': 'Sapiens2ImageProcessor'} (Sapiens2Config モデル)
  • segformer — {'pil': 'SegformerImageProcessorPil', 'torchvision': 'SegformerImageProcessor'} (SegformerConfig モデル)
  • seggpt — {'pil': 'SegGptImageProcessorPil', 'torchvision': 'SegGptImageProcessor'}(SegGptConfig モデル)
  • shieldgemma2 — {'torchvision': 'Gemma3ImageProcessor', 'pil': 'Gemma3ImageProcessorPil'}(ShieldGemma2Config モデル)
  • siglip — {'pil': 'SiglipImageProcessorPil', 'torchvision': 'SiglipImageProcessor'} (SiglipConfig モデル)
  • siglip2 — {'pil': 'Siglip2ImageProcessorPil', 'torchvision': 'Siglip2ImageProcessor'} (Siglip2Config モデル)
  • slanet — {'torchvision': 'SLANeXtImageProcessor'}(SLANetConfigモデル)
  • slanext — {'torchvision': 'SLANeXtImageProcessor'} (SLANeXtConfig モデル)
  • smolvlm — {'pil': 'SmolVLMImageProcessorPil', 'torchvision': 'SmolVLMImageProcessor'} (SmolVLMConfig モデル)
  • step3p7 — {'torchvision': 'Step3p7ImageProcessor'} (Step3p7Config モデル)
  • superglue — {'pil': 'SuperGlueImageProcessorPil', 'torchvision': 'SuperGlueImageProcessor'} (SuperGlueConfig モデル)
  • superpoint — {'pil': 'SuperPointImageProcessorPil', 'torchvision': 'SuperPointImageProcessor'}(SuperPointConfig モデル)
  • swiftformer — {'torchvision': 'ViTImageProcessor', 'pil': 'ViTImageProcessorPil'} (SwiftFormerConfig モデル)
  • swin — {'torchvision': 'ViTImageProcessor', 'pil': 'ViTImageProcessorPil'} (SwinConfig モデル)
  • swin2sr — {'pil': 'Swin2SRImageProcessorPil', 'torchvision': 'Swin2SRImageProcessor'}(Swin2SRConfig モデル)
  • swinv2 — {'torchvision': 'ViTImageProcessor', 'pil': 'ViTImageProcessorPil'} (Swinv2Config モデル)
  • t5gemma2 — {'torchvision': 'Gemma3ImageProcessor', 'pil': 'Gemma3ImageProcessorPil'}(T5Gemma2Config モデル)
  • t5gemma2_encoder — {'torchvision': 'Gemma3ImageProcessor', 'pil': 'Gemma3ImageProcessorPil'}(T5Gemma2EncoderConfig モデル)
  • table-transformer — {'torchvision': 'DetrImageProcessor', 'pil': 'DetrImageProcessorPil'} (TableTransformerConfig モデル)
  • textnet — {'pil': 'TextNetImageProcessorPil', 'torchvision': 'TextNetImageProcessor'}(TextNetConfig モデル)
  • timesformer — {'pil': 'VideoMAEImageProcessorPil', 'torchvision': 'VideoMAEImageProcessor'} (TimesformerConfig モデル)
  • timm_wrapper — {'pil': 'TimmWrapperImageProcessor'} (TimmWrapperConfig モデル)
  • tipsv2 — {'torchvision': 'Tipsv2ImageProcessor'} (Tipsv2Config モデル)
  • tipsv2_dpt — {'torchvision': 'Tipsv2DptImageProcessor'} (Tipsv2DptConfig モデル)
  • trocr — {'torchvision': 'ViTImageProcessor', 'pil': 'ViTImageProcessorPil'} (TrOCRConfig モデル)
  • tvp — {'pil': 'TvpImageProcessorPil', 'torchvision': 'TvpImageProcessor'} (TvpConfig モデル)
  • udop — {'torchvision': 'LayoutLMv3ImageProcessor', 'pil': 'LayoutLMv3ImageProcessorPil'} (UdopConfig モデル)
  • ultravbert — {'torchvision': 'UltraVBertImageProcessor'} (UltraVBertConfig モデル)
  • unlimited_ocr — {'torchvision': 'UnlimitedOcrImageProcessor'} (UnlimitedOcrConfig モデル)
  • upernet — {'torchvision': 'SegformerImageProcessor', 'pil': 'SegformerImageProcessorPil'} (UperNetConfig モデル)
  • uvdoc — {'torchvision': 'UVDocImageProcessor'} (UVDocConfig モデル)
  • video_llama_3 — {'pil': 'VideoLlama3ImageProcessorPil', 'torchvision': 'VideoLlama3ImageProcessor'} (VideoLlama3Config モデル)
  • video_llava — {'pil': 'VideoLlavaImageProcessor'}(VideoLlavaConfig モデル)
  • videomae — {'pil': 'VideoMAEImageProcessorPil', 'torchvision': 'VideoMAEImageProcessor'} (VideoMAEConfig モデル)
  • vilt — {'pil': 'ViltImageProcessorPil', 'torchvision': 'ViltImageProcessor'} (ViltConfig モデル)
  • vipllava — {'torchvision': 'CLIPImageProcessor', 'pil': 'CLIPImageProcessorPil'} (VipLlavaConfig モデル)
  • vit — {'pil': 'ViTImageProcessorPil', 'torchvision': 'ViTImageProcessor'} (ViTConfig モデル)
  • vit_mae — {'torchvision': 'ViTImageProcessor', 'pil': 'ViTImageProcessorPil'} (ViTMAEConfig モデル)
  • vit_msn — {'torchvision': 'ViTImageProcessor', 'pil': 'ViTImageProcessorPil'}(ViTMSNConfig モデル)
  • vitmatte — {'pil': 'VitMatteImageProcessorPil', 'torchvision': 'VitMatteImageProcessor'} (VitMatteConfig モデル)
  • vitpose — {'pil': 'VitPoseImageProcessorPil', 'torchvision': 'VitPoseImageProcessor'} (VitPoseConfig モデル)
  • vivit — {'torchvision': 'VivitImageProcessor'}(VivitConfig モデル)
  • xclip — {'torchvision': 'CLIPImageProcessor', 'pil': 'CLIPImageProcessorPil'} (XCLIPConfig モデル)
  • yolos — {'pil': 'YolosImageProcessorPil', 'torchvision': 'YolosImageProcessor'} (YolosConfig モデル)
  • zoedepth — {'pil': 'ZoeDepthImageProcessorPil', 'torchvision': 'ZoeDepthImageProcessor'}(ZoeDepthConfig モデル)

プライベートモデルを使用する場合は、token=True を渡す必要があります。

例:

>>> from transformers import AutoImageProcessor

>>> # Download image processor from huggingface.co and cache.
>>> image_processor = AutoImageProcessor.from_pretrained("google/vit-base-patch16-224-in21k")

>>> # If image processor files are in a directory (e.g. image processor was saved using *save_pretrained('./test/saved_model/')*)
>>> # image_processor = AutoImageProcessor.from_pretrained("./test/saved_model/")

register

< >

( config_classslow_image_processor_class: type | None = Nonefast_image_processor_class: type | None = Noneimage_processor_classes: dict[str, type] | None = Noneexist_ok: bool = False )

パラメータ

  • config_class (PreTrainedConfig) — 登録対象のモデルに対応する設定です。
  • slow_image_processor_class (type、省略可) — PIL バックエンドの画像プロセッサクラスです(非推奨。image_processor_classes={"pil": ...} を使用してください)。
  • fast_image_processor_class (type、省略可) — Torchvision バックエンドの画像プロセッサクラスです(非推奨。image_processor_classes={"torchvision": ...} を使用してください)。
  • image_processor_classes (dict[str, type]、省略可) — バックエンド名をキーに、画像プロセッサクラスを値とする辞書。カスタムバックエンドの登録を許可します。 例: {"pil": MyPilProcessor, "torchvision": MyTorchvisionProcessor, "custom": MyCustomProcessor}
  • exist_ok (bool、省略可、デフォルトはFalse) — Trueの場合、既存の登録を上書きすることを許可します。

このクラスに新しい画像プロセッサを登録します。

AutoVideoProcessor

バックエンドの選択、カスタム登録、および保存と再読み込みについては、Video processor backendsを参照してください。

class transformers.AutoVideoProcessor

< >

( )

これは汎用のビデオプロセッサクラスであり、AutoVideoProcessor.from_pretrained() クラスメソッドで生成されると、ライブラリのビデオプロセッサクラスのいずれかとしてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_pretrained

< >

( pretrained_model_name_or_path*inputs**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 次のいずれかです:
    • 文字列、huggingface.co上のモデルリポジトリにホストされている事前学習済みvideo_processorのmodel id
    • save_pretrained() メソッドを使用して保存されたビデオプロセッサファイルを含むディレクトリへのパス。例: ./my_model_directory/
    • 保存されたビデオプロセッサの JSON ファイルへのパス。例: ./my_model_directory/preprocessor_config.json
  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの video processor をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — 存在する場合はキャッシュされたバージョンを上書きし、動画プロセッサのファイルを(再)ダウンロードすることを強制するかどうか。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}. 各リクエストでこれらのプロキシが使用されます。
  • token (str または bool、省略可) — リモートファイルの HTTP ベアラ認証に使用するトークン。True の場合、hf auth login を実行した際に生成されたトークン(~/.huggingface に保存)を使用します。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • return_unused_kwargs (bool、省略可、デフォルトは False) — False の場合、この関数は最終的な video processor オブジェクトのみを返します。True の場合、この関数は Tuple(video_processor, unused_kwargs) を返します。ここで unused_kwargs は、キーが video processor の属性でないキー/値のペアで構成される辞書です。つまり、video_processor の更新に使用されず、それ以外は無視される kwargs の部分です。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • kwargs (dict[str, Any]、省略可) — kwargs 内の、キーが video processor の属性である値は、読み込まれた値の上書きに使用されます。キーが video processor の属性でないキー/値ペアの動作は、return_unused_kwargs キーワード引数によって制御されます。

事前学習済みモデルの語彙から、ライブラリの動画プロセッサクラスのいずれかをインスタンス化します。

インスタンス化されるビデオプロセッサのクラスは、設定オブジェクトのmodel_typeプロパティに基づいて選択されます(引数として渡されるか、可能な場合はpretrained_model_name_or_pathから読み込まれます)。model_typeが欠落している場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックします。

  • cohere_compass — {'torchvision': 'CohereCompassVideoProcessor'} (CohereCompassConfig モデル)
  • cosmos3_edge — {'torchvision': 'Cosmos3EdgeVideoProcessor'} (Cosmos3EdgeConfig モデル)
  • cosmos3_omni — {'torchvision': 'Qwen3VLVideoProcessor'}(Cosmos3OmniConfig モデル)
  • dots3_note — {'torchvision': 'Qwen3VLVideoProcessor'}(Dots3NoteConfigモデル)
  • embedding_gemma2 — {'torchvision': 'EmbeddingGemma2VideoProcessor'} (EmbeddingGemma2Config モデル)
  • ernie4_5_vl_moe — {'torchvision': 'Ernie4_5_VLMoeVideoProcessor'}(Ernie4_5_VLMoeConfig モデル)
  • exaone4_5 — {'torchvision': 'Qwen2VLVideoProcessor'}(Exaone4_5_Config モデル)
  • gemma4 — {'torchvision': 'Gemma4VideoProcessor'} (Gemma4Config モデル)
  • gemma4_unified — {'torchvision': 'Gemma4UnifiedVideoProcessor'} (Gemma4UnifiedConfig モデル)
  • glm46v — {'torchvision': 'Glm46VVideoProcessor'} (Glm46VConfig モデル)
  • glm4v — {'torchvision': 'Glm4vVideoProcessor'}(Glm4vConfig モデル)
  • glm5_next — {'torchvision': 'Glm5NextVideoProcessor'} (Glm5NextConfig モデル)
  • glmga — {'torchvision': 'GlmgaVideoProcessor'} (GlmgaConfig モデル)
  • hy_v4_vl — {'torchvision': 'HYV4VLVideoProcessor'} (HYV4VLConfig モデル)
  • hyperclovax_vision_v2 — {'torchvision': 'Qwen2VLVideoProcessor'} (HyperCLOVAXVisionV2Config モデル)
  • instructblip — {'torchvision': 'InstructBlipVideoVideoProcessor'}(InstructBlipConfig モデル)
  • instructblipvideo — {'torchvision': 'InstructBlipVideoVideoProcessor'}(InstructBlipVideoConfig モデル)
  • internvl — {'torchvision': 'InternVLVideoProcessor'} (InternVLConfig モデル)
  • kimi_k25 — {'torchvision': 'Kimi_K25VideoProcessor'} (Kimi_K25Config モデル)
  • lfm3_vl — {'torchvision': 'Qwen3VLVideoProcessor'}(Lfm3VlConfig モデル)
  • llava_next_video — {'torchvision': 'LlavaNextVideoVideoProcessor'} (LlavaNextVideoConfig モデル)
  • llava_onevision — {'torchvision': 'LlavaOnevisionVideoProcessor'}(LlavaOnevisionConfig モデル)
  • minicpm_ocr — {'torchvision': 'MiniCPMOcrVideoProcessor'}(MiniCPMOcrConfig モデル)
  • minicpmv4_6 — {'torchvision': 'MiniCPMV4_6VideoProcessor'}(MiniCPMV4_6Config モデル)
  • minicpmv4_7 — {'torchvision': 'MiniCPMV4_6VideoProcessor'}(MiniCPMV4_7Config モデル)
  • minimax_m3_vl — {'torchvision': 'MiniMaxM3VLVideoProcessor'}(MiniMaxM3VLConfig モデル)
  • molmo2 — {'torchvision': 'Molmo2VideoProcessor'}(Molmo2Config モデル)
  • muse_glimmer — {'torchvision': 'MuseGlimmerVideoProcessor'}(MuseGlimmerConfig モデル)
  • muse_spark — {'torchvision': 'MuseGlimmerVideoProcessor'} (MuseSparkConfig モデル)
  • nemotron_h_omni — {'torchvision': 'NemotronH_Omni_Reasoning_V3VideoProcessor'}(NemotronH_Omni_Reasoning_V3_Config モデル)
  • pe_audio_video — {'torchvision': 'PeVideoVideoProcessor'} (PeAudioVideoConfig モデル)
  • pe_video — {'torchvision': 'PeVideoVideoProcessor'} (PeVideoConfig モデル)
  • perception_lm — {'torchvision': 'PerceptionLMVideoProcessor'} (PerceptionLMConfig モデル)
  • qwen2_5_omni — {'torchvision': 'Qwen2VLVideoProcessor'} (Qwen2_5OmniConfig モデル)
  • qwen2_5_vl — {'torchvision': 'Qwen2VLVideoProcessor'} (Qwen2_5_VLConfig モデル)
  • qwen2_vl — {'torchvision': 'Qwen2VLVideoProcessor'} (Qwen2VLConfig モデル)
  • qwen3_5 — {'torchvision': 'Qwen3VLVideoProcessor'}(Qwen3_5Config モデル)
  • qwen3_5_moe — {'torchvision': 'Qwen3VLVideoProcessor'}(Qwen3_5MoeConfig モデル)
  • qwen3_omni_moe — {'torchvision': 'Qwen2VLVideoProcessor'} (Qwen3OmniMoeConfig モデル)
  • qwen3_vl — {'torchvision': 'Qwen3VLVideoProcessor'} (Qwen3VLConfig モデル)
  • qwen3_vl_moe — {'torchvision': 'Qwen3VLVideoProcessor'}(Qwen3VLMoeConfig モデル)
  • qwen4_exp — {'torchvision': 'Qwen3VLVideoProcessor'}(Qwen4ExpConfig モデル)
  • sam2_video — {'torchvision': 'Sam2VideoVideoProcessor'} (Sam2VideoConfig モデル)
  • smolvlm — {'torchvision': 'SmolVLMVideoProcessor'}(SmolVLMConfig モデル)
  • timesformer — {'torchvision': 'TimesformerVideoProcessor'} (TimesformerConfig モデル)
  • video_llama_3 — {'torchvision': 'VideoLlama3VideoProcessor'} (VideoLlama3Config モデル)
  • video_llava — {'torchvision': 'VideoLlavaVideoProcessor'} (VideoLlavaConfig モデル)
  • videomae — {'torchvision': 'VideoMAEVideoProcessor'} (VideoMAEConfig モデル)
  • videomt — {'torchvision': 'VideomtVideoProcessor'} (VideomtConfig モデル)
  • videoprism — {'torchvision': 'LlavaOnevisionVideoProcessor'}(VideoPrismConfig モデル)
  • vivit — {'torchvision': 'VivitVideoProcessor'} (VivitConfig モデル)
  • vjepa2 — {'torchvision': 'VJEPA2VideoProcessor'}(VJEPA2Config モデル)

プライベートモデルを使用する場合は、token=True を渡す必要があります。

例:

>>> from transformers import AutoVideoProcessor

>>> # Download video processor from huggingface.co and cache.
>>> video_processor = AutoVideoProcessor.from_pretrained("llava-hf/llava-onevision-qwen2-0.5b-ov-hf")

>>> # If video processor files are in a directory (e.g. video processor was saved using *save_pretrained('./test/saved_model/')*)
>>> # video_processor = AutoVideoProcessor.from_pretrained("./test/saved_model/")

register

< >

( config_classvideo_processor_class: type | None = Nonevideo_processor_classes: dict[str, type] | None = Noneexist_ok: bool = False )

パラメータ

  • config_class (PreTrainedConfig) — 登録対象のモデルに対応する設定です。
  • video_processor_class (BaseVideoProcessor) — 登録するビデオプロセッサ。
  • video_processor_classes (dict[str, type]、任意) — バックエンド名をビデオプロセッサクラスにマッピングする辞書です。カスタムバックエンドの登録を許可します。 例: {"pil": MyPilVideoProcessor, "torchvision": MyTorchvisionVideoProcessor, "custom": MyCustomVideoProcessor}
  • exist_ok (bool、省略可、デフォルトはFalse) — Trueの場合、既存の登録を上書きすることを許可します。

このクラスに新しいビデオプロセッサを登録します。

AutoProcessor

class transformers.AutoProcessor

< >

( )

これは汎用のプロセッサクラスであり、AutoProcessor.from_pretrained() クラスメソッドで生成された場合、ライブラリのプロセッサクラスのいずれかとしてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_pretrained

< >

( pretrained_model_name_or_path**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 次のいずれかです:
    • 文字列、huggingface.co上のモデルリポジトリにホストされている事前学習済みfeature_extractorのmodel id
    • save_pretrained() メソッドを使用してプロセッサのファイルを保存した ディレクトリ へのパス。例: ./my_model_directory/
  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルのフィーチャーエクストラクターをキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — feature extractor のファイルを(再)ダウンロードを強制し、キャッシュされたバージョンが存在する場合にそれを上書きするかどうかを指定します。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}. 各リクエストでこれらのプロキシが使用されます。
  • token (str または bool、省略可) — リモートファイルの HTTP ベアラ認証に使用するトークン。True の場合、hf auth login を実行した際に生成されたトークン(~/.huggingface に保存)を使用します。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • return_unused_kwargs (bool、任意、デフォルトは False) — False の場合、この関数は最終的な feature extractor オブジェクトのみを返します。True の場合、この関数は Tuple(feature_extractor, unused_kwargs) を返します。ここで unused_kwargs は、キーが feature extractor の属性でないキー/値のペアで構成される辞書です。つまり、feature_extractor の更新に使用されず、それ以外は無視される kwargs の部分です。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • kwargs (dict[str, Any], 任意) — kwargs 内の、feature extractor の属性であるキーの値は、読み込まれた値の上書きに使用されます。キーが feature extractor の属性でないキー/値ペアの動作は、return_unused_kwargs キーワード引数によって制御されます。

事前学習済みモデルの語彙から、ライブラリのプロセッサクラスのいずれかをインスタンス化します。

インスタンス化されるプロセッサクラスは、設定オブジェクトのmodel_typeプロパティに基づいて選択されます(引数として渡されるか、可能な場合はpretrained_model_name_or_pathから読み込まれます):

プライベートモデルを使用する場合は、token=True を渡す必要があります。

例:

>>> from transformers import AutoProcessor

>>> # Download processor from huggingface.co and cache.
>>> processor = AutoProcessor.from_pretrained("facebook/wav2vec2-base-960h")

>>> # If processor files are in a directory (e.g. processor was saved using *save_pretrained('./test/saved_model/')*)
>>> # processor = AutoProcessor.from_pretrained("./test/saved_model/")

register

< >

( config_classprocessor_classexist_ok = False )

パラメータ

  • config_class (PreTrainedConfig) — 登録対象のモデルに対応する設定です。
  • processor_class (ProcessorMixin) — 登録するプロセッサ。

このクラスに新しいプロセッサを登録します。

汎用モデルクラス

ベースモデルクラスを特定のヘッドなしでインスタンス化するために、以下のautoクラスが利用可能です。

AutoModel

class transformers.AutoModel

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドを使用して作成された場合、ライブラリのベースモデルクラスのいずれかとしてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのベースモデルクラスのいずれかをインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModel

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModel.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

事前学習済みモデルから、ライブラリのベースモデルクラスのいずれかをインスタンス化します。

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModel

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModel.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModel.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

汎用事前学習クラス

以下は、事前学習ヘッド付きのモデルをインスタンス化するために利用可能なオートクラスです。

AutoModelForPreTraining

クラス transformers.AutoModelForPreTraining

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドで生成された場合、ライブラリのモデルクラスの一つ(事前学習ヘッド付き)としてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(事前学習ヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForPreTraining

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForPreTraining.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

…

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForPreTraining

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForPreTraining.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForPreTraining.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

自然言語処理

以下の自然言語処理タスクには、以下のオートクラスが利用可能です。

AutoModelForCausalLM

クラス transformers.AutoModelForCausalLM

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドで生成された場合、ライブラリのモデルクラスの一つ(因果言語モデリングヘッド付き)としてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(因果言語モデリングヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForCausalLM

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForCausalLM.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

…

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForCausalLM

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForCausalLM.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForCausalLM.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForMaskedLM

class transformers.AutoModelForMaskedLM

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained() クラスメソッドまたは from_config() クラスメソッドで生成された場合、マスク言語モデリングヘッドを備えたライブラリのモデルクラスのいずれかとしてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(マスクド言語モデリングヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForMaskedLM

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForMaskedLM.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

…

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForMaskedLM

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForMaskedLM.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForMaskedLM.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForMaskGeneration

class transformers.AutoModelForMaskGeneration

< >

( *args**kwargs )

AutoModelForSeq2SeqLM

クラス transformers.AutoModelForSeq2SeqLM

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドで生成された場合、ライブラリのモデルクラスのいずれか(シーケンスツーシーケンス言語モデリングヘッド付き)としてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの1つ(シーケンスツーシーケンス言語モデリングヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForSeq2SeqLM

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-t5/t5-base")
>>> model = AutoModelForSeq2SeqLM.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

…

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForSeq2SeqLM

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForSeq2SeqLM.from_pretrained("google-t5/t5-base")

>>> # Update configuration during loading
>>> model = AutoModelForSeq2SeqLM.from_pretrained("google-t5/t5-base", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForSequenceClassification

クラス transformers.AutoModelForSequenceClassification

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドで生成された場合、ライブラリのモデルクラスの一つ(シーケンス分類ヘッド付き)としてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの1つ(シーケンス分類ヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForSequenceClassification

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForSequenceClassification.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

…

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForSequenceClassification

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForSequenceClassification.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForSequenceClassification.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForMultipleChoice

class transformers.AutoModelForMultipleChoice

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドで生成された場合、ライブラリのモデルクラスの一つ(マルチチョイスヘッド付き)としてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(マルチチョイスヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForMultipleChoice

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForMultipleChoice.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

ライブラリのモデルクラスの一つ(multiple choice head付き)を、事前学習済みモデルからインスタンス化します。

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForMultipleChoice

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForMultipleChoice.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForMultipleChoice.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForNextSentencePrediction

class transformers.AutoModelForNextSentencePrediction

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドで生成された場合、ライブラリのモデルクラスの一つ(次の文予測ヘッド付き)としてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(次の文の予測ヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForNextSentencePrediction

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForNextSentencePrediction.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

…

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForNextSentencePrediction

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForNextSentencePrediction.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForNextSentencePrediction.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForTokenClassification

クラス transformers.AutoModelForTokenClassification

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドで生成された場合、トークン分類ヘッドを持つライブラリのモデルクラスのいずれかとしてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(トークン分類ヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForTokenClassification

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForTokenClassification.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

…

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForTokenClassification

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForTokenClassification.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForTokenClassification.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForQuestionAnswering

クラス transformers.AutoModelForQuestionAnswering

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained() クラスメソッドまたは from_config() クラスメソッドで生成された場合、質問応答ヘッドを備えたライブラリのモデルクラスのいずれかとしてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(質問応答ヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForQuestionAnswering

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForQuestionAnswering.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

…

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForQuestionAnswering

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForQuestionAnswering.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForQuestionAnswering.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForTextEncoding

クラス transformers.AutoModelForTextEncoding

< >

( *args**kwargs )

コンピュータビジョン

以下のコンピュータビジョンタスクには、以下のautoクラスが利用可能です。

AutoModelForDepthEstimation

class transformers.AutoModelForDepthEstimation

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained() クラスメソッドまたは from_config() クラスメソッドで生成された場合、ライブラリのモデルクラスの一つ(深度推定ヘッド付き)としてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(深度推定ヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForDepthEstimation

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForDepthEstimation.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

ライブラリのモデルクラスの一つ(深度推定ヘッド付き)を、事前学習済みモデルからインスタンス化します。

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForDepthEstimation

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForDepthEstimation.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForDepthEstimation.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForNormalEstimation

クラス transformers.AutoModelForNormalEstimation

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドで生成された場合、通常の推定ヘッドを持つライブラリのモデルクラスのいずれかとしてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(通常の推定ヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForNormalEstimation

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForNormalEstimation.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

…

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForNormalEstimation

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForNormalEstimation.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForNormalEstimation.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForPointmapEstimation

class transformers.AutoModelForPointmapEstimation

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドで生成された場合、ライブラリのモデルクラスの一つ(pointmap推定ヘッド付き)としてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(pointmap推定ヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForPointmapEstimation

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForPointmapEstimation.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

ライブラリのモデルクラスの一つ(pointmap推定ヘッド付き)を、事前学習済みモデルからインスタンス化します。

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForPointmapEstimation

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForPointmapEstimation.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForPointmapEstimation.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForImageMatting

class transformers.AutoModelForImageMatting

< >

( *args**kwargs )

This is a generic model class that will be instantiated as one of the model classes of the library (with a image matting head) when created with the from_pretrained() class method or the from_config() class method.

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(image matting head付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForImageMatting

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForImageMatting.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

…

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForImageMatting

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForImageMatting.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForImageMatting.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForTextRecognition

class transformers.AutoModelForTextRecognition

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドで生成された場合、テキスト認識ヘッドを備えたライブラリのモデルクラスのいずれかとしてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(テキスト認識ヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForTextRecognition

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForTextRecognition.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

…

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForTextRecognition

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForTextRecognition.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForTextRecognition.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForTableRecognition

class transformers.AutoModelForTableRecognition

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドで生成された場合、テーブル認識ヘッドを持つライブラリのモデルクラスのいずれかとしてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(テーブル認識ヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForTableRecognition

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForTableRecognition.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

…

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForTableRecognition

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForTableRecognition.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForTableRecognition.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForImageClassification

class transformers.AutoModelForImageClassification

< >

( *args**kwargs )

これは汎用のモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドで生成された場合、ライブラリのモデルクラスの一つ(画像分類ヘッド付き)としてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(画像分類ヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForImageClassification

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForImageClassification.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

…

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForImageClassification

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForImageClassification.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForImageClassification.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForVideoClassification

class transformers.AutoModelForVideoClassification

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドで生成された場合、ライブラリのモデルクラスの一つ(動画分類ヘッド付き)としてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(動画分類ヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForVideoClassification

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForVideoClassification.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

ライブラリのモデルクラスの一つ(動画分類ヘッド付き)を事前学習済みモデルからインスタンス化します。

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForVideoClassification

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForVideoClassification.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForVideoClassification.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForPoseEstimation

class transformers.AutoModelForPoseEstimation

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドで生成された場合、ライブラリのモデルクラスの一つ(ポーズ推定ヘッド付き)としてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(ポーズ推定ヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForPoseEstimation

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForPoseEstimation.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

…

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForPoseEstimation

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForPoseEstimation.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForPoseEstimation.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForKeypointDetection

class transformers.AutoModelForKeypointDetection

< >

( *args**kwargs )

AutoModelForKeypointMatching

class transformers.AutoModelForKeypointMatching

< >

( *args**kwargs )

AutoModelForMaskedImageModeling

class transformers.AutoModelForMaskedImageModeling

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドで生成された場合、マスクドイメージモデリングヘッドを持つライブラリのモデルクラスのいずれかとしてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(マスクドイメージモデリングヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForMaskedImageModeling

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForMaskedImageModeling.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

…

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForMaskedImageModeling

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForMaskedImageModeling.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForMaskedImageModeling.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForObjectDetection

class transformers.AutoModelForObjectDetection

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドで生成された場合、オブジェクト検出ヘッドを持つライブラリのモデルクラスのいずれかとしてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(オブジェクト検出ヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForObjectDetection

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForObjectDetection.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

ライブラリのモデルクラスの一つ(object detection head付き)を、事前学習済みモデルからインスタンス化します。

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForObjectDetection

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForObjectDetection.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForObjectDetection.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForImageSegmentation

class transformers.AutoModelForImageSegmentation

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドで生成された場合、ライブラリのモデルクラスの一つ(画像セグメンテーションヘッド付き)としてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(画像セグメンテーションヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForImageSegmentation

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForImageSegmentation.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

…

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForImageSegmentation

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForImageSegmentation.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForImageSegmentation.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForImageToImage

クラス transformers.AutoModelForImageToImage

< >

( *args**kwargs )

AutoModelForSemanticSegmentation

クラス transformers.AutoModelForSemanticSegmentation

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドで生成されると、セマンティックセグメンテーションヘッド付きのライブラリのモデルクラスのいずれかとしてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(セマンティックセグメンテーションヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForSemanticSegmentation

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForSemanticSegmentation.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

Transformers ライブラリのモデルクラスの一つ(セマンティックセグメンテーションヘッド付き)を、事前学習済みモデルからインスタンス化します。

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForSemanticSegmentation

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForSemanticSegmentation.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForSemanticSegmentation.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForInstanceSegmentation

クラス transformers.AutoModelForInstanceSegmentation

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドで生成された場合、インスタンスセグメンテーションヘッド付きのライブラリのモデルクラスのいずれかとしてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(インスタンスセグメンテーションヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForInstanceSegmentation

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForInstanceSegmentation.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

…

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForInstanceSegmentation

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForInstanceSegmentation.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForInstanceSegmentation.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForUniversalSegmentation

class transformers.AutoModelForUniversalSegmentation

< >

( *args**kwargs )

これは汎用のモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドで生成された場合、このライブラリのモデルクラスのいずれか(汎用の画像セグメンテーションヘッド付き)としてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(汎用画像セグメンテーションヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForUniversalSegmentation

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForUniversalSegmentation.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

…

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForUniversalSegmentation

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForUniversalSegmentation.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForUniversalSegmentation.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForZeroShotImageClassification

class transformers.AutoModelForZeroShotImageClassification

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドで生成された場合、ライブラリのモデルクラスの一つ(ゼロショット画像分類ヘッド付き)としてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの1つ(ゼロショット画像分類ヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForZeroShotImageClassification

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForZeroShotImageClassification.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

…

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForZeroShotImageClassification

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForZeroShotImageClassification.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForZeroShotImageClassification.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForZeroShotObjectDetection

class transformers.AutoModelForZeroShotObjectDetection

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドで生成された場合、このライブラリのモデルクラスのいずれか(ゼロショットオブジェクト検出ヘッド付き)としてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(ゼロショットオブジェクト検出ヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForZeroShotObjectDetection

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForZeroShotObjectDetection.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

…

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForZeroShotObjectDetection

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForZeroShotObjectDetection.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForZeroShotObjectDetection.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

オーディオ

以下の音声タスクには、以下のオートクラスが利用可能です。

AutoModelForAudioClassification

クラス transformers.AutoModelForAudioClassification

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained() クラスメソッドまたは from_config() クラスメソッドで生成された場合、このライブラリのモデルクラスのいずれか(音声分類ヘッド付き)としてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(音声分類ヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForAudioClassification

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForAudioClassification.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

…

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForAudioClassification

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForAudioClassification.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForAudioClassification.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForAudioFrameClassification

class transformers.AutoModelForAudioFrameClassification

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドで生成された場合、このライブラリのモデルクラスの一つ(音声フレーム(トークン)分類ヘッド付き)としてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの1つ(音声フレーム(トークン)分類ヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForAudioFrameClassification

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForAudioFrameClassification.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

ライブラリのモデルクラスの一つを、事前学習済みモデルからインスタンス化します(音声フレーム(トークン)分類ヘッド付き)。

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForAudioFrameClassification

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForAudioFrameClassification.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForAudioFrameClassification.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForCTC

class transformers.AutoModelForCTC

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドで生成された場合、接続時間分類ヘッドを持つライブラリのモデルクラスのいずれかとしてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(接続時間分類ヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForCTC

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForCTC.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

…

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForCTC

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForCTC.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForCTC.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForTDT

class transformers.AutoModelForTDT

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドで生成された場合、ライブラリのモデルクラスのいずれか(トークンと持続時間のトランスダクサーヘッド付き)としてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(トークンと持続時間のトランスダクサーヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForTDT

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForTDT.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

…

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForTDT

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForTDT.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForTDT.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForRNNT

class transformers.AutoModelForRNNT

< >

( *args**kwargs )

This is a generic model class that will be instantiated as one of the model classes of the library (with a RNN transducer head) when created with the from_pretrained() class method or the from_config() class method.

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(RNN transducer head付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForRNNT

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForRNNT.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

ライブラリのモデルクラスの一つ(RNN transducer head付き)を、事前学習済みモデルからインスタンス化します。

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForRNNT

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForRNNT.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForRNNT.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForSpeechSeq2Seq

class transformers.AutoModelForSpeechSeq2Seq

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドで生成された場合、ライブラリのモデルクラスのいずれか(シーケンスツーシーケンスの音声認識モデリングヘッド付き)としてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(シーケンスツーシーケンスの音声認識モデリングヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForSpeechSeq2Seq

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForSpeechSeq2Seq.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

ライブラリのモデルクラスの一つ(シーケンスツーシーケンスの音声認識モデリングヘッド付き)を、事前学習済みモデルからインスタンス化します。

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForSpeechSeq2Seq

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForSpeechSeq2Seq.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForSpeechSeq2Seq.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForAudioXVector

class transformers.AutoModelForAudioXVector

< >

( *args**kwargs )

This is a generic model class that will be instantiated as one of the model classes of the library (with a audio retrieval via x-vector head) when created with the from_pretrained() class method or the from_config() class method.

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(x-vectorヘッドによる音声検索)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForAudioXVector

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForAudioXVector.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

…

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForAudioXVector

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForAudioXVector.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForAudioXVector.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForTextToSpectrogram

class transformers.AutoModelForTextToSpectrogram

< >

( *args**kwargs )

AutoModelForTextToWaveform

class transformers.AutoModelForTextToWaveform

< >

( *args**kwargs )

AutoModelForAudioTokenization

class transformers.AutoModelForAudioTokenization

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドで生成された場合、ライブラリのモデルクラスのいずれかとして(codebooksヘッドによる音声トークナイズを備えて)インスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの1つ(コードブックヘッドによる音声トークナイズを備えたもの)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForAudioTokenization

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForAudioTokenization.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

…

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForAudioTokenization

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForAudioTokenization.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForAudioTokenization.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

マルチモーダル

以下のマルチモーダルタスクには、以下のオートクラスが利用可能です。

AutoModelForMultimodalLM

クラス transformers.AutoModelForMultimodalLM

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained() クラスメソッドまたは from_config() クラスメソッドで生成された場合、このライブラリのモデルクラスの一つ(マルチモーダル生成ヘッド付き)としてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(マルチモーダル生成ヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForMultimodalLM

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForMultimodalLM.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

…

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForMultimodalLM

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForMultimodalLM.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForMultimodalLM.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForTableQuestionAnswering

class transformers.AutoModelForTableQuestionAnswering

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドで生成された場合、テーブル質問応答ヘッドを持つライブラリのモデルクラスのいずれかとしてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(テーブル質問応答ヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForTableQuestionAnswering

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google/tapas-base-finetuned-wtq")
>>> model = AutoModelForTableQuestionAnswering.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

ライブラリのモデルクラスの一つ(テーブル質問応答ヘッド付き)を、事前学習済みモデルからインスタンス化します。

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForTableQuestionAnswering

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForTableQuestionAnswering.from_pretrained("google/tapas-base-finetuned-wtq")

>>> # Update configuration during loading
>>> model = AutoModelForTableQuestionAnswering.from_pretrained("google/tapas-base-finetuned-wtq", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForDocumentQuestionAnswering

class transformers.AutoModelForDocumentQuestionAnswering

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドで生成された場合、ドキュメント質問応答ヘッドを備えたライブラリのモデルクラスのいずれかとしてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(文書質問応答ヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForDocumentQuestionAnswering

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("impira/layoutlm-document-qa", revision="52e01b3")
>>> model = AutoModelForDocumentQuestionAnswering.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

…

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForDocumentQuestionAnswering

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForDocumentQuestionAnswering.from_pretrained("impira/layoutlm-document-qa", revision="52e01b3")

>>> # Update configuration during loading
>>> model = AutoModelForDocumentQuestionAnswering.from_pretrained("impira/layoutlm-document-qa", revision="52e01b3", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForVisualQuestionAnswering

class transformers.AutoModelForVisualQuestionAnswering

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドで生成された場合、ビジュアル質問応答ヘッドを備えたライブラリのモデルクラスのいずれかとしてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(ビジュアル質問応答ヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForVisualQuestionAnswering

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("dandelin/vilt-b32-finetuned-vqa")
>>> model = AutoModelForVisualQuestionAnswering.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

…

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForVisualQuestionAnswering

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForVisualQuestionAnswering.from_pretrained("dandelin/vilt-b32-finetuned-vqa")

>>> # Update configuration during loading
>>> model = AutoModelForVisualQuestionAnswering.from_pretrained("dandelin/vilt-b32-finetuned-vqa", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForImageTextToText

class transformers.AutoModelForImageTextToText

< >

( *args**kwargs )

This is a generic model class that will be instantiated as one of the model classes of the library (with a image-text-to-text modeling head) when created with the from_pretrained() class method or the from_config() class method.

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(image-text-to-textモデリングヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForImageTextToText

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForImageTextToText.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

ライブラリのモデルクラスの一つ(画像・テキストからテキストへの変換モデリングヘッド付き)を、事前学習済みモデルからインスタンス化します。

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForImageTextToText

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForImageTextToText.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForImageTextToText.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

AutoModelForDecision

クラス transformers.AutoModelForDecision

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドで生成された場合、決定ヘッド付きのライブラリのモデルクラスのいずれかとしてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(決定ヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForDecision

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForDecision.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

…

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForDecision

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForDecision.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForDecision.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True

時系列

AutoModelForTimeSeriesPrediction

クラス transformers.AutoModelForTimeSeriesPrediction

< >

( *args**kwargs )

これは汎用的なモデルクラスであり、from_pretrained()クラスメソッドまたはfrom_config()クラスメソッドで生成された場合、タイムシリーズ予測ヘッドを備えたライブラリのモデルクラスのいずれかとしてインスタンス化されます。

このクラスは__init__()を直接使用してインスタンス化することはできません(エラーが発生します)。

from_config

< >

( **kwargs )

パラメータ

設定から、ライブラリのモデルクラスの一つ(時系列予測ヘッド付き)をインスタンス化します。

注: 設定ファイルからモデルを読み込んでも、モデルの重みは読み込まれません。影響するのはモデルの設定のみです。モデルの重みを読み込むには、from_pretrained()を使用してください。

例:

>>> from transformers import AutoConfig, AutoModelForTimeSeriesPrediction

>>> # Download configuration from huggingface.co and cache.
>>> config = AutoConfig.from_pretrained("google-bert/bert-base-cased")
>>> model = AutoModelForTimeSeriesPrediction.from_config(config)

from_pretrained

< >

( *model_args**kwargs )

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike) — 以下のいずれかです:
    • huggingface.co のモデルリポジトリにホストされている事前学習済みモデルの model id を示す文字列。
    • save_pretrained() を使用して保存されたモデルの重みを含むディレクトリへのパス。例: ./my_model_directory/
  • model_args(追加の位置引数、省略可)— 基盤となるモデルの __init__() メソッドに渡されます。
  • config (PreTrainedConfig, 省略可) — 自動的に読み込まれる設定の代わりに使用するモデルの設定。以下の条件を満たす場合、設定は自動的に読み込まれます:
    • モデルは、ライブラリによって提供されるモデルです(事前学習済みモデルのmodel id文字列で読み込まれます)。
    • モデルはsave_pretrained()を使用して保存されており、保存ディレクトリを指定することで再読み込みされます。
    • モデルは、ローカルディレクトリをpretrained_model_name_or_pathとして指定して読み込まれ、そのディレクトリ内にconfig.jsonという名前の設定JSONファイルが見つかった場合です。
  • state_dict (dict[str, torch.Tensor], 省略可) — 保存された重みファイルから読み込まれる state dictionary の代わりに使用する state dictionary です。事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合にこのオプションを使用できます。ただし、この場合は save_pretrained() と from_pretrained() を使用した方が簡単ではないかを確認することをお勧めします。

    このオプションは、事前学習済みの設定からモデルを作成しつつ、独自の重みをロードしたい場合に使用できます。ただし、この場合は、save_pretrained()とfrom_pretrained()を使用する方がよりシンプルな方法ではないかを確認することをお勧めします。

  • cache_dir (str または os.PathLike、省略可) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習済みモデルの設定をキャッシュするディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みと設定ファイルを(再)ダウンロードを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それを上書きします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only(bool, 任意、デフォルトは False) — ローカルファイルのみを対象とするかどうか(モデルのダウンロードを試みないなど)。
  • revision (str、任意、デフォルトは "main") — 使用する特定のモデルのバージョンです。huggingface.co 上でモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、ブランチ名、タグ名、コミット ID のいずれかを指定できます。したがって、revision には git で許可される任意の識別子を指定できます。
  • trust_remote_code (bool、省略可、デフォルトは False) — Hub 上で独自の modeling ファイルによって定義されたカスタムモデルを許可するかどうか。このオプションは、信頼できるリポジトリで、かつコードを確認済みの場合にのみ True に設定してください。そうしないと、Hub に存在するコードがローカルマシン上で実行されてしまうためです。
  • code_revision (str、任意、デフォルトは "main") — モデルの他の部分とは異なるリポジトリにコードが存在する場合、Hub 上のコードに使用する特定のリビジョンです。huggingface.co ではモデルやその他の成果物を保存するために git ベースのシステムを使用しているため、revision には git で許可される任意の識別子を使用できます。具体的には、ブランチ名、タグ名、またはコミット ID を指定できます。
  • kwargs (追加のキーワード引数、 省略可能) — 設定オブジェクト(読み込み後)の更新やモデルの初期化(例: output_attentions=True). が提供されるかどうかによって動作が異なります。 config が提供される場合、または自動的に読み込まれる場合:
    • config で設定が提供されている場合、**kwargs は、基盤となるモデルの __init__ メソッドに直接渡されます(設定への関連するすべての更新がすでに完了しているものと仮定しています)。
    • 設定が提供されない場合、kwargs はまず設定クラスの初期化関数 (from_pretrained()) に渡されます。kwargs の各キーのうち、設定属性に対応するものは、指定された kwargs の値でその属性を上書きするために使用されます。設定属性に対応しない残りのキーは、基盤となるモデルの __init__ 関数に渡されます。

ライブラリのモデルクラスの一つ(時系列予測ヘッド付き)を事前学習済みモデルからインスタンス化します。

インスタンス化されるモデルクラスは、設定オブジェクトのmodel_typeプロパティ(引数として渡されたもの、または可能な場合はpretrained_model_name_or_pathから読み込まれたもの)に基づいて選択されます。このプロパティが存在しない場合は、pretrained_model_name_or_pathに対するパターンマッチングにフォールバックして選択されます。

モデルはデフォルトでmodel.eval()によって評価モードに設定されています(例えば、dropoutモジュールは無効化されます)。モデルを学習させるには、まずmodel.train()でトレーニングモードに戻す必要があります。

例:

>>> from transformers import AutoConfig, AutoModelForTimeSeriesPrediction

>>> # Download model and configuration from huggingface.co and cache.
>>> model = AutoModelForTimeSeriesPrediction.from_pretrained("google-bert/bert-base-cased")

>>> # Update configuration during loading
>>> model = AutoModelForTimeSeriesPrediction.from_pretrained("google-bert/bert-base-cased", output_attentions=True)
>>> model.config.output_attentions
True
Update on GitHub