model.rst 872 Bytes
Newer Older
thomwolf's avatar
thomwolf committed
1
2
3
Models
----------------------------------------------------

4
5
6
The base class :class:`~transformers.PreTrainedModel` implements the common methods for loading/saving a model either
from a local file or directory, or from a pretrained model configuration provided by the library (downloaded from
HuggingFace's AWS S3 repository).
7

8
:class:`~transformers.PreTrainedModel` also implements a few methods which are common among all the models to:
9
10
11
12

- resize the input token embeddings when new tokens are added to the vocabulary
- prune the attention heads of the model.

thomwolf's avatar
thomwolf committed
13
14
15
``PreTrainedModel``
~~~~~~~~~~~~~~~~~~~~~

16
.. autoclass:: transformers.PreTrainedModel
thomwolf's avatar
thomwolf committed
17
    :members:
LysandreJik's avatar
LysandreJik committed
18

Patrick von Platen's avatar
Patrick von Platen committed
19
20
21
22
23
``Helper Functions``
~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: transformers.apply_chunking_to_forward

LysandreJik's avatar
LysandreJik committed
24
25
26
``TFPreTrainedModel``
~~~~~~~~~~~~~~~~~~~~~

27
.. autoclass:: transformers.TFPreTrainedModel
LysandreJik's avatar
LysandreJik committed
28
    :members: