transformers/pr_33892/en/internal/file_utils.md

# General Utilities

This page lists all of Transformers general utility functions that are found in the file `utils.py`.

Most of those are only useful if you are studying the general code in the library.

## Enums and 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/vr_33892/src/transformers/utils/generic.py#L389</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/vr_33892/src/transformers/utils/generic.py#L401</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/pr_33892/en/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/vr_33892/src/transformers/utils/generic.py#L412</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/pr_33892/en/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.__call__). Useful for
tab-completion in an IDE.


</div>

## Special Decorators[[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/vr_33892/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/vr_33892/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/vr_33892/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/vr_33892/src/transformers/utils/doc.py#L1006</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/vr_33892/src/transformers/utils/doc.py#L1100</source><parameters>[{"name": "output_type", "val": " = None"}, {"name": "config_class", "val": " = None"}]</parameters></docstring>


</div>

## Other Utilities[[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/vr_33892/src/transformers/utils/import_utils.py#L1781</source><parameters>[{"name": "name", "val": ": str"}, {"name": "module_file", "val": ": str"}, {"name": "import_structure", "val": ": dict"}, {"name": "module_spec", "val": ": _frozen_importlib.ModuleSpec | None = None"}, {"name": "extra_objects", "val": ": dict[str, object] | None = None"}, {"name": "explicit_import_shortcut", "val": ": dict[str, list[str]] | None = 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/en/internal/file_utils.md" />