auto.rst 881 Bytes
Newer Older
thomwolf's avatar
thomwolf committed
1
2
AutoModels
-----------
thomwolf's avatar
thomwolf committed
3

thomwolf's avatar
thomwolf committed
4
5
In many cases, the architecture you want to use can be guessed from the name or the path of the pretrained model you are supplying to the ``from_pretrained`` method.

thomwolf's avatar
thomwolf committed
6
AutoClasses are here to do this job for you so that you automatically retreive the relevant model given the name/path to the pretrained weights/config/vocabulary:
thomwolf's avatar
thomwolf committed
7

thomwolf's avatar
thomwolf committed
8
Instantiating one of ``AutoModel``, ``AutoConfig`` and ``AutoTokenizer`` will directly create a class of the relevant architecture (ex: ``model = AutoModel.from_pretrained('bert-base-cased')`` will create a instance of ``BertModel``).
thomwolf's avatar
thomwolf committed
9
10
11
12
13


``AutoConfig``
~~~~~~~~~~~~~~~~~~~~~

14
.. autoclass:: transformers.AutoConfig
thomwolf's avatar
thomwolf committed
15
16
17
18
19
20
    :members:


``AutoModel``
~~~~~~~~~~~~~~~~~~~~~

21
.. autoclass:: transformers.AutoModel
thomwolf's avatar
thomwolf committed
22
23
24
25
26
27
    :members:


``AutoTokenizer``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

28
.. autoclass:: transformers.AutoTokenizer
thomwolf's avatar
thomwolf committed
29
    :members: