Buckets:

hf-doc-build
/

doc

Files

xet

hf-doc-build/doc / diffusers /main /ja /using-diffusers /automodel.md

mishig

7 days ago

preview code

download

raw

4.94 kB

# AutoModel

[AutoModel](/docs/diffusers/main/ja/api/models/auto_model#diffusers.AutoModel) クラスは、`config.json` ファイルから正しいモデルクラス（UNet、transformer、VAE）を自動的に検出し、読み込みます。事前に具体的なモデルクラス名を知る必要はありません。データ型とデバイスの配置をサポートし、モデルタイプやライブラリをまたいで動作します。

以下の例では、Diffusersからtransformerを読み込み、Transformersからテキストエンコーダーを読み込みます。`subfolder`パラメータを使用して、`config.json`ファイルを読み込む場所を指定します。

```py
import torch
from diffusers import AutoModel, DiffusionPipeline
transformer = AutoModel.from_pretrained(
    "Qwen/Qwen-Image", subfolder="transformer", dtype=torch.bfloat16, device_map="cuda"  # or "mps", "xpu", "cpu"
)
text_encoder = AutoModel.from_pretrained(
    "Qwen/Qwen-Image", subfolder="text_encoder", dtype=torch.bfloat16, device_map="cuda"
)
```

## カスタムモデル

[AutoModel](/docs/diffusers/main/ja/api/models/auto_model#diffusers.AutoModel) also loads models from the [Hub](https://huggingface.co/models) that aren't included in Diffusers. Set `trust_remote_code=True` in [AutoModel.from_pretrained()](/docs/diffusers/main/ja/api/models/auto_model#diffusers.AutoModel.from_pretrained) to load custom models.

カスタムモデルのリポジトリには、モデルクラスを含む Python モジュールと、`"AutoModel"` を `"module_file.ClassName"` にマッピングする `auto_map` エントリを持つ `config.json` が必要です。

```
custom/custom-transformer-model/
├── config.json
├── my_model.py
└── diffusion_pytorch_model.safetensors
```

`config.json`には、カスタムクラスを指す`auto_map`フィールドが含まれています。

```json
{
  "auto_map": {
    "AutoModel": "my_model.MyCustomModel"
  }
}
```

次に、`trust_remote_code=True` を指定して読み込みます。

```py
import torch
from diffusers import AutoModel
transformer = AutoModel.from_pretrained(
    "custom/custom-transformer-model", trust_remote_code=True, dtype=torch.bfloat16, device_map="cuda"  # or "mps", "xpu", "cpu"
)
```

実際の例として、[Overworld/Waypoint-1-Small](https://huggingface.co/Overworld/Waypoint-1-Small/tree/main/transformer)は、`transformer`サブフォルダー内の複数のモジュールにわたって、カスタムの`WorldModel`クラスをホストしています。

```
transformer/
├── config.json          # auto_map: "model.WorldModel"
├── model.py
├── attn.py
├── nn.py
├── cache.py
├── quantize.py
├── __init__.py
└── diffusion_pytorch_model.safetensors
```

```py
import torch
from diffusers import AutoModel
transformer = AutoModel.from_pretrained(
    "Overworld/Waypoint-1-Small", subfolder="transformer", trust_remote_code=True, dtype=torch.bfloat16, device_map="cuda"  # or "mps", "xpu", "cpu"
)
```

カスタムモデルが[ModelMixin](/docs/diffusers/main/ja/api/models/overview#diffusers.ModelMixin)クラスを継承している場合、[regional compilation](../optimization/fp16#regional-compilation)や[group offloading](../optimization/memory#group-offloading)など、Diffusersのモデルクラスと同じ機能を利用できます。

> [!WARNING]
> `trust_remote_code=True` を使用する場合の予防策として、[AutoModel.from_pretrained()](/docs/diffusers/main/ja/api/models/auto_model#diffusers.AutoModel.from_pretrained) の `revision` 引数にコミットハッシュを渡すことで、コードが新しい悪意あるコードで更新されていないことを確認してください（モデルの所有者を完全に信頼している場合を除く）。
>
> ```py
> transformer = AutoModel.from_pretrained(
>     "Overworld/Waypoint-1-Small", subfolder="transformer", trust_remote_code=True, revision="a3d8cb2"
> )
> ```
## カスタムモデルの保存
`register_for_auto_class()` を使用すると、保存時に `config.json` に `auto_map` エントリが自動的に追加されます。これにより、設定ファイルを手動で編集する必要がなくなります。
```py
# my_model.py
from diffusers import ModelMixin, ConfigMixin

class MyCustomModel(ModelMixin, ConfigMixin):
    ...
MyCustomModel.register_for_auto_class("AutoModel")
model = MyCustomModel(...)
model.save_pretrained("./my_model")
```
保存された`config.json`には、`auto_map`フィールドが含まれます。

```json
{
  "auto_map": {
    "AutoModel": "my_model.MyCustomModel"
  }
}
```

## 次のステップ

[コミュニティコンポーネント](../using-diffusers/custom_pipeline_overview#community-components)ガイドで、カスタムモデルの実装方法について詳しく学んでください。

Xet Storage Details

Size:: 4.94 kB
Xet hash:: 0823265056435ce32c926c1921ae9cb1fb552012b5aaa120fd23ac9d1a1178dd

Xet efficiently stores files, intelligently splitting them into unique chunks and accelerating uploads and downloads. More info.

	# AutoModel

	[AutoModel](/docs/diffusers/main/ja/api/models/auto_model#diffusers.AutoModel) クラスは、`config.json` ファイルから正しいモデルクラス（UNet、transformer、VAE）を自動的に検出し、読み込みます。事前に具体的なモデルクラス名を知る必要はありません。データ型とデバイスの配置をサポートし、モデルタイプやライブラリをまたいで動作します。

	以下の例では、Diffusersからtransformerを読み込み、Transformersからテキストエンコーダーを読み込みます。`subfolder`パラメータを使用して、`config.json`ファイルを読み込む場所を指定します。

	```py
	import torch
	from diffusers import AutoModel, DiffusionPipeline

	transformer = AutoModel.from_pretrained(
	"Qwen/Qwen-Image", subfolder="transformer", dtype=torch.bfloat16, device_map="cuda" # or "mps", "xpu", "cpu"
	)

	text_encoder = AutoModel.from_pretrained(
	"Qwen/Qwen-Image", subfolder="text_encoder", dtype=torch.bfloat16, device_map="cuda"
	)
	```

	## カスタムモデル

	[AutoModel](/docs/diffusers/main/ja/api/models/auto_model#diffusers.AutoModel) also loads models from the [Hub](https://huggingface.co/models) that aren't included in Diffusers. Set `trust_remote_code=True` in [AutoModel.from_pretrained()](/docs/diffusers/main/ja/api/models/auto_model#diffusers.AutoModel.from_pretrained) to load custom models.

	カスタムモデルのリポジトリには、モデルクラスを含む Python モジュールと、`"AutoModel"` を `"module_file.ClassName"` にマッピングする `auto_map` エントリを持つ `config.json` が必要です。

	```
	custom/custom-transformer-model/
	├── config.json
	├── my_model.py
	└── diffusion_pytorch_model.safetensors
	```

	`config.json`には、カスタムクラスを指す`auto_map`フィールドが含まれています。

	```json
	{
	"auto_map": {
	"AutoModel": "my_model.MyCustomModel"
	}
	}
	```

	次に、`trust_remote_code=True` を指定して読み込みます。

	```py
	import torch
	from diffusers import AutoModel

	transformer = AutoModel.from_pretrained(
	"custom/custom-transformer-model", trust_remote_code=True, dtype=torch.bfloat16, device_map="cuda" # or "mps", "xpu", "cpu"
	)
	```

	実際の例として、[Overworld/Waypoint-1-Small](https://huggingface.co/Overworld/Waypoint-1-Small/tree/main/transformer)は、`transformer`サブフォルダー内の複数のモジュールにわたって、カスタムの`WorldModel`クラスをホストしています。

	```
	transformer/
	├── config.json # auto_map: "model.WorldModel"
	├── model.py
	├── attn.py
	├── nn.py
	├── cache.py
	├── quantize.py
	├── __init__.py
	└── diffusion_pytorch_model.safetensors
	```

	```py
	import torch
	from diffusers import AutoModel

	transformer = AutoModel.from_pretrained(
	"Overworld/Waypoint-1-Small", subfolder="transformer", trust_remote_code=True, dtype=torch.bfloat16, device_map="cuda" # or "mps", "xpu", "cpu"
	)
	```

	カスタムモデルが[ModelMixin](/docs/diffusers/main/ja/api/models/overview#diffusers.ModelMixin)クラスを継承している場合、[regional compilation](../optimization/fp16#regional-compilation)や[group offloading](../optimization/memory#group-offloading)など、Diffusersのモデルクラスと同じ機能を利用できます。

	> [!WARNING]
	> `trust_remote_code=True` を使用する場合の予防策として、[AutoModel.from_pretrained()](/docs/diffusers/main/ja/api/models/auto_model#diffusers.AutoModel.from_pretrained) の `revision` 引数にコミットハッシュを渡すことで、コードが新しい悪意あるコードで更新されていないことを確認してください（モデルの所有者を完全に信頼している場合を除く）。
	>
	> ```py
	> transformer = AutoModel.from_pretrained(
	> "Overworld/Waypoint-1-Small", subfolder="transformer", trust_remote_code=True, revision="a3d8cb2"
	> )
	> ```

	## カスタムモデルの保存

	`register_for_auto_class()` を使用すると、保存時に `config.json` に `auto_map` エントリが自動的に追加されます。これにより、設定ファイルを手動で編集する必要がなくなります。

	```py
	# my_model.py
	from diffusers import ModelMixin, ConfigMixin

	class MyCustomModel(ModelMixin, ConfigMixin):
	...

	MyCustomModel.register_for_auto_class("AutoModel")

	model = MyCustomModel(...)
	model.save_pretrained("./my_model")
	```

	保存された`config.json`には、`auto_map`フィールドが含まれます。

	```json
	{
	"auto_map": {
	"AutoModel": "my_model.MyCustomModel"
	}
	}
	```

	## 次のステップ

	[コミュニティコンポーネント](../using-diffusers/custom_pipeline_overview#community-components)ガイドで、カスタムモデルの実装方法について詳しく学んでください。