big doc update [WIP]

This commit is contained in:
thomwolf
2019-08-04 12:14:57 +02:00
parent bfbe52ec39
commit 009273dbdd
19 changed files with 189 additions and 60 deletions

View File

@@ -0,0 +1,10 @@
Configuration
----------------------------------------------------
We provide a base class, ``PretrainedConfig``, which can load a pretrained instance either from a local file or directory or from a pretrained model configuration provided by the library (downloaded from HuggingFace AWS S3 repository).
``PretrainedConfig``
~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: pytorch_transformers.PretrainedConfig
:members:

View File

@@ -0,0 +1,8 @@
Models
----------------------------------------------------
``PreTrainedModel``
~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: pytorch_transformers.PreTrainedModel
:members:

View File

@@ -0,0 +1,26 @@
Optimizer
----------------------------------------------------
``AdamW``
~~~~~~~~~~~~~~~~
.. autoclass:: pytorch_transformers.AdamW
:members:
Schedules
----------------------------------------------------
.. autoclass:: pytorch_transformers.ConstantLRSchedule
:members:
.. autoclass:: pytorch_transformers.WarmupConstantSchedule
:members:
.. autoclass:: pytorch_transformers.WarmupCosineSchedule
:members:
.. autoclass:: pytorch_transformers.WarmupCosineWithHardRestartsSchedule
:members:
.. autoclass:: pytorch_transformers.WarmupLinearSchedule
:members:

View File

@@ -0,0 +1,8 @@
Tokenizer
----------------------------------------------------
``PreTrainedTokenizer``
~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: pytorch_transformers.PreTrainedTokenizer
:members: