model.rst 2.82 KB
Newer Older
Sylvain Gugger's avatar
Sylvain Gugger committed
1
2
3
4
5
6
7
8
9
10
11
12
.. 
    Copyright 2020 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.

thomwolf's avatar
thomwolf committed
13
Models
Sylvain Gugger's avatar
Sylvain Gugger committed
14
-----------------------------------------------------------------------------------------------------------------------
thomwolf's avatar
thomwolf committed
15

Sylvain Gugger's avatar
Sylvain Gugger committed
16
17
18
The base classes :class:`~transformers.PreTrainedModel` and :class:`~transformers.TFPreTrainedModel` implement 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).
19

Sylvain Gugger's avatar
Sylvain Gugger committed
20
21
:class:`~transformers.PreTrainedModel` and :class:`~transformers.TFPreTrainedModel` also implement a few methods which
are common among all the models to:
22
23
24
25

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

Sylvain Gugger's avatar
Sylvain Gugger committed
26
The other methods that are common to each model are defined in :class:`~transformers.modeling_utils.ModuleUtilsMixin`
Sylvain Gugger's avatar
Sylvain Gugger committed
27
28
29
(for the PyTorch models) and :class:`~transformers.modeling_tf_utils.TFModuleUtilsMixin` (for the TensorFlow models) or
for text generation, :class:`~transformers.generation_utils.GenerationMixin` (for the PyTorch models) and
:class:`~transformers.generation_tf_utils.TFGenerationMixin` (for the TensorFlow models)
Sylvain Gugger's avatar
Sylvain Gugger committed
30
31


Sylvain Gugger's avatar
Sylvain Gugger committed
32
33
PreTrainedModel
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
thomwolf's avatar
thomwolf committed
34

35
.. autoclass:: transformers.PreTrainedModel
thomwolf's avatar
thomwolf committed
36
    :members:
LysandreJik's avatar
LysandreJik committed
37

Patrick von Platen's avatar
Patrick von Platen committed
38

Sylvain Gugger's avatar
Sylvain Gugger committed
39
40
ModuleUtilsMixin
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sylvain Gugger's avatar
Sylvain Gugger committed
41
42
43
44

.. autoclass:: transformers.modeling_utils.ModuleUtilsMixin
    :members:

Patrick von Platen's avatar
Patrick von Platen committed
45

Sylvain Gugger's avatar
Sylvain Gugger committed
46
47
TFPreTrainedModel
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
LysandreJik's avatar
LysandreJik committed
48

49
.. autoclass:: transformers.TFPreTrainedModel
LysandreJik's avatar
LysandreJik committed
50
    :members:
Sylvain Gugger's avatar
Sylvain Gugger committed
51
52


Sylvain Gugger's avatar
Sylvain Gugger committed
53
54
TFModelUtilsMixin
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sylvain Gugger's avatar
Sylvain Gugger committed
55
56
57

.. autoclass:: transformers.modeling_tf_utils.TFModelUtilsMixin
    :members:
Sylvain Gugger's avatar
Sylvain Gugger committed
58
59


60
Generation
Sylvain Gugger's avatar
Sylvain Gugger committed
61
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sylvain Gugger's avatar
Sylvain Gugger committed
62

Sylvain Gugger's avatar
Sylvain Gugger committed
63
64
65
66
.. autoclass:: transformers.generation_utils.GenerationMixin
    :members:

.. autoclass:: transformers.generation_tf_utils.TFGenerationMixin
Sylvain Gugger's avatar
Sylvain Gugger committed
67
    :members: