file_utils.md 1.41 KB
Newer Older
Sylvain Gugger's avatar
Sylvain Gugger committed
1
2
3
4
5
6
7
8
9
10
<!--Copyright 2021 The HuggingFace Team. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.
11
12
13
14

鈿狅笍 Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
rendered properly in your Markdown viewer.

Sylvain Gugger's avatar
Sylvain Gugger committed
15
16
17
18
-->

# General Utilities

19
This page lists all of Transformers general utility functions that are found in the file `utils.py`.
Sylvain Gugger's avatar
Sylvain Gugger committed
20
21
22
23
24
25

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


## Enums and namedtuples

26
[[autodoc]] utils.ExplicitEnum
Sylvain Gugger's avatar
Sylvain Gugger committed
27

28
[[autodoc]] utils.PaddingStrategy
Sylvain Gugger's avatar
Sylvain Gugger committed
29

30
[[autodoc]] utils.TensorType
Sylvain Gugger's avatar
Sylvain Gugger committed
31
32
33

## Special Decorators

34
[[autodoc]] utils.add_start_docstrings
Sylvain Gugger's avatar
Sylvain Gugger committed
35

36
[[autodoc]] utils.add_start_docstrings_to_model_forward
Sylvain Gugger's avatar
Sylvain Gugger committed
37

38
[[autodoc]] utils.add_end_docstrings
Sylvain Gugger's avatar
Sylvain Gugger committed
39

40
[[autodoc]] utils.add_code_sample_docstrings
Sylvain Gugger's avatar
Sylvain Gugger committed
41

42
[[autodoc]] utils.replace_return_docstrings
Sylvain Gugger's avatar
Sylvain Gugger committed
43
44
45

## Special Properties

46
[[autodoc]] utils.cached_property
Sylvain Gugger's avatar
Sylvain Gugger committed
47
48
49

## Other Utilities

50
[[autodoc]] utils._LazyModule