# 通用工具

此页面列出了在`utils.py`文件中找到的所有Transformers通用实用函数。

其中大多数仅在您研究库中的通用代码时才有用。

## Enums和namedtuples(命名元组)[[transformers.utils.ExplicitEnum]]

<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>class transformers.utils.ExplicitEnum</name><anchor>transformers.utils.ExplicitEnum</anchor><source>https://github.com/huggingface/transformers/blob/v4.57.0/src/transformers/utils/generic.py#L473</source><parameters>[{"name": "value", "val": ""}, {"name": "names", "val": " = None"}, {"name": "module", "val": " = None"}, {"name": "qualname", "val": " = None"}, {"name": "type", "val": " = None"}, {"name": "start", "val": " = 1"}]</parameters></docstring>

Enum with more explicit error message for missing values.


</div>

<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>class transformers.utils.PaddingStrategy</name><anchor>transformers.utils.PaddingStrategy</anchor><source>https://github.com/huggingface/transformers/blob/v4.57.0/src/transformers/utils/generic.py#L485</source><parameters>[{"name": "value", "val": ""}, {"name": "names", "val": " = None"}, {"name": "module", "val": " = None"}, {"name": "qualname", "val": " = None"}, {"name": "type", "val": " = None"}, {"name": "start", "val": " = 1"}]</parameters></docstring>

Possible values for the `padding` argument in [PreTrainedTokenizerBase.__call__()](/docs/transformers/v4.57.0/zh/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.__call__). Useful for tab-completion in an
IDE.


</div>

<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>class transformers.TensorType</name><anchor>transformers.TensorType</anchor><source>https://github.com/huggingface/transformers/blob/v4.57.0/src/transformers/utils/generic.py#L496</source><parameters>[{"name": "value", "val": ""}, {"name": "names", "val": " = None"}, {"name": "module", "val": " = None"}, {"name": "qualname", "val": " = None"}, {"name": "type", "val": " = None"}, {"name": "start", "val": " = 1"}]</parameters></docstring>

Possible values for the `return_tensors` argument in [PreTrainedTokenizerBase.__call__()](/docs/transformers/v4.57.0/zh/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.__call__). Useful for
tab-completion in an IDE.


</div>

## 特殊的装饰函数[[transformers.add_start_docstrings]]

<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>transformers.add_start_docstrings</name><anchor>transformers.add_start_docstrings</anchor><source>https://github.com/huggingface/transformers/blob/v4.57.0/src/transformers/utils/doc.py#L37</source><parameters>[{"name": "*docstr", "val": ""}]</parameters></docstring>


</div>

<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>transformers.utils.add_start_docstrings_to_model_forward</name><anchor>transformers.utils.add_start_docstrings_to_model_forward</anchor><source>https://github.com/huggingface/transformers/blob/v4.57.0/src/transformers/utils/doc.py#L45</source><parameters>[{"name": "*docstr", "val": ""}]</parameters></docstring>


</div>

<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>transformers.add_end_docstrings</name><anchor>transformers.add_end_docstrings</anchor><source>https://github.com/huggingface/transformers/blob/v4.57.0/src/transformers/utils/doc.py#L81</source><parameters>[{"name": "*docstr", "val": ""}]</parameters></docstring>


</div>

<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>transformers.utils.add_code_sample_docstrings</name><anchor>transformers.utils.add_code_sample_docstrings</anchor><source>https://github.com/huggingface/transformers/blob/v4.57.0/src/transformers/utils/doc.py#L1455</source><parameters>[{"name": "*docstr", "val": ""}, {"name": "processor_class", "val": " = None"}, {"name": "checkpoint", "val": " = None"}, {"name": "output_type", "val": " = None"}, {"name": "config_class", "val": " = None"}, {"name": "mask", "val": " = '[MASK]'"}, {"name": "qa_target_start_index", "val": " = 14"}, {"name": "qa_target_end_index", "val": " = 15"}, {"name": "model_cls", "val": " = None"}, {"name": "modality", "val": " = None"}, {"name": "expected_output", "val": " = None"}, {"name": "expected_loss", "val": " = None"}, {"name": "real_checkpoint", "val": " = None"}, {"name": "revision", "val": " = None"}]</parameters></docstring>


</div>

<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>transformers.utils.replace_return_docstrings</name><anchor>transformers.utils.replace_return_docstrings</anchor><source>https://github.com/huggingface/transformers/blob/v4.57.0/src/transformers/utils/doc.py#L1554</source><parameters>[{"name": "output_type", "val": " = None"}, {"name": "config_class", "val": " = None"}]</parameters></docstring>


</div>

## 其他实用程序[[transformers.utils._LazyModule]]

<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>class transformers.utils._LazyModule</name><anchor>transformers.utils._LazyModule</anchor><source>https://github.com/huggingface/transformers/blob/v4.57.0/src/transformers/utils/import_utils.py#L2172</source><parameters>[{"name": "name", "val": ": str"}, {"name": "module_file", "val": ": str"}, {"name": "import_structure", "val": ": dict"}, {"name": "module_spec", "val": ": typing.Optional[_frozen_importlib.ModuleSpec] = None"}, {"name": "extra_objects", "val": ": typing.Optional[dict[str, object]] = None"}, {"name": "explicit_import_shortcut", "val": ": typing.Optional[dict[str, list[str]]] = None"}]</parameters></docstring>

Module class that surfaces all objects but only performs associated imports when the objects are requested.


</div>

<EditOnGithub source="https://github.com/huggingface/transformers/blob/main/docs/source/zh/internal/file_utils.md" />