# 一般的なユーティリティ

このページでは、`utils.py` ファイルに含まれる Transformers の一般的なユーティリティ関数をすべて一覧にしています。

それらの多くは、ライブラリの一般的なコードを研究している場合にのみ有用です。

## Enum と namedtuple[[transformers.utils.ExplicitEnum]]

#### transformers.utils.ExplicitEnum[[transformers.utils.ExplicitEnum]]

```python
transformers.utils.ExplicitEnum(value, names = None, module = None, qualname = None, type = None, start = 1, boundary = None)
```

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/utils/generic.py#L664)

値が不足している場合、より明示的なエラーメッセージを返すEnum。

#### transformers.utils.PaddingStrategy[[transformers.utils.PaddingStrategy]]

```python
transformers.utils.PaddingStrategy(value, names = None, module = None, qualname = None, type = None, start = 1, boundary = None)
```

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/utils/generic.py#L676)

[PreTrainedTokenizerBase.__call__()](/docs/transformers/main/ja/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.__call__)の`padding`引数に指定可能な値。IDEでのタブ補完に便利です。

#### transformers.TensorType[[transformers.TensorType]]

```python
transformers.TensorType(value, names = None, module = None, qualname = None, type = None, start = 1, boundary = None)
```

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/utils/generic.py#L687)

[PreTrainedTokenizerBase.__call__()](/docs/transformers/main/ja/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.__call__) の `return_tensors` 引数に指定可能な値。IDEでのタブ補完に便利です。

## 特別なデコレーター[[transformers.add_start_docstrings]]

#### transformers.add_start_docstrings[[transformers.add_start_docstrings]]

```python
transformers.add_start_docstrings(*docstr)
```

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/utils/doc.py#L38)

#### transformers.utils.add_start_docstrings_to_model_forward[[transformers.utils.add_start_docstrings_to_model_forward]]

```python
transformers.utils.add_start_docstrings_to_model_forward(*docstr)
```

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/utils/doc.py#L46)

#### transformers.add_end_docstrings[[transformers.add_end_docstrings]]

```python
transformers.add_end_docstrings(*docstr)
```

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/utils/doc.py#L82)

#### transformers.utils.add_code_sample_docstrings[[transformers.utils.add_code_sample_docstrings]]

```python
transformers.utils.add_code_sample_docstrings(*docstr, processor_class = None, checkpoint = None, output_type = None, config_class = None, mask = '[MASK]', qa_target_start_index = 14, qa_target_end_index = 15, model_cls = None, modality = None, expected_output = None, expected_loss = None, real_checkpoint = None, revision = None)
```

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/utils/doc.py#L969)

#### transformers.utils.replace_return_docstrings[[transformers.utils.replace_return_docstrings]]

```python
transformers.utils.replace_return_docstrings(output_type = None, config_class = None)
```

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/utils/doc.py#L1063)

## その他のユーティリティ[[transformers.utils._LazyModule]]

#### transformers.utils._LazyModule[[transformers.utils._LazyModule]]

```python
transformers.utils._LazyModule(name: str, module_file: str, import_structure: dict[frozenset[str], dict[str, set[str]]], module_spec: _frozen_importlib.ModuleSpec | None = None, extra_objects: dict[str, object] | None = None, explicit_import_shortcut: dict[str, list[str]] | None = None)
```

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/utils/import_utils.py#L2535)

要求されたオブジェクトに対してのみ関連するインポートを実行するが、すべてのオブジェクトを公開するモジュールクラス。

