Tokenizers: ability to load from model subfolder (#8586)
* <small>tiny typo</small> * Tokenizers: ability to load from model subfolder * use subfolder for local files as well * Uniformize model shortcut name => model id * from s3 => from huggingface.co Co-authored-by: Quentin Lhoest <lhoest.q@gmail.com>
This commit is contained in:
@@ -3,11 +3,11 @@ Pretrained models
|
|||||||
|
|
||||||
Here is the full list of the currently provided pretrained models together with a short presentation of each model.
|
Here is the full list of the currently provided pretrained models together with a short presentation of each model.
|
||||||
|
|
||||||
For a list that includes community-uploaded models, refer to `https://huggingface.co/models
|
For a list that includes all community-uploaded models, refer to `https://huggingface.co/models
|
||||||
<https://huggingface.co/models>`__.
|
<https://huggingface.co/models>`__.
|
||||||
|
|
||||||
+--------------------+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| Architecture | Shortcut name | Details of the model |
|
| Architecture | Model id | Details of the model |
|
||||||
+====================+============================================================+=======================================================================================================================================+
|
+====================+============================================================+=======================================================================================================================================+
|
||||||
| BERT | ``bert-base-uncased`` | | 12-layer, 768-hidden, 12-heads, 110M parameters. |
|
| BERT | ``bert-base-uncased`` | | 12-layer, 768-hidden, 12-heads, 110M parameters. |
|
||||||
| | | | Trained on lower-cased English text. |
|
| | | | Trained on lower-cased English text. |
|
||||||
|
|||||||
@@ -57,7 +57,8 @@ class ModelArguments:
|
|||||||
default=None, metadata={"help": "Pretrained tokenizer name or path if not the same as model_name"}
|
default=None, metadata={"help": "Pretrained tokenizer name or path if not the same as model_name"}
|
||||||
)
|
)
|
||||||
cache_dir: Optional[str] = field(
|
cache_dir: Optional[str] = field(
|
||||||
default=None, metadata={"help": "Where do you want to store the pretrained models downloaded from s3"}
|
default=None,
|
||||||
|
metadata={"help": "Where do you want to store the pretrained models downloaded from huggingface.co"},
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -476,7 +476,7 @@ def main():
|
|||||||
"--cache_dir",
|
"--cache_dir",
|
||||||
default="",
|
default="",
|
||||||
type=str,
|
type=str,
|
||||||
help="Where do you want to store the pre-trained models downloaded from s3",
|
help="Where do you want to store the pre-trained models downloaded from huggingface.co",
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"--max_seq_length",
|
"--max_seq_length",
|
||||||
|
|||||||
@@ -298,7 +298,7 @@ def main():
|
|||||||
"--cache_dir",
|
"--cache_dir",
|
||||||
default=None,
|
default=None,
|
||||||
type=str,
|
type=str,
|
||||||
help="Where do you want to store the pre-trained models downloaded from s3",
|
help="Where do you want to store the pre-trained models downloaded from huggingface.co",
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"--data_subset", type=int, default=-1, help="If > 0: limit the data to a subset of data_subset instances."
|
"--data_subset", type=int, default=-1, help="If > 0: limit the data to a subset of data_subset instances."
|
||||||
|
|||||||
@@ -81,7 +81,8 @@ class ModelArguments:
|
|||||||
default=None, metadata={"help": "Pretrained tokenizer name or path if not the same as model_name"}
|
default=None, metadata={"help": "Pretrained tokenizer name or path if not the same as model_name"}
|
||||||
)
|
)
|
||||||
cache_dir: Optional[str] = field(
|
cache_dir: Optional[str] = field(
|
||||||
default=None, metadata={"help": "Where do you want to store the pretrained models downloaded from s3"}
|
default=None,
|
||||||
|
metadata={"help": "Where do you want to store the pretrained models downloaded from huggingface.co"},
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -350,7 +350,7 @@ def main():
|
|||||||
"--cache_dir",
|
"--cache_dir",
|
||||||
default=None,
|
default=None,
|
||||||
type=str,
|
type=str,
|
||||||
help="Where do you want to store the pre-trained models downloaded from s3",
|
help="Where do you want to store the pre-trained models downloaded from huggingface.co",
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"--max_seq_length",
|
"--max_seq_length",
|
||||||
|
|||||||
@@ -452,7 +452,7 @@ def main():
|
|||||||
"--cache_dir",
|
"--cache_dir",
|
||||||
default="",
|
default="",
|
||||||
type=str,
|
type=str,
|
||||||
help="Where do you want to store the pre-trained models downloaded from s3",
|
help="Where do you want to store the pre-trained models downloaded from huggingface.co",
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"--max_seq_length",
|
"--max_seq_length",
|
||||||
|
|||||||
@@ -578,7 +578,7 @@ def main():
|
|||||||
"--cache_dir",
|
"--cache_dir",
|
||||||
default="",
|
default="",
|
||||||
type=str,
|
type=str,
|
||||||
help="Where do you want to store the pre-trained models downloaded from s3",
|
help="Where do you want to store the pre-trained models downloaded from huggingface.co",
|
||||||
)
|
)
|
||||||
|
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
|
|||||||
@@ -76,7 +76,8 @@ class ModelArguments:
|
|||||||
default=None, metadata={"help": "Pretrained tokenizer name or path if not the same as model_name"}
|
default=None, metadata={"help": "Pretrained tokenizer name or path if not the same as model_name"}
|
||||||
)
|
)
|
||||||
cache_dir: Optional[str] = field(
|
cache_dir: Optional[str] = field(
|
||||||
default=None, metadata={"help": "Where do you want to store the pretrained models downloaded from s3"}
|
default=None,
|
||||||
|
metadata={"help": "Where do you want to store the pretrained models downloaded from huggingface.co"},
|
||||||
)
|
)
|
||||||
use_fast_tokenizer: bool = field(
|
use_fast_tokenizer: bool = field(
|
||||||
default=True,
|
default=True,
|
||||||
|
|||||||
@@ -74,7 +74,8 @@ class ModelArguments:
|
|||||||
default=None, metadata={"help": "Pretrained tokenizer name or path if not the same as model_name"}
|
default=None, metadata={"help": "Pretrained tokenizer name or path if not the same as model_name"}
|
||||||
)
|
)
|
||||||
cache_dir: Optional[str] = field(
|
cache_dir: Optional[str] = field(
|
||||||
default=None, metadata={"help": "Where do you want to store the pretrained models downloaded from s3"}
|
default=None,
|
||||||
|
metadata={"help": "Where do you want to store the pretrained models downloaded from huggingface.co"},
|
||||||
)
|
)
|
||||||
use_fast_tokenizer: bool = field(
|
use_fast_tokenizer: bool = field(
|
||||||
default=True,
|
default=True,
|
||||||
|
|||||||
@@ -76,7 +76,8 @@ class ModelArguments:
|
|||||||
default=None, metadata={"help": "Pretrained tokenizer name or path if not the same as model_name"}
|
default=None, metadata={"help": "Pretrained tokenizer name or path if not the same as model_name"}
|
||||||
)
|
)
|
||||||
cache_dir: Optional[str] = field(
|
cache_dir: Optional[str] = field(
|
||||||
default=None, metadata={"help": "Where do you want to store the pretrained models downloaded from s3"}
|
default=None,
|
||||||
|
metadata={"help": "Where do you want to store the pretrained models downloaded from huggingface.co"},
|
||||||
)
|
)
|
||||||
use_fast_tokenizer: bool = field(
|
use_fast_tokenizer: bool = field(
|
||||||
default=True,
|
default=True,
|
||||||
|
|||||||
@@ -64,7 +64,8 @@ class ModelArguments:
|
|||||||
default=None, metadata={"help": "Pretrained tokenizer name or path if not the same as model_name"}
|
default=None, metadata={"help": "Pretrained tokenizer name or path if not the same as model_name"}
|
||||||
)
|
)
|
||||||
cache_dir: Optional[str] = field(
|
cache_dir: Optional[str] = field(
|
||||||
default=None, metadata={"help": "Where do you want to store the pretrained models downloaded from s3"}
|
default=None,
|
||||||
|
metadata={"help": "Where do you want to store the pretrained models downloaded from huggingface.co"},
|
||||||
)
|
)
|
||||||
use_fast_tokenizer: bool = field(
|
use_fast_tokenizer: bool = field(
|
||||||
default=True,
|
default=True,
|
||||||
|
|||||||
@@ -236,7 +236,7 @@ class BaseTransformer(pl.LightningModule):
|
|||||||
"--cache_dir",
|
"--cache_dir",
|
||||||
default="",
|
default="",
|
||||||
type=str,
|
type=str,
|
||||||
help="Where do you want to store the pre-trained models downloaded from s3",
|
help="Where do you want to store the pre-trained models downloaded from huggingface.co",
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"--encoder_layerdrop",
|
"--encoder_layerdrop",
|
||||||
|
|||||||
@@ -620,7 +620,7 @@ def main():
|
|||||||
"--cache_dir",
|
"--cache_dir",
|
||||||
default="",
|
default="",
|
||||||
type=str,
|
type=str,
|
||||||
help="Where do you want to store the pre-trained models downloaded from s3",
|
help="Where do you want to store the pre-trained models downloaded from huggingface.co",
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"--max_seq_length",
|
"--max_seq_length",
|
||||||
|
|||||||
@@ -725,7 +725,7 @@ def main():
|
|||||||
"--cache_dir",
|
"--cache_dir",
|
||||||
default="",
|
default="",
|
||||||
type=str,
|
type=str,
|
||||||
help="Where do you want to store the pre-trained models downloaded from s3",
|
help="Where do you want to store the pre-trained models downloaded from huggingface.co",
|
||||||
)
|
)
|
||||||
|
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
|
|||||||
@@ -61,7 +61,8 @@ class ModelArguments:
|
|||||||
default=None, metadata={"help": "Pretrained tokenizer name or path if not the same as model_name"}
|
default=None, metadata={"help": "Pretrained tokenizer name or path if not the same as model_name"}
|
||||||
)
|
)
|
||||||
cache_dir: Optional[str] = field(
|
cache_dir: Optional[str] = field(
|
||||||
default=None, metadata={"help": "Where do you want to store the pretrained models downloaded from s3"}
|
default=None,
|
||||||
|
metadata={"help": "Where do you want to store the pretrained models downloaded from huggingface.co"},
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -65,7 +65,8 @@ class ModelArguments:
|
|||||||
default=None, metadata={"help": "Pretrained tokenizer name or path if not the same as model_name"}
|
default=None, metadata={"help": "Pretrained tokenizer name or path if not the same as model_name"}
|
||||||
)
|
)
|
||||||
cache_dir: Optional[str] = field(
|
cache_dir: Optional[str] = field(
|
||||||
default=None, metadata={"help": "Where do you want to store the pretrained models downloaded from s3"}
|
default=None,
|
||||||
|
metadata={"help": "Where do you want to store the pretrained models downloaded from huggingface.co"},
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -532,7 +532,7 @@ def main():
|
|||||||
"--cache_dir",
|
"--cache_dir",
|
||||||
default="",
|
default="",
|
||||||
type=str,
|
type=str,
|
||||||
help="Where do you want to store the pre-trained models downloaded from s3",
|
help="Where do you want to store the pre-trained models downloaded from huggingface.co",
|
||||||
)
|
)
|
||||||
|
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
|
|||||||
@@ -51,7 +51,8 @@ class ModelArguments:
|
|||||||
# If you want to tweak more attributes on your tokenizer, you should do it in a distinct script,
|
# If you want to tweak more attributes on your tokenizer, you should do it in a distinct script,
|
||||||
# or just modify its tokenizer_config.json.
|
# or just modify its tokenizer_config.json.
|
||||||
cache_dir: Optional[str] = field(
|
cache_dir: Optional[str] = field(
|
||||||
default=None, metadata={"help": "Where do you want to store the pretrained models downloaded from s3"}
|
default=None,
|
||||||
|
metadata={"help": "Where do you want to store the pretrained models downloaded from huggingface.co"},
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -63,7 +63,8 @@ class ModelArguments:
|
|||||||
# If you want to tweak more attributes on your tokenizer, you should do it in a distinct script,
|
# If you want to tweak more attributes on your tokenizer, you should do it in a distinct script,
|
||||||
# or just modify its tokenizer_config.json.
|
# or just modify its tokenizer_config.json.
|
||||||
cache_dir: Optional[str] = field(
|
cache_dir: Optional[str] = field(
|
||||||
default=None, metadata={"help": "Where do you want to store the pretrained models downloaded from s3"}
|
default=None,
|
||||||
|
metadata={"help": "Where do you want to store the pretrained models downloaded from huggingface.co"},
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ export PYTHONPATH="../":"${PYTHONPATH}"
|
|||||||
python examples/rag/finetune.py \
|
python examples/rag/finetune.py \
|
||||||
--data_dir $DATA_DIR \
|
--data_dir $DATA_DIR \
|
||||||
--output_dir $OUTPUT_DIR \
|
--output_dir $OUTPUT_DIR \
|
||||||
--model_name_or_path $MODLE_NAME_OR_PATH \
|
--model_name_or_path $MODEL_NAME_OR_PATH \
|
||||||
--model_type rag_sequence \
|
--model_type rag_sequence \
|
||||||
--fp16 \
|
--fp16 \
|
||||||
--gpus 8 \
|
--gpus 8 \
|
||||||
|
|||||||
@@ -43,7 +43,8 @@ class ModelArguments:
|
|||||||
default=None, metadata={"help": "Pretrained tokenizer name or path if not the same as model_name"}
|
default=None, metadata={"help": "Pretrained tokenizer name or path if not the same as model_name"}
|
||||||
)
|
)
|
||||||
cache_dir: Optional[str] = field(
|
cache_dir: Optional[str] = field(
|
||||||
default=None, metadata={"help": "Where do you want to store the pretrained models downloaded from s3"}
|
default=None,
|
||||||
|
metadata={"help": "Where do you want to store the pretrained models downloaded from huggingface.co"},
|
||||||
)
|
)
|
||||||
freeze_encoder: bool = field(default=False, metadata={"help": "Whether tp freeze the encoder."})
|
freeze_encoder: bool = field(default=False, metadata={"help": "Whether tp freeze the encoder."})
|
||||||
freeze_embeds: bool = field(default=False, metadata={"help": "Whether to freeze the embeddings."})
|
freeze_embeds: bool = field(default=False, metadata={"help": "Whether to freeze the embeddings."})
|
||||||
|
|||||||
@@ -124,7 +124,8 @@ class ModelArguments:
|
|||||||
default=None, metadata={"help": "Pretrained tokenizer name or path if not the same as model_name"}
|
default=None, metadata={"help": "Pretrained tokenizer name or path if not the same as model_name"}
|
||||||
)
|
)
|
||||||
cache_dir: Optional[str] = field(
|
cache_dir: Optional[str] = field(
|
||||||
default=None, metadata={"help": "Where do you want to store the pretrained models downloaded from s3"}
|
default=None,
|
||||||
|
metadata={"help": "Where do you want to store the pretrained models downloaded from huggingface.co"},
|
||||||
)
|
)
|
||||||
use_fast_tokenizer: bool = field(
|
use_fast_tokenizer: bool = field(
|
||||||
default=True,
|
default=True,
|
||||||
|
|||||||
@@ -117,7 +117,8 @@ class ModelArguments:
|
|||||||
# If you want to tweak more attributes on your tokenizer, you should do it in a distinct script,
|
# If you want to tweak more attributes on your tokenizer, you should do it in a distinct script,
|
||||||
# or just modify its tokenizer_config.json.
|
# or just modify its tokenizer_config.json.
|
||||||
cache_dir: Optional[str] = field(
|
cache_dir: Optional[str] = field(
|
||||||
default=None, metadata={"help": "Where do you want to store the pretrained models downloaded from s3"}
|
default=None,
|
||||||
|
metadata={"help": "Where do you want to store the pretrained models downloaded from huggingface.co"},
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -182,7 +182,8 @@ class ModelArguments:
|
|||||||
# If you want to tweak more attributes on your tokenizer, you should do it in a distinct script,
|
# If you want to tweak more attributes on your tokenizer, you should do it in a distinct script,
|
||||||
# or just modify its tokenizer_config.json.
|
# or just modify its tokenizer_config.json.
|
||||||
cache_dir: Optional[str] = field(
|
cache_dir: Optional[str] = field(
|
||||||
default=None, metadata={"help": "Where do you want to store the pretrained models downloaded from s3"}
|
default=None,
|
||||||
|
metadata={"help": "Where do you want to store the pretrained models downloaded from huggingface.co"},
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -406,7 +406,7 @@ def main():
|
|||||||
"--cache_dir",
|
"--cache_dir",
|
||||||
default=None,
|
default=None,
|
||||||
type=str,
|
type=str,
|
||||||
help="Where do you want to store the pre-trained models downloaded from s3",
|
help="Where do you want to store the pre-trained models downloaded from huggingface.co",
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"--max_seq_length",
|
"--max_seq_length",
|
||||||
|
|||||||
@@ -60,7 +60,8 @@ class ModelArguments:
|
|||||||
default=None, metadata={"help": "Pretrained tokenizer name or path if not the same as model_name"}
|
default=None, metadata={"help": "Pretrained tokenizer name or path if not the same as model_name"}
|
||||||
)
|
)
|
||||||
cache_dir: Optional[str] = field(
|
cache_dir: Optional[str] = field(
|
||||||
default=None, metadata={"help": "Where do you want to store the pretrained models downloaded from s3"}
|
default=None,
|
||||||
|
metadata={"help": "Where do you want to store the pretrained models downloaded from huggingface.co"},
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -65,7 +65,8 @@ class ModelArguments:
|
|||||||
# If you want to tweak more attributes on your tokenizer, you should do it in a distinct script,
|
# If you want to tweak more attributes on your tokenizer, you should do it in a distinct script,
|
||||||
# or just modify its tokenizer_config.json.
|
# or just modify its tokenizer_config.json.
|
||||||
cache_dir: Optional[str] = field(
|
cache_dir: Optional[str] = field(
|
||||||
default=None, metadata={"help": "Where do you want to store the pretrained models downloaded from s3"}
|
default=None,
|
||||||
|
metadata={"help": "Where do you want to store the pretrained models downloaded from huggingface.co"},
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -67,7 +67,8 @@ class ModelArguments:
|
|||||||
# If you want to tweak more attributes on your tokenizer, you should do it in a distinct script,
|
# If you want to tweak more attributes on your tokenizer, you should do it in a distinct script,
|
||||||
# or just modify its tokenizer_config.json.
|
# or just modify its tokenizer_config.json.
|
||||||
cache_dir: Optional[str] = field(
|
cache_dir: Optional[str] = field(
|
||||||
default=None, metadata={"help": "Where do you want to store the pretrained models downloaded from s3"}
|
default=None,
|
||||||
|
metadata={"help": "Where do you want to store the pretrained models downloaded from huggingface.co"},
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
12
hubconf.py
12
hubconf.py
@@ -25,7 +25,7 @@ def config(*args, **kwargs):
|
|||||||
# Using torch.hub !
|
# Using torch.hub !
|
||||||
import torch
|
import torch
|
||||||
|
|
||||||
config = torch.hub.load('huggingface/transformers', 'config', 'bert-base-uncased') # Download configuration from S3 and cache.
|
config = torch.hub.load('huggingface/transformers', 'config', 'bert-base-uncased') # Download configuration from huggingface.co and cache.
|
||||||
config = torch.hub.load('huggingface/transformers', 'config', './test/bert_saved_model/') # E.g. config (or model) was saved using `save_pretrained('./test/saved_model/')`
|
config = torch.hub.load('huggingface/transformers', 'config', './test/bert_saved_model/') # E.g. config (or model) was saved using `save_pretrained('./test/saved_model/')`
|
||||||
config = torch.hub.load('huggingface/transformers', 'config', './test/bert_saved_model/my_configuration.json')
|
config = torch.hub.load('huggingface/transformers', 'config', './test/bert_saved_model/my_configuration.json')
|
||||||
config = torch.hub.load('huggingface/transformers', 'config', 'bert-base-uncased', output_attentions=True, foo=False)
|
config = torch.hub.load('huggingface/transformers', 'config', 'bert-base-uncased', output_attentions=True, foo=False)
|
||||||
@@ -45,7 +45,7 @@ def tokenizer(*args, **kwargs):
|
|||||||
# Using torch.hub !
|
# Using torch.hub !
|
||||||
import torch
|
import torch
|
||||||
|
|
||||||
tokenizer = torch.hub.load('huggingface/transformers', 'tokenizer', 'bert-base-uncased') # Download vocabulary from S3 and cache.
|
tokenizer = torch.hub.load('huggingface/transformers', 'tokenizer', 'bert-base-uncased') # Download vocabulary from huggingface.co and cache.
|
||||||
tokenizer = torch.hub.load('huggingface/transformers', 'tokenizer', './test/bert_saved_model/') # E.g. tokenizer was saved using `save_pretrained('./test/saved_model/')`
|
tokenizer = torch.hub.load('huggingface/transformers', 'tokenizer', './test/bert_saved_model/') # E.g. tokenizer was saved using `save_pretrained('./test/saved_model/')`
|
||||||
|
|
||||||
"""
|
"""
|
||||||
@@ -59,7 +59,7 @@ def model(*args, **kwargs):
|
|||||||
# Using torch.hub !
|
# Using torch.hub !
|
||||||
import torch
|
import torch
|
||||||
|
|
||||||
model = torch.hub.load('huggingface/transformers', 'model', 'bert-base-uncased') # Download model and configuration from S3 and cache.
|
model = torch.hub.load('huggingface/transformers', 'model', 'bert-base-uncased') # Download model and configuration from huggingface.co and cache.
|
||||||
model = torch.hub.load('huggingface/transformers', 'model', './test/bert_model/') # E.g. model was saved using `save_pretrained('./test/saved_model/')`
|
model = torch.hub.load('huggingface/transformers', 'model', './test/bert_model/') # E.g. model was saved using `save_pretrained('./test/saved_model/')`
|
||||||
model = torch.hub.load('huggingface/transformers', 'model', 'bert-base-uncased', output_attentions=True) # Update configuration during loading
|
model = torch.hub.load('huggingface/transformers', 'model', 'bert-base-uncased', output_attentions=True) # Update configuration during loading
|
||||||
assert model.config.output_attentions == True
|
assert model.config.output_attentions == True
|
||||||
@@ -78,7 +78,7 @@ def modelWithLMHead(*args, **kwargs):
|
|||||||
# Using torch.hub !
|
# Using torch.hub !
|
||||||
import torch
|
import torch
|
||||||
|
|
||||||
model = torch.hub.load('huggingface/transformers', 'modelWithLMHead', 'bert-base-uncased') # Download model and configuration from S3 and cache.
|
model = torch.hub.load('huggingface/transformers', 'modelWithLMHead', 'bert-base-uncased') # Download model and configuration from huggingface.co and cache.
|
||||||
model = torch.hub.load('huggingface/transformers', 'modelWithLMHead', './test/bert_model/') # E.g. model was saved using `save_pretrained('./test/saved_model/')`
|
model = torch.hub.load('huggingface/transformers', 'modelWithLMHead', './test/bert_model/') # E.g. model was saved using `save_pretrained('./test/saved_model/')`
|
||||||
model = torch.hub.load('huggingface/transformers', 'modelWithLMHead', 'bert-base-uncased', output_attentions=True) # Update configuration during loading
|
model = torch.hub.load('huggingface/transformers', 'modelWithLMHead', 'bert-base-uncased', output_attentions=True) # Update configuration during loading
|
||||||
assert model.config.output_attentions == True
|
assert model.config.output_attentions == True
|
||||||
@@ -96,7 +96,7 @@ def modelForSequenceClassification(*args, **kwargs):
|
|||||||
# Using torch.hub !
|
# Using torch.hub !
|
||||||
import torch
|
import torch
|
||||||
|
|
||||||
model = torch.hub.load('huggingface/transformers', 'modelForSequenceClassification', 'bert-base-uncased') # Download model and configuration from S3 and cache.
|
model = torch.hub.load('huggingface/transformers', 'modelForSequenceClassification', 'bert-base-uncased') # Download model and configuration from huggingface.co and cache.
|
||||||
model = torch.hub.load('huggingface/transformers', 'modelForSequenceClassification', './test/bert_model/') # E.g. model was saved using `save_pretrained('./test/saved_model/')`
|
model = torch.hub.load('huggingface/transformers', 'modelForSequenceClassification', './test/bert_model/') # E.g. model was saved using `save_pretrained('./test/saved_model/')`
|
||||||
model = torch.hub.load('huggingface/transformers', 'modelForSequenceClassification', 'bert-base-uncased', output_attentions=True) # Update configuration during loading
|
model = torch.hub.load('huggingface/transformers', 'modelForSequenceClassification', 'bert-base-uncased', output_attentions=True) # Update configuration during loading
|
||||||
assert model.config.output_attentions == True
|
assert model.config.output_attentions == True
|
||||||
@@ -115,7 +115,7 @@ def modelForQuestionAnswering(*args, **kwargs):
|
|||||||
# Using torch.hub !
|
# Using torch.hub !
|
||||||
import torch
|
import torch
|
||||||
|
|
||||||
model = torch.hub.load('huggingface/transformers', 'modelForQuestionAnswering', 'bert-base-uncased') # Download model and configuration from S3 and cache.
|
model = torch.hub.load('huggingface/transformers', 'modelForQuestionAnswering', 'bert-base-uncased') # Download model and configuration from huggingface.co and cache.
|
||||||
model = torch.hub.load('huggingface/transformers', 'modelForQuestionAnswering', './test/bert_model/') # E.g. model was saved using `save_pretrained('./test/saved_model/')`
|
model = torch.hub.load('huggingface/transformers', 'modelForQuestionAnswering', './test/bert_model/') # E.g. model was saved using `save_pretrained('./test/saved_model/')`
|
||||||
model = torch.hub.load('huggingface/transformers', 'modelForQuestionAnswering', 'bert-base-uncased', output_attentions=True) # Update configuration during loading
|
model = torch.hub.load('huggingface/transformers', 'modelForQuestionAnswering', 'bert-base-uncased', output_attentions=True) # Update configuration during loading
|
||||||
assert model.config.output_attentions == True
|
assert model.config.output_attentions == True
|
||||||
|
|||||||
@@ -31,7 +31,7 @@ class UserCommands(BaseTransformersCLICommand):
|
|||||||
ls_parser.add_argument("--organization", type=str, help="Optional: organization namespace.")
|
ls_parser.add_argument("--organization", type=str, help="Optional: organization namespace.")
|
||||||
ls_parser.set_defaults(func=lambda args: ListObjsCommand(args))
|
ls_parser.set_defaults(func=lambda args: ListObjsCommand(args))
|
||||||
rm_parser = s3_subparsers.add_parser("rm")
|
rm_parser = s3_subparsers.add_parser("rm")
|
||||||
rm_parser.add_argument("filename", type=str, help="individual object filename to delete from S3.")
|
rm_parser.add_argument("filename", type=str, help="individual object filename to delete from huggingface.co.")
|
||||||
rm_parser.add_argument("--organization", type=str, help="Optional: organization namespace.")
|
rm_parser.add_argument("--organization", type=str, help="Optional: organization namespace.")
|
||||||
rm_parser.set_defaults(func=lambda args: DeleteObjCommand(args))
|
rm_parser.set_defaults(func=lambda args: DeleteObjCommand(args))
|
||||||
upload_parser = s3_subparsers.add_parser("upload", help="Upload a file to S3.")
|
upload_parser = s3_subparsers.add_parser("upload", help="Upload a file to S3.")
|
||||||
|
|||||||
@@ -291,10 +291,9 @@ class PretrainedConfig(object):
|
|||||||
pretrained_model_name_or_path (:obj:`str`):
|
pretrained_model_name_or_path (:obj:`str`):
|
||||||
This can be either:
|
This can be either:
|
||||||
|
|
||||||
- the `shortcut name` of a pretrained model configuration to load from cache or download, e.g.,
|
- a string, the `model id` of a pretrained model configuration hosted inside a model repo on
|
||||||
``bert-base-uncased``.
|
huggingface.co. Valid model ids can be located at the root-level, like ``bert-base-uncased``, or
|
||||||
- the `identifier name` of a pretrained model configuration that was uploaded to our S3 by any user,
|
namespaced under a user or organization name, like ``dbmdz/bert-base-german-cased``.
|
||||||
e.g., ``dbmdz/bert-base-german-cased``.
|
|
||||||
- a path to a `directory` containing a configuration file saved using the
|
- a path to a `directory` containing a configuration file saved using the
|
||||||
:func:`~transformers.PretrainedConfig.save_pretrained` method, e.g., ``./my_model_directory/``.
|
:func:`~transformers.PretrainedConfig.save_pretrained` method, e.g., ``./my_model_directory/``.
|
||||||
- a path or url to a saved configuration JSON `file`, e.g.,
|
- a path or url to a saved configuration JSON `file`, e.g.,
|
||||||
@@ -333,7 +332,7 @@ class PretrainedConfig(object):
|
|||||||
|
|
||||||
# We can't instantiate directly the base class `PretrainedConfig` so let's show the examples on a
|
# We can't instantiate directly the base class `PretrainedConfig` so let's show the examples on a
|
||||||
# derived class: BertConfig
|
# derived class: BertConfig
|
||||||
config = BertConfig.from_pretrained('bert-base-uncased') # Download configuration from S3 and cache.
|
config = BertConfig.from_pretrained('bert-base-uncased') # Download configuration from huggingface.co and cache.
|
||||||
config = BertConfig.from_pretrained('./test/saved_model/') # E.g. config (or model) was saved using `save_pretrained('./test/saved_model/')`
|
config = BertConfig.from_pretrained('./test/saved_model/') # E.g. config (or model) was saved using `save_pretrained('./test/saved_model/')`
|
||||||
config = BertConfig.from_pretrained('./test/saved_model/my_configuration.json')
|
config = BertConfig.from_pretrained('./test/saved_model/my_configuration.json')
|
||||||
config = BertConfig.from_pretrained('bert-base-uncased', output_attentions=True, foo=False)
|
config = BertConfig.from_pretrained('bert-base-uncased', output_attentions=True, foo=False)
|
||||||
|
|||||||
@@ -855,7 +855,9 @@ def is_remote_url(url_or_filename):
|
|||||||
return parsed.scheme in ("http", "https")
|
return parsed.scheme in ("http", "https")
|
||||||
|
|
||||||
|
|
||||||
def hf_bucket_url(model_id: str, filename: str, revision: Optional[str] = None, mirror=None) -> str:
|
def hf_bucket_url(
|
||||||
|
model_id: str, filename: str, subfolder: Optional[str] = None, revision: Optional[str] = None, mirror=None
|
||||||
|
) -> str:
|
||||||
"""
|
"""
|
||||||
Resolve a model identifier, a file name, and an optional revision id, to a huggingface.co-hosted url, redirecting
|
Resolve a model identifier, a file name, and an optional revision id, to a huggingface.co-hosted url, redirecting
|
||||||
to Cloudfront (a Content Delivery Network, or CDN) for large files.
|
to Cloudfront (a Content Delivery Network, or CDN) for large files.
|
||||||
@@ -872,6 +874,9 @@ def hf_bucket_url(model_id: str, filename: str, revision: Optional[str] = None,
|
|||||||
its sha1 if stored in git, or its sha256 if stored in git-lfs. Files cached locally from transformers before v3.5.0
|
its sha1 if stored in git, or its sha256 if stored in git-lfs. Files cached locally from transformers before v3.5.0
|
||||||
are not shared with those new files, because the cached file's name contains a hash of the url (which changed).
|
are not shared with those new files, because the cached file's name contains a hash of the url (which changed).
|
||||||
"""
|
"""
|
||||||
|
if subfolder is not None:
|
||||||
|
filename = f"{subfolder}/{filename}"
|
||||||
|
|
||||||
if mirror:
|
if mirror:
|
||||||
endpoint = PRESET_MIRROR_DICT.get(mirror, mirror)
|
endpoint = PRESET_MIRROR_DICT.get(mirror, mirror)
|
||||||
legacy_format = "/" not in model_id
|
legacy_format = "/" not in model_id
|
||||||
|
|||||||
@@ -148,12 +148,12 @@ class TFGenerationMixin:
|
|||||||
Examples::
|
Examples::
|
||||||
|
|
||||||
tokenizer = AutoTokenizer.from_pretrained('distilgpt2') # Initialize tokenizer
|
tokenizer = AutoTokenizer.from_pretrained('distilgpt2') # Initialize tokenizer
|
||||||
model = TFAutoModelWithLMHead.from_pretrained('distilgpt2') # Download model and configuration from S3 and cache.
|
model = TFAutoModelWithLMHead.from_pretrained('distilgpt2') # Download model and configuration from huggingface.co and cache.
|
||||||
outputs = model.generate(max_length=40) # do greedy decoding
|
outputs = model.generate(max_length=40) # do greedy decoding
|
||||||
print('Generated: {}'.format(tokenizer.decode(outputs[0], skip_special_tokens=True)))
|
print('Generated: {}'.format(tokenizer.decode(outputs[0], skip_special_tokens=True)))
|
||||||
|
|
||||||
tokenizer = AutoTokenizer.from_pretrained('openai-gpt') # Initialize tokenizer
|
tokenizer = AutoTokenizer.from_pretrained('openai-gpt') # Initialize tokenizer
|
||||||
model = TFAutoModelWithLMHead.from_pretrained('openai-gpt') # Download model and configuration from S3 and cache.
|
model = TFAutoModelWithLMHead.from_pretrained('openai-gpt') # Download model and configuration from huggingface.co and cache.
|
||||||
input_context = 'The dog'
|
input_context = 'The dog'
|
||||||
input_ids = tokenizer.encode(input_context, return_tensors='tf') # encode input context
|
input_ids = tokenizer.encode(input_context, return_tensors='tf') # encode input context
|
||||||
outputs = model.generate(input_ids=input_ids, num_beams=5, num_return_sequences=3, temperature=1.5) # generate 3 independent sequences using beam search decoding (5 beams) with sampling from initial context 'The dog'
|
outputs = model.generate(input_ids=input_ids, num_beams=5, num_return_sequences=3, temperature=1.5) # generate 3 independent sequences using beam search decoding (5 beams) with sampling from initial context 'The dog'
|
||||||
@@ -161,7 +161,7 @@ class TFGenerationMixin:
|
|||||||
print('Generated {}: {}'.format(i, tokenizer.decode(outputs[i], skip_special_tokens=True)))
|
print('Generated {}: {}'.format(i, tokenizer.decode(outputs[i], skip_special_tokens=True)))
|
||||||
|
|
||||||
tokenizer = AutoTokenizer.from_pretrained('distilgpt2') # Initialize tokenizer
|
tokenizer = AutoTokenizer.from_pretrained('distilgpt2') # Initialize tokenizer
|
||||||
model = TFAutoModelWithLMHead.from_pretrained('distilgpt2') # Download model and configuration from S3 and cache.
|
model = TFAutoModelWithLMHead.from_pretrained('distilgpt2') # Download model and configuration from huggingface.co and cache.
|
||||||
input_context = 'The dog'
|
input_context = 'The dog'
|
||||||
input_ids = tokenizer.encode(input_context, return_tensors='tf') # encode input context
|
input_ids = tokenizer.encode(input_context, return_tensors='tf') # encode input context
|
||||||
outputs = model.generate(input_ids=input_ids, max_length=40, temperature=0.7, num_return_sequences=3, do_sample=True) # generate 3 candidates using sampling
|
outputs = model.generate(input_ids=input_ids, max_length=40, temperature=0.7, num_return_sequences=3, do_sample=True) # generate 3 candidates using sampling
|
||||||
@@ -169,14 +169,14 @@ class TFGenerationMixin:
|
|||||||
print('Generated {}: {}'.format(i, tokenizer.decode(outputs[i], skip_special_tokens=True)))
|
print('Generated {}: {}'.format(i, tokenizer.decode(outputs[i], skip_special_tokens=True)))
|
||||||
|
|
||||||
tokenizer = AutoTokenizer.from_pretrained('ctrl') # Initialize tokenizer
|
tokenizer = AutoTokenizer.from_pretrained('ctrl') # Initialize tokenizer
|
||||||
model = TFAutoModelWithLMHead.from_pretrained('ctrl') # Download model and configuration from S3 and cache.
|
model = TFAutoModelWithLMHead.from_pretrained('ctrl') # Download model and configuration from huggingface.co and cache.
|
||||||
input_context = 'Legal My neighbor is' # "Legal" is one of the control codes for ctrl
|
input_context = 'Legal My neighbor is' # "Legal" is one of the control codes for ctrl
|
||||||
input_ids = tokenizer.encode(input_context, return_tensors='tf') # encode input context
|
input_ids = tokenizer.encode(input_context, return_tensors='tf') # encode input context
|
||||||
outputs = model.generate(input_ids=input_ids, max_length=50, temperature=0.7, repetition_penalty=1.2) # generate sequences
|
outputs = model.generate(input_ids=input_ids, max_length=50, temperature=0.7, repetition_penalty=1.2) # generate sequences
|
||||||
print('Generated: {}'.format(tokenizer.decode(outputs[0], skip_special_tokens=True)))
|
print('Generated: {}'.format(tokenizer.decode(outputs[0], skip_special_tokens=True)))
|
||||||
|
|
||||||
tokenizer = AutoTokenizer.from_pretrained('gpt2') # Initialize tokenizer
|
tokenizer = AutoTokenizer.from_pretrained('gpt2') # Initialize tokenizer
|
||||||
model = TFAutoModelWithLMHead.from_pretrained('gpt2') # Download model and configuration from S3 and cache.
|
model = TFAutoModelWithLMHead.from_pretrained('gpt2') # Download model and configuration from huggingface.co and cache.
|
||||||
input_context = 'My cute dog'
|
input_context = 'My cute dog'
|
||||||
bad_words_ids = [tokenizer.encode(bad_word, add_prefix_space=True) for bad_word in ['idiot', 'stupid', 'shut up']]
|
bad_words_ids = [tokenizer.encode(bad_word, add_prefix_space=True) for bad_word in ['idiot', 'stupid', 'shut up']]
|
||||||
input_ids = tokenizer.encode(input_context, return_tensors='tf') # encode input context
|
input_ids = tokenizer.encode(input_context, return_tensors='tf') # encode input context
|
||||||
|
|||||||
@@ -87,10 +87,9 @@ class ModelCard:
|
|||||||
Parameters:
|
Parameters:
|
||||||
pretrained_model_name_or_path: either:
|
pretrained_model_name_or_path: either:
|
||||||
|
|
||||||
- a string with the `shortcut name` of a pre-trained model card to load from cache or download, e.g.:
|
- a string, the `model id` of a pretrained model card hosted inside a model repo on huggingface.co.
|
||||||
``bert-base-uncased``.
|
Valid model ids can be located at the root-level, like ``bert-base-uncased``, or namespaced under a
|
||||||
- a string with the `identifier name` of a pre-trained model card that was user-uploaded to our S3,
|
user or organization name, like ``dbmdz/bert-base-german-cased``.
|
||||||
e.g.: ``dbmdz/bert-base-german-cased``.
|
|
||||||
- a path to a `directory` containing a model card file saved using the
|
- a path to a `directory` containing a model card file saved using the
|
||||||
:func:`~transformers.ModelCard.save_pretrained` method, e.g.: ``./my_model_directory/``.
|
:func:`~transformers.ModelCard.save_pretrained` method, e.g.: ``./my_model_directory/``.
|
||||||
- a path or url to a saved model card JSON `file`, e.g.: ``./my_model_directory/modelcard.json``.
|
- a path or url to a saved model card JSON `file`, e.g.: ``./my_model_directory/modelcard.json``.
|
||||||
@@ -124,7 +123,7 @@ class ModelCard:
|
|||||||
|
|
||||||
Examples::
|
Examples::
|
||||||
|
|
||||||
modelcard = ModelCard.from_pretrained('bert-base-uncased') # Download model card from S3 and cache.
|
modelcard = ModelCard.from_pretrained('bert-base-uncased') # Download model card from huggingface.co and cache.
|
||||||
modelcard = ModelCard.from_pretrained('./test/saved_model/') # E.g. model card was saved using `save_pretrained('./test/saved_model/')`
|
modelcard = ModelCard.from_pretrained('./test/saved_model/') # E.g. model card was saved using `save_pretrained('./test/saved_model/')`
|
||||||
modelcard = ModelCard.from_pretrained('./test/saved_model/modelcard.json')
|
modelcard = ModelCard.from_pretrained('./test/saved_model/modelcard.json')
|
||||||
modelcard = ModelCard.from_pretrained('bert-base-uncased', output_attentions=True, foo=False)
|
modelcard = ModelCard.from_pretrained('bert-base-uncased', output_attentions=True, foo=False)
|
||||||
|
|||||||
@@ -544,10 +544,9 @@ class TFPreTrainedModel(tf.keras.Model, TFModelUtilsMixin, TFGenerationMixin):
|
|||||||
pretrained_model_name_or_path (:obj:`str`, `optional`):
|
pretrained_model_name_or_path (:obj:`str`, `optional`):
|
||||||
Can be either:
|
Can be either:
|
||||||
|
|
||||||
- A string with the `shortcut name` of a pretrained model to load from cache or download, e.g.,
|
- A string, the `model id` of a pretrained model hosted inside a model repo on huggingface.co.
|
||||||
``bert-base-uncased``.
|
Valid model ids can be located at the root-level, like ``bert-base-uncased``, or namespaced under
|
||||||
- A string with the `identifier name` of a pretrained model that was user-uploaded to our S3, e.g.,
|
a user or organization name, like ``dbmdz/bert-base-german-cased``.
|
||||||
``dbmdz/bert-base-german-cased``.
|
|
||||||
- A path to a `directory` containing model weights saved using
|
- A path to a `directory` containing model weights saved using
|
||||||
:func:`~transformersTF.PreTrainedModel.save_pretrained`, e.g., ``./my_model_directory/``.
|
:func:`~transformersTF.PreTrainedModel.save_pretrained`, e.g., ``./my_model_directory/``.
|
||||||
- A path or url to a `PyTorch state_dict save file` (e.g, ``./pt_model/pytorch_model.bin``). In
|
- A path or url to a `PyTorch state_dict save file` (e.g, ``./pt_model/pytorch_model.bin``). In
|
||||||
@@ -568,8 +567,8 @@ class TFPreTrainedModel(tf.keras.Model, TFModelUtilsMixin, TFGenerationMixin):
|
|||||||
Configuration for the model to use instead of an automatically loaded configuation. Configuration can
|
Configuration for the model to use instead of an automatically loaded configuation. Configuration can
|
||||||
be automatically loaded when:
|
be automatically loaded when:
|
||||||
|
|
||||||
- The model is a model provided by the library (loaded with the `shortcut name` string of a
|
- The model is a model provided by the library (loaded with the `model id` string of a pretrained
|
||||||
pretrained model).
|
model).
|
||||||
- The model was saved using :func:`~transformers.TFPreTrainedModel.save_pretrained` and is reloaded
|
- The model was saved using :func:`~transformers.TFPreTrainedModel.save_pretrained` and is reloaded
|
||||||
by supplying the save directory.
|
by supplying the save directory.
|
||||||
- The model is loaded by supplying a local directory as ``pretrained_model_name_or_path`` and a
|
- The model is loaded by supplying a local directory as ``pretrained_model_name_or_path`` and a
|
||||||
@@ -618,7 +617,7 @@ class TFPreTrainedModel(tf.keras.Model, TFModelUtilsMixin, TFGenerationMixin):
|
|||||||
Examples::
|
Examples::
|
||||||
|
|
||||||
>>> from transformers import BertConfig, TFBertModel
|
>>> from transformers import BertConfig, TFBertModel
|
||||||
>>> # Download model and configuration from S3 and cache.
|
>>> # Download model and configuration from huggingface.co and cache.
|
||||||
>>> model = TFBertModel.from_pretrained('bert-base-uncased')
|
>>> model = TFBertModel.from_pretrained('bert-base-uncased')
|
||||||
>>> # Model was saved using `save_pretrained('./test/saved_model/')` (for example purposes, not runnable).
|
>>> # Model was saved using `save_pretrained('./test/saved_model/')` (for example purposes, not runnable).
|
||||||
>>> model = TFBertModel.from_pretrained('./test/saved_model/')
|
>>> model = TFBertModel.from_pretrained('./test/saved_model/')
|
||||||
|
|||||||
@@ -758,10 +758,9 @@ class PreTrainedModel(nn.Module, ModuleUtilsMixin, GenerationMixin):
|
|||||||
pretrained_model_name_or_path (:obj:`str`, `optional`):
|
pretrained_model_name_or_path (:obj:`str`, `optional`):
|
||||||
Can be either:
|
Can be either:
|
||||||
|
|
||||||
- A string with the `shortcut name` of a pretrained model to load from cache or download, e.g.,
|
- A string, the `model id` of a pretrained model hosted inside a model repo on huggingface.co.
|
||||||
``bert-base-uncased``.
|
Valid model ids can be located at the root-level, like ``bert-base-uncased``, or namespaced under
|
||||||
- A string with the `identifier name` of a pretrained model that was user-uploaded to our S3, e.g.,
|
a user or organization name, like ``dbmdz/bert-base-german-cased``.
|
||||||
``dbmdz/bert-base-german-cased``.
|
|
||||||
- A path to a `directory` containing model weights saved using
|
- A path to a `directory` containing model weights saved using
|
||||||
:func:`~transformers.PreTrainedModel.save_pretrained`, e.g., ``./my_model_directory/``.
|
:func:`~transformers.PreTrainedModel.save_pretrained`, e.g., ``./my_model_directory/``.
|
||||||
- A path or url to a `tensorflow index checkpoint file` (e.g, ``./tf_model/model.ckpt.index``). In
|
- A path or url to a `tensorflow index checkpoint file` (e.g, ``./tf_model/model.ckpt.index``). In
|
||||||
@@ -781,8 +780,8 @@ class PreTrainedModel(nn.Module, ModuleUtilsMixin, GenerationMixin):
|
|||||||
Configuration for the model to use instead of an automatically loaded configuation. Configuration can
|
Configuration for the model to use instead of an automatically loaded configuation. Configuration can
|
||||||
be automatically loaded when:
|
be automatically loaded when:
|
||||||
|
|
||||||
- The model is a model provided by the library (loaded with the `shortcut name` string of a
|
- The model is a model provided by the library (loaded with the `model id` string of a pretrained
|
||||||
pretrained model).
|
model).
|
||||||
- The model was saved using :func:`~transformers.PreTrainedModel.save_pretrained` and is reloaded
|
- The model was saved using :func:`~transformers.PreTrainedModel.save_pretrained` and is reloaded
|
||||||
by supplying the save directory.
|
by supplying the save directory.
|
||||||
- The model is loaded by supplying a local directory as ``pretrained_model_name_or_path`` and a
|
- The model is loaded by supplying a local directory as ``pretrained_model_name_or_path`` and a
|
||||||
@@ -838,7 +837,7 @@ class PreTrainedModel(nn.Module, ModuleUtilsMixin, GenerationMixin):
|
|||||||
Examples::
|
Examples::
|
||||||
|
|
||||||
>>> from transformers import BertConfig, BertModel
|
>>> from transformers import BertConfig, BertModel
|
||||||
>>> # Download model and configuration from S3 and cache.
|
>>> # Download model and configuration from huggingface.co and cache.
|
||||||
>>> model = BertModel.from_pretrained('bert-base-uncased')
|
>>> model = BertModel.from_pretrained('bert-base-uncased')
|
||||||
>>> # Model was saved using `save_pretrained('./test/saved_model/')` (for example purposes, not runnable).
|
>>> # Model was saved using `save_pretrained('./test/saved_model/')` (for example purposes, not runnable).
|
||||||
>>> model = BertModel.from_pretrained('./test/saved_model/')
|
>>> model = BertModel.from_pretrained('./test/saved_model/')
|
||||||
|
|||||||
@@ -277,10 +277,9 @@ class AutoConfig:
|
|||||||
pretrained_model_name_or_path (:obj:`str`):
|
pretrained_model_name_or_path (:obj:`str`):
|
||||||
Can be either:
|
Can be either:
|
||||||
|
|
||||||
- A string with the `shortcut name` of a pretrained model configuration to load from cache or
|
- A string, the `model id` of a pretrained model configuration hosted inside a model repo on
|
||||||
download, e.g., ``bert-base-uncased``.
|
huggingface.co. Valid model ids can be located at the root-level, like ``bert-base-uncased``, or
|
||||||
- A string with the `identifier name` of a pretrained model configuration that was user-uploaded to
|
namespaced under a user or organization name, like ``dbmdz/bert-base-german-cased``.
|
||||||
our S3, e.g., ``dbmdz/bert-base-german-cased``.
|
|
||||||
- A path to a `directory` containing a configuration file saved using the
|
- A path to a `directory` containing a configuration file saved using the
|
||||||
:meth:`~transformers.PretrainedConfig.save_pretrained` method, or the
|
:meth:`~transformers.PretrainedConfig.save_pretrained` method, or the
|
||||||
:meth:`~transformers.PreTrainedModel.save_pretrained` method, e.g., ``./my_model_directory/``.
|
:meth:`~transformers.PreTrainedModel.save_pretrained` method, e.g., ``./my_model_directory/``.
|
||||||
@@ -317,10 +316,10 @@ class AutoConfig:
|
|||||||
|
|
||||||
>>> from transformers import AutoConfig
|
>>> from transformers import AutoConfig
|
||||||
|
|
||||||
>>> # Download configuration from S3 and cache.
|
>>> # Download configuration from huggingface.co and cache.
|
||||||
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
||||||
|
|
||||||
>>> # Download configuration from S3 (user-uploaded) and cache.
|
>>> # Download configuration from huggingface.co (user-uploaded) and cache.
|
||||||
>>> config = AutoConfig.from_pretrained('dbmdz/bert-base-german-cased')
|
>>> config = AutoConfig.from_pretrained('dbmdz/bert-base-german-cased')
|
||||||
|
|
||||||
>>> # If configuration file is in a directory (e.g., was saved using `save_pretrained('./test/saved_model/')`).
|
>>> # If configuration file is in a directory (e.g., was saved using `save_pretrained('./test/saved_model/')`).
|
||||||
|
|||||||
@@ -505,10 +505,9 @@ AUTO_MODEL_PRETRAINED_DOCSTRING = r"""
|
|||||||
pretrained_model_name_or_path:
|
pretrained_model_name_or_path:
|
||||||
Can be either:
|
Can be either:
|
||||||
|
|
||||||
- A string with the `shortcut name` of a pretrained model to load from cache or download, e.g.,
|
- A string, the `model id` of a pretrained model hosted inside a model repo on huggingface.co.
|
||||||
``bert-base-uncased``.
|
Valid model ids can be located at the root-level, like ``bert-base-uncased``, or namespaced under
|
||||||
- A string with the `identifier name` of a pretrained model that was user-uploaded to our S3, e.g.,
|
a user or organization name, like ``dbmdz/bert-base-german-cased``.
|
||||||
``dbmdz/bert-base-german-cased``.
|
|
||||||
- A path to a `directory` containing model weights saved using
|
- A path to a `directory` containing model weights saved using
|
||||||
:func:`~transformers.PreTrainedModel.save_pretrained`, e.g., ``./my_model_directory/``.
|
:func:`~transformers.PreTrainedModel.save_pretrained`, e.g., ``./my_model_directory/``.
|
||||||
- A path or url to a `tensorflow index checkpoint file` (e.g, ``./tf_model/model.ckpt.index``). In
|
- A path or url to a `tensorflow index checkpoint file` (e.g, ``./tf_model/model.ckpt.index``). In
|
||||||
@@ -521,8 +520,8 @@ AUTO_MODEL_PRETRAINED_DOCSTRING = r"""
|
|||||||
Configuration for the model to use instead of an automatically loaded configuration. Configuration can
|
Configuration for the model to use instead of an automatically loaded configuration. Configuration can
|
||||||
be automatically loaded when:
|
be automatically loaded when:
|
||||||
|
|
||||||
- The model is a model provided by the library (loaded with the `shortcut name` string of a
|
- The model is a model provided by the library (loaded with the `model id` string of a pretrained
|
||||||
pretrained model).
|
model).
|
||||||
- The model was saved using :meth:`~transformers.PreTrainedModel.save_pretrained` and is reloaded
|
- The model was saved using :meth:`~transformers.PreTrainedModel.save_pretrained` and is reloaded
|
||||||
by supplying the save directory.
|
by supplying the save directory.
|
||||||
- The model is loaded by supplying a local directory as ``pretrained_model_name_or_path`` and a
|
- The model is loaded by supplying a local directory as ``pretrained_model_name_or_path`` and a
|
||||||
@@ -608,7 +607,7 @@ class AutoModel:
|
|||||||
Examples::
|
Examples::
|
||||||
|
|
||||||
>>> from transformers import AutoConfig, AutoModel
|
>>> from transformers import AutoConfig, AutoModel
|
||||||
>>> # Download configuration from S3 and cache.
|
>>> # Download configuration from huggingface.co and cache.
|
||||||
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
||||||
>>> model = AutoModel.from_config(config)
|
>>> model = AutoModel.from_config(config)
|
||||||
"""
|
"""
|
||||||
@@ -634,7 +633,7 @@ class AutoModel:
|
|||||||
|
|
||||||
>>> from transformers import AutoConfig, AutoModel
|
>>> from transformers import AutoConfig, AutoModel
|
||||||
|
|
||||||
>>> # Download model and configuration from S3 and cache.
|
>>> # Download model and configuration from huggingface.co and cache.
|
||||||
>>> model = AutoModel.from_pretrained('bert-base-uncased')
|
>>> model = AutoModel.from_pretrained('bert-base-uncased')
|
||||||
|
|
||||||
>>> # Update configuration during loading
|
>>> # Update configuration during loading
|
||||||
@@ -702,7 +701,7 @@ class AutoModelForPreTraining:
|
|||||||
Examples::
|
Examples::
|
||||||
|
|
||||||
>>> from transformers import AutoConfig, AutoModelForPreTraining
|
>>> from transformers import AutoConfig, AutoModelForPreTraining
|
||||||
>>> # Download configuration from S3 and cache.
|
>>> # Download configuration from huggingface.co and cache.
|
||||||
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
||||||
>>> model = AutoModelForPreTraining.from_config(config)
|
>>> model = AutoModelForPreTraining.from_config(config)
|
||||||
"""
|
"""
|
||||||
@@ -728,7 +727,7 @@ class AutoModelForPreTraining:
|
|||||||
|
|
||||||
>>> from transformers import AutoConfig, AutoModelForPreTraining
|
>>> from transformers import AutoConfig, AutoModelForPreTraining
|
||||||
|
|
||||||
>>> # Download model and configuration from S3 and cache.
|
>>> # Download model and configuration from huggingface.co and cache.
|
||||||
>>> model = AutoModelForPreTraining.from_pretrained('bert-base-uncased')
|
>>> model = AutoModelForPreTraining.from_pretrained('bert-base-uncased')
|
||||||
|
|
||||||
>>> # Update configuration during loading
|
>>> # Update configuration during loading
|
||||||
@@ -802,7 +801,7 @@ class AutoModelWithLMHead:
|
|||||||
Examples::
|
Examples::
|
||||||
|
|
||||||
>>> from transformers import AutoConfig, AutoModelWithLMHead
|
>>> from transformers import AutoConfig, AutoModelWithLMHead
|
||||||
>>> # Download configuration from S3 and cache.
|
>>> # Download configuration from huggingface.co and cache.
|
||||||
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
||||||
>>> model = AutoModelWithLMHead.from_config(config)
|
>>> model = AutoModelWithLMHead.from_config(config)
|
||||||
"""
|
"""
|
||||||
@@ -834,7 +833,7 @@ class AutoModelWithLMHead:
|
|||||||
|
|
||||||
>>> from transformers import AutoConfig, AutoModelWithLMHead
|
>>> from transformers import AutoConfig, AutoModelWithLMHead
|
||||||
|
|
||||||
>>> # Download model and configuration from S3 and cache.
|
>>> # Download model and configuration from huggingface.co and cache.
|
||||||
>>> model = AutoModelWithLMHead.from_pretrained('bert-base-uncased')
|
>>> model = AutoModelWithLMHead.from_pretrained('bert-base-uncased')
|
||||||
|
|
||||||
>>> # Update configuration during loading
|
>>> # Update configuration during loading
|
||||||
@@ -908,7 +907,7 @@ class AutoModelForCausalLM:
|
|||||||
Examples::
|
Examples::
|
||||||
|
|
||||||
>>> from transformers import AutoConfig, AutoModelForCausalLM
|
>>> from transformers import AutoConfig, AutoModelForCausalLM
|
||||||
>>> # Download configuration from S3 and cache.
|
>>> # Download configuration from huggingface.co and cache.
|
||||||
>>> config = AutoConfig.from_pretrained('gpt2')
|
>>> config = AutoConfig.from_pretrained('gpt2')
|
||||||
>>> model = AutoModelForCausalLM.from_config(config)
|
>>> model = AutoModelForCausalLM.from_config(config)
|
||||||
"""
|
"""
|
||||||
@@ -934,7 +933,7 @@ class AutoModelForCausalLM:
|
|||||||
|
|
||||||
>>> from transformers import AutoConfig, AutoModelForCausalLM
|
>>> from transformers import AutoConfig, AutoModelForCausalLM
|
||||||
|
|
||||||
>>> # Download model and configuration from S3 and cache.
|
>>> # Download model and configuration from huggingface.co and cache.
|
||||||
>>> model = AutoModelForCausalLM.from_pretrained('gpt2')
|
>>> model = AutoModelForCausalLM.from_pretrained('gpt2')
|
||||||
|
|
||||||
>>> # Update configuration during loading
|
>>> # Update configuration during loading
|
||||||
@@ -1002,7 +1001,7 @@ class AutoModelForMaskedLM:
|
|||||||
Examples::
|
Examples::
|
||||||
|
|
||||||
>>> from transformers import AutoConfig, AutoModelForMaskedLM
|
>>> from transformers import AutoConfig, AutoModelForMaskedLM
|
||||||
>>> # Download configuration from S3 and cache.
|
>>> # Download configuration from huggingface.co and cache.
|
||||||
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
||||||
>>> model = AutoModelForMaskedLM.from_config(config)
|
>>> model = AutoModelForMaskedLM.from_config(config)
|
||||||
"""
|
"""
|
||||||
@@ -1028,7 +1027,7 @@ class AutoModelForMaskedLM:
|
|||||||
|
|
||||||
>>> from transformers import AutoConfig, AutoModelForMaskedLM
|
>>> from transformers import AutoConfig, AutoModelForMaskedLM
|
||||||
|
|
||||||
>>> # Download model and configuration from S3 and cache.
|
>>> # Download model and configuration from huggingface.co and cache.
|
||||||
>>> model = AutoModelForMaskedLM.from_pretrained('bert-base-uncased')
|
>>> model = AutoModelForMaskedLM.from_pretrained('bert-base-uncased')
|
||||||
|
|
||||||
>>> # Update configuration during loading
|
>>> # Update configuration during loading
|
||||||
@@ -1096,7 +1095,7 @@ class AutoModelForSeq2SeqLM:
|
|||||||
Examples::
|
Examples::
|
||||||
|
|
||||||
>>> from transformers import AutoConfig, AutoModelForSeq2SeqLM
|
>>> from transformers import AutoConfig, AutoModelForSeq2SeqLM
|
||||||
>>> # Download configuration from S3 and cache.
|
>>> # Download configuration from huggingface.co and cache.
|
||||||
>>> config = AutoConfig.from_pretrained('t5')
|
>>> config = AutoConfig.from_pretrained('t5')
|
||||||
>>> model = AutoModelForSeq2SeqLM.from_config(config)
|
>>> model = AutoModelForSeq2SeqLM.from_config(config)
|
||||||
"""
|
"""
|
||||||
@@ -1124,7 +1123,7 @@ class AutoModelForSeq2SeqLM:
|
|||||||
|
|
||||||
>>> from transformers import AutoConfig, AutoModelForSeq2SeqLM
|
>>> from transformers import AutoConfig, AutoModelForSeq2SeqLM
|
||||||
|
|
||||||
>>> # Download model and configuration from S3 and cache.
|
>>> # Download model and configuration from huggingface.co and cache.
|
||||||
>>> model = AutoModelForSeq2SeqLM.from_pretrained('t5-base')
|
>>> model = AutoModelForSeq2SeqLM.from_pretrained('t5-base')
|
||||||
|
|
||||||
>>> # Update configuration during loading
|
>>> # Update configuration during loading
|
||||||
@@ -1194,7 +1193,7 @@ class AutoModelForSequenceClassification:
|
|||||||
Examples::
|
Examples::
|
||||||
|
|
||||||
>>> from transformers import AutoConfig, AutoModelForSequenceClassification
|
>>> from transformers import AutoConfig, AutoModelForSequenceClassification
|
||||||
>>> # Download configuration from S3 and cache.
|
>>> # Download configuration from huggingface.co and cache.
|
||||||
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
||||||
>>> model = AutoModelForSequenceClassification.from_config(config)
|
>>> model = AutoModelForSequenceClassification.from_config(config)
|
||||||
"""
|
"""
|
||||||
@@ -1222,7 +1221,7 @@ class AutoModelForSequenceClassification:
|
|||||||
|
|
||||||
>>> from transformers import AutoConfig, AutoModelForSequenceClassification
|
>>> from transformers import AutoConfig, AutoModelForSequenceClassification
|
||||||
|
|
||||||
>>> # Download model and configuration from S3 and cache.
|
>>> # Download model and configuration from huggingface.co and cache.
|
||||||
>>> model = AutoModelForSequenceClassification.from_pretrained('bert-base-uncased')
|
>>> model = AutoModelForSequenceClassification.from_pretrained('bert-base-uncased')
|
||||||
|
|
||||||
>>> # Update configuration during loading
|
>>> # Update configuration during loading
|
||||||
@@ -1291,7 +1290,7 @@ class AutoModelForQuestionAnswering:
|
|||||||
Examples::
|
Examples::
|
||||||
|
|
||||||
>>> from transformers import AutoConfig, AutoModelForQuestionAnswering
|
>>> from transformers import AutoConfig, AutoModelForQuestionAnswering
|
||||||
>>> # Download configuration from S3 and cache.
|
>>> # Download configuration from huggingface.co and cache.
|
||||||
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
||||||
>>> model = AutoModelForQuestionAnswering.from_config(config)
|
>>> model = AutoModelForQuestionAnswering.from_config(config)
|
||||||
"""
|
"""
|
||||||
@@ -1320,7 +1319,7 @@ class AutoModelForQuestionAnswering:
|
|||||||
|
|
||||||
>>> from transformers import AutoConfig, AutoModelForQuestionAnswering
|
>>> from transformers import AutoConfig, AutoModelForQuestionAnswering
|
||||||
|
|
||||||
>>> # Download model and configuration from S3 and cache.
|
>>> # Download model and configuration from huggingface.co and cache.
|
||||||
>>> model = AutoModelForQuestionAnswering.from_pretrained('bert-base-uncased')
|
>>> model = AutoModelForQuestionAnswering.from_pretrained('bert-base-uncased')
|
||||||
|
|
||||||
>>> # Update configuration during loading
|
>>> # Update configuration during loading
|
||||||
@@ -1390,7 +1389,7 @@ class AutoModelForTokenClassification:
|
|||||||
Examples::
|
Examples::
|
||||||
|
|
||||||
>>> from transformers import AutoConfig, AutoModelForTokenClassification
|
>>> from transformers import AutoConfig, AutoModelForTokenClassification
|
||||||
>>> # Download configuration from S3 and cache.
|
>>> # Download configuration from huggingface.co and cache.
|
||||||
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
||||||
>>> model = AutoModelForTokenClassification.from_config(config)
|
>>> model = AutoModelForTokenClassification.from_config(config)
|
||||||
"""
|
"""
|
||||||
@@ -1419,7 +1418,7 @@ class AutoModelForTokenClassification:
|
|||||||
|
|
||||||
>>> from transformers import AutoConfig, AutoModelForTokenClassification
|
>>> from transformers import AutoConfig, AutoModelForTokenClassification
|
||||||
|
|
||||||
>>> # Download model and configuration from S3 and cache.
|
>>> # Download model and configuration from huggingface.co and cache.
|
||||||
>>> model = AutoModelForTokenClassification.from_pretrained('bert-base-uncased')
|
>>> model = AutoModelForTokenClassification.from_pretrained('bert-base-uncased')
|
||||||
|
|
||||||
>>> # Update configuration during loading
|
>>> # Update configuration during loading
|
||||||
@@ -1490,7 +1489,7 @@ class AutoModelForMultipleChoice:
|
|||||||
Examples::
|
Examples::
|
||||||
|
|
||||||
>>> from transformers import AutoConfig, AutoModelForMultipleChoice
|
>>> from transformers import AutoConfig, AutoModelForMultipleChoice
|
||||||
>>> # Download configuration from S3 and cache.
|
>>> # Download configuration from huggingface.co and cache.
|
||||||
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
||||||
>>> model = AutoModelForMultipleChoice.from_config(config)
|
>>> model = AutoModelForMultipleChoice.from_config(config)
|
||||||
"""
|
"""
|
||||||
@@ -1519,7 +1518,7 @@ class AutoModelForMultipleChoice:
|
|||||||
|
|
||||||
>>> from transformers import AutoConfig, AutoModelForMultipleChoice
|
>>> from transformers import AutoConfig, AutoModelForMultipleChoice
|
||||||
|
|
||||||
>>> # Download model and configuration from S3 and cache.
|
>>> # Download model and configuration from huggingface.co and cache.
|
||||||
>>> model = AutoModelForMultipleChoice.from_pretrained('bert-base-uncased')
|
>>> model = AutoModelForMultipleChoice.from_pretrained('bert-base-uncased')
|
||||||
|
|
||||||
>>> # Update configuration during loading
|
>>> # Update configuration during loading
|
||||||
@@ -1590,7 +1589,7 @@ class AutoModelForNextSentencePrediction:
|
|||||||
Examples::
|
Examples::
|
||||||
|
|
||||||
>>> from transformers import AutoConfig, AutoModelForNextSentencePrediction
|
>>> from transformers import AutoConfig, AutoModelForNextSentencePrediction
|
||||||
>>> # Download configuration from S3 and cache.
|
>>> # Download configuration from huggingface.co and cache.
|
||||||
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
||||||
>>> model = AutoModelForNextSentencePrediction.from_config(config)
|
>>> model = AutoModelForNextSentencePrediction.from_config(config)
|
||||||
"""
|
"""
|
||||||
@@ -1619,7 +1618,7 @@ class AutoModelForNextSentencePrediction:
|
|||||||
|
|
||||||
>>> from transformers import AutoConfig, AutoModelForNextSentencePrediction
|
>>> from transformers import AutoConfig, AutoModelForNextSentencePrediction
|
||||||
|
|
||||||
>>> # Download model and configuration from S3 and cache.
|
>>> # Download model and configuration from huggingface.co and cache.
|
||||||
>>> model = AutoModelForNextSentencePrediction.from_pretrained('bert-base-uncased')
|
>>> model = AutoModelForNextSentencePrediction.from_pretrained('bert-base-uncased')
|
||||||
|
|
||||||
>>> # Update configuration during loading
|
>>> # Update configuration during loading
|
||||||
|
|||||||
@@ -75,7 +75,7 @@ class FlaxAutoModel(object):
|
|||||||
Examples::
|
Examples::
|
||||||
|
|
||||||
config = BertConfig.from_pretrained('bert-base-uncased')
|
config = BertConfig.from_pretrained('bert-base-uncased')
|
||||||
# Download configuration from S3 and cache.
|
# Download configuration from huggingface.co and cache.
|
||||||
model = FlaxAutoModel.from_config(config)
|
model = FlaxAutoModel.from_config(config)
|
||||||
# E.g. model was saved using `save_pretrained('./test/saved_model/')`
|
# E.g. model was saved using `save_pretrained('./test/saved_model/')`
|
||||||
"""
|
"""
|
||||||
@@ -109,10 +109,9 @@ class FlaxAutoModel(object):
|
|||||||
Args:
|
Args:
|
||||||
pretrained_model_name_or_path: either:
|
pretrained_model_name_or_path: either:
|
||||||
|
|
||||||
- a string with the `shortcut name` of a pre-trained model to load from cache or download, e.g.:
|
- a string, the `model id` of a pretrained model hosted inside a model repo on huggingface.co. Valid
|
||||||
``bert-base-uncased``.
|
model ids can be located at the root-level, like ``bert-base-uncased``, or namespaced under a user or
|
||||||
- a string with the `identifier name` of a pre-trained model that was user-uploaded to our S3, e.g.:
|
organization name, like ``dbmdz/bert-base-german-cased``.
|
||||||
``dbmdz/bert-base-german-cased``.
|
|
||||||
- a path to a `directory` containing model weights saved using
|
- a path to a `directory` containing model weights saved using
|
||||||
:func:`~transformers.FlaxPreTrainedModel.save_pretrained`, e.g.: ``./my_model_directory/``.
|
:func:`~transformers.FlaxPreTrainedModel.save_pretrained`, e.g.: ``./my_model_directory/``.
|
||||||
- a path or url to a `tensorflow index checkpoint file` (e.g. `./tf_model/model.ckpt.index`). In this
|
- a path or url to a `tensorflow index checkpoint file` (e.g. `./tf_model/model.ckpt.index`). In this
|
||||||
@@ -165,7 +164,7 @@ class FlaxAutoModel(object):
|
|||||||
|
|
||||||
Examples::
|
Examples::
|
||||||
|
|
||||||
model = FlaxAutoModel.from_pretrained('bert-base-uncased') # Download model and configuration from S3 and cache.
|
model = FlaxAutoModel.from_pretrained('bert-base-uncased') # Download model and configuration from huggingface.co and cache.
|
||||||
model = FlaxAutoModel.from_pretrained('./test/bert_model/') # E.g. model was saved using `save_pretrained('./test/saved_model/')`
|
model = FlaxAutoModel.from_pretrained('./test/bert_model/') # E.g. model was saved using `save_pretrained('./test/saved_model/')`
|
||||||
assert model.config.output_attention == True
|
assert model.config.output_attention == True
|
||||||
|
|
||||||
|
|||||||
@@ -403,10 +403,9 @@ TF_AUTO_MODEL_PRETRAINED_DOCSTRING = r"""
|
|||||||
pretrained_model_name_or_path:
|
pretrained_model_name_or_path:
|
||||||
Can be either:
|
Can be either:
|
||||||
|
|
||||||
- A string with the `shortcut name` of a pretrained model to load from cache or download, e.g.,
|
- A string, the `model id` of a pretrained model hosted inside a model repo on huggingface.co.
|
||||||
``bert-base-uncased``.
|
Valid model ids can be located at the root-level, like ``bert-base-uncased``, or namespaced under
|
||||||
- A string with the `identifier name` of a pretrained model that was user-uploaded to our S3, e.g.,
|
a user or organization name, like ``dbmdz/bert-base-german-cased``.
|
||||||
``dbmdz/bert-base-german-cased``.
|
|
||||||
- A path to a `directory` containing model weights saved using
|
- A path to a `directory` containing model weights saved using
|
||||||
:func:`~transformers.PreTrainedModel.save_pretrained`, e.g., ``./my_model_directory/``.
|
:func:`~transformers.PreTrainedModel.save_pretrained`, e.g., ``./my_model_directory/``.
|
||||||
- A path or url to a `PyTorch state_dict save file` (e.g, ``./pt_model/pytorch_model.bin``). In
|
- A path or url to a `PyTorch state_dict save file` (e.g, ``./pt_model/pytorch_model.bin``). In
|
||||||
@@ -420,8 +419,8 @@ TF_AUTO_MODEL_PRETRAINED_DOCSTRING = r"""
|
|||||||
Configuration for the model to use instead of an automatically loaded configuration. Configuration can
|
Configuration for the model to use instead of an automatically loaded configuration. Configuration can
|
||||||
be automatically loaded when:
|
be automatically loaded when:
|
||||||
|
|
||||||
- The model is a model provided by the library (loaded with the `shortcut name` string of a
|
- The model is a model provided by the library (loaded with the `model id` string of a pretrained
|
||||||
pretrained model).
|
model).
|
||||||
- The model was saved using :meth:`~transformers.PreTrainedModel.save_pretrained` and is reloaded
|
- The model was saved using :meth:`~transformers.PreTrainedModel.save_pretrained` and is reloaded
|
||||||
by suppyling the save directory.
|
by suppyling the save directory.
|
||||||
- The model is loaded by suppyling a local directory as ``pretrained_model_name_or_path`` and a
|
- The model is loaded by suppyling a local directory as ``pretrained_model_name_or_path`` and a
|
||||||
@@ -507,7 +506,7 @@ class TFAutoModel(object):
|
|||||||
Examples::
|
Examples::
|
||||||
|
|
||||||
>>> from transformers import AutoConfig, TFAutoModel
|
>>> from transformers import AutoConfig, TFAutoModel
|
||||||
>>> # Download configuration from S3 and cache.
|
>>> # Download configuration from huggingface.co and cache.
|
||||||
>>> config = TFAutoConfig.from_pretrained('bert-base-uncased')
|
>>> config = TFAutoConfig.from_pretrained('bert-base-uncased')
|
||||||
>>> model = TFAutoModel.from_config(config)
|
>>> model = TFAutoModel.from_config(config)
|
||||||
"""
|
"""
|
||||||
@@ -533,7 +532,7 @@ class TFAutoModel(object):
|
|||||||
|
|
||||||
>>> from transformers import AutoConfig, AutoModel
|
>>> from transformers import AutoConfig, AutoModel
|
||||||
|
|
||||||
>>> # Download model and configuration from S3 and cache.
|
>>> # Download model and configuration from huggingface.co and cache.
|
||||||
>>> model = TFAutoModel.from_pretrained('bert-base-uncased')
|
>>> model = TFAutoModel.from_pretrained('bert-base-uncased')
|
||||||
|
|
||||||
>>> # Update configuration during loading
|
>>> # Update configuration during loading
|
||||||
@@ -601,7 +600,7 @@ class TFAutoModelForPreTraining(object):
|
|||||||
Examples::
|
Examples::
|
||||||
|
|
||||||
>>> from transformers import AutoConfig, TFAutoModelForPreTraining
|
>>> from transformers import AutoConfig, TFAutoModelForPreTraining
|
||||||
>>> # Download configuration from S3 and cache.
|
>>> # Download configuration from huggingface.co and cache.
|
||||||
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
||||||
>>> model = TFAutoModelForPreTraining.from_config(config)
|
>>> model = TFAutoModelForPreTraining.from_config(config)
|
||||||
"""
|
"""
|
||||||
@@ -627,7 +626,7 @@ class TFAutoModelForPreTraining(object):
|
|||||||
|
|
||||||
>>> from transformers import AutoConfig, TFAutoModelForPreTraining
|
>>> from transformers import AutoConfig, TFAutoModelForPreTraining
|
||||||
|
|
||||||
>>> # Download model and configuration from S3 and cache.
|
>>> # Download model and configuration from huggingface.co and cache.
|
||||||
>>> model = TFAutoModelForPreTraining.from_pretrained('bert-base-uncased')
|
>>> model = TFAutoModelForPreTraining.from_pretrained('bert-base-uncased')
|
||||||
|
|
||||||
>>> # Update configuration during loading
|
>>> # Update configuration during loading
|
||||||
@@ -701,7 +700,7 @@ class TFAutoModelWithLMHead(object):
|
|||||||
Examples::
|
Examples::
|
||||||
|
|
||||||
>>> from transformers import AutoConfig, TFAutoModelWithLMHead
|
>>> from transformers import AutoConfig, TFAutoModelWithLMHead
|
||||||
>>> # Download configuration from S3 and cache.
|
>>> # Download configuration from huggingface.co and cache.
|
||||||
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
||||||
>>> model = TFAutoModelWithLMHead.from_config(config)
|
>>> model = TFAutoModelWithLMHead.from_config(config)
|
||||||
"""
|
"""
|
||||||
@@ -733,7 +732,7 @@ class TFAutoModelWithLMHead(object):
|
|||||||
|
|
||||||
>>> from transformers import AutoConfig, TFAutoModelWithLMHead
|
>>> from transformers import AutoConfig, TFAutoModelWithLMHead
|
||||||
|
|
||||||
>>> # Download model and configuration from S3 and cache.
|
>>> # Download model and configuration from huggingface.co and cache.
|
||||||
>>> model = TFAutoModelWithLMHead.from_pretrained('bert-base-uncased')
|
>>> model = TFAutoModelWithLMHead.from_pretrained('bert-base-uncased')
|
||||||
|
|
||||||
>>> # Update configuration during loading
|
>>> # Update configuration during loading
|
||||||
@@ -808,7 +807,7 @@ class TFAutoModelForCausalLM:
|
|||||||
Examples::
|
Examples::
|
||||||
|
|
||||||
>>> from transformers import AutoConfig, TFAutoModelForCausalLM
|
>>> from transformers import AutoConfig, TFAutoModelForCausalLM
|
||||||
>>> # Download configuration from S3 and cache.
|
>>> # Download configuration from huggingface.co and cache.
|
||||||
>>> config = AutoConfig.from_pretrained('gpt2')
|
>>> config = AutoConfig.from_pretrained('gpt2')
|
||||||
>>> model = TFAutoModelForCausalLM.from_config(config)
|
>>> model = TFAutoModelForCausalLM.from_config(config)
|
||||||
"""
|
"""
|
||||||
@@ -834,7 +833,7 @@ class TFAutoModelForCausalLM:
|
|||||||
|
|
||||||
>>> from transformers import AutoConfig, TFAutoModelForCausalLM
|
>>> from transformers import AutoConfig, TFAutoModelForCausalLM
|
||||||
|
|
||||||
>>> # Download model and configuration from S3 and cache.
|
>>> # Download model and configuration from huggingface.co and cache.
|
||||||
>>> model = TFAutoModelForCausalLM.from_pretrained('gpt2')
|
>>> model = TFAutoModelForCausalLM.from_pretrained('gpt2')
|
||||||
|
|
||||||
>>> # Update configuration during loading
|
>>> # Update configuration during loading
|
||||||
@@ -902,7 +901,7 @@ class TFAutoModelForMaskedLM:
|
|||||||
Examples::
|
Examples::
|
||||||
|
|
||||||
>>> from transformers import AutoConfig, TFAutoModelForMaskedLM
|
>>> from transformers import AutoConfig, TFAutoModelForMaskedLM
|
||||||
>>> # Download configuration from S3 and cache.
|
>>> # Download configuration from huggingface.co and cache.
|
||||||
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
||||||
>>> model = TFAutoModelForMaskedLM.from_config(config)
|
>>> model = TFAutoModelForMaskedLM.from_config(config)
|
||||||
"""
|
"""
|
||||||
@@ -928,7 +927,7 @@ class TFAutoModelForMaskedLM:
|
|||||||
|
|
||||||
>>> from transformers import AutoConfig, TFAutoModelForMaskedLM
|
>>> from transformers import AutoConfig, TFAutoModelForMaskedLM
|
||||||
|
|
||||||
>>> # Download model and configuration from S3 and cache.
|
>>> # Download model and configuration from huggingface.co and cache.
|
||||||
>>> model = TFAutoModelForMaskedLM.from_pretrained('bert-base-uncased')
|
>>> model = TFAutoModelForMaskedLM.from_pretrained('bert-base-uncased')
|
||||||
|
|
||||||
>>> # Update configuration during loading
|
>>> # Update configuration during loading
|
||||||
@@ -996,7 +995,7 @@ class TFAutoModelForSeq2SeqLM:
|
|||||||
Examples::
|
Examples::
|
||||||
|
|
||||||
>>> from transformers import AutoConfig, TFAutoModelForSeq2SeqLM
|
>>> from transformers import AutoConfig, TFAutoModelForSeq2SeqLM
|
||||||
>>> # Download configuration from S3 and cache.
|
>>> # Download configuration from huggingface.co and cache.
|
||||||
>>> config = AutoConfig.from_pretrained('t5')
|
>>> config = AutoConfig.from_pretrained('t5')
|
||||||
>>> model = TFAutoModelForSeq2SeqLM.from_config(config)
|
>>> model = TFAutoModelForSeq2SeqLM.from_config(config)
|
||||||
"""
|
"""
|
||||||
@@ -1024,7 +1023,7 @@ class TFAutoModelForSeq2SeqLM:
|
|||||||
|
|
||||||
>>> from transformers import AutoConfig, TFAutoModelForSeq2SeqLM
|
>>> from transformers import AutoConfig, TFAutoModelForSeq2SeqLM
|
||||||
|
|
||||||
>>> # Download model and configuration from S3 and cache.
|
>>> # Download model and configuration from huggingface.co and cache.
|
||||||
>>> model = TFAutoModelForSeq2SeqLM.from_pretrained('t5-base')
|
>>> model = TFAutoModelForSeq2SeqLM.from_pretrained('t5-base')
|
||||||
|
|
||||||
>>> # Update configuration during loading
|
>>> # Update configuration during loading
|
||||||
@@ -1094,7 +1093,7 @@ class TFAutoModelForSequenceClassification(object):
|
|||||||
Examples::
|
Examples::
|
||||||
|
|
||||||
>>> from transformers import AutoConfig, TFAutoModelForSequenceClassification
|
>>> from transformers import AutoConfig, TFAutoModelForSequenceClassification
|
||||||
>>> # Download configuration from S3 and cache.
|
>>> # Download configuration from huggingface.co and cache.
|
||||||
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
||||||
>>> model = TFAutoModelForSequenceClassification.from_config(config)
|
>>> model = TFAutoModelForSequenceClassification.from_config(config)
|
||||||
"""
|
"""
|
||||||
@@ -1122,7 +1121,7 @@ class TFAutoModelForSequenceClassification(object):
|
|||||||
|
|
||||||
>>> from transformers import AutoConfig, TFAutoModelForSequenceClassification
|
>>> from transformers import AutoConfig, TFAutoModelForSequenceClassification
|
||||||
|
|
||||||
>>> # Download model and configuration from S3 and cache.
|
>>> # Download model and configuration from huggingface.co and cache.
|
||||||
>>> model = TFAutoModelForSequenceClassification.from_pretrained('bert-base-uncased')
|
>>> model = TFAutoModelForSequenceClassification.from_pretrained('bert-base-uncased')
|
||||||
|
|
||||||
>>> # Update configuration during loading
|
>>> # Update configuration during loading
|
||||||
@@ -1191,7 +1190,7 @@ class TFAutoModelForQuestionAnswering(object):
|
|||||||
Examples::
|
Examples::
|
||||||
|
|
||||||
>>> from transformers import AutoConfig, TFAutoModelForQuestionAnswering
|
>>> from transformers import AutoConfig, TFAutoModelForQuestionAnswering
|
||||||
>>> # Download configuration from S3 and cache.
|
>>> # Download configuration from huggingface.co and cache.
|
||||||
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
||||||
>>> model = TFAutoModelForQuestionAnswering.from_config(config)
|
>>> model = TFAutoModelForQuestionAnswering.from_config(config)
|
||||||
"""
|
"""
|
||||||
@@ -1219,7 +1218,7 @@ class TFAutoModelForQuestionAnswering(object):
|
|||||||
|
|
||||||
>>> from transformers import AutoConfig, TFAutoModelForQuestionAnswering
|
>>> from transformers import AutoConfig, TFAutoModelForQuestionAnswering
|
||||||
|
|
||||||
>>> # Download model and configuration from S3 and cache.
|
>>> # Download model and configuration from huggingface.co and cache.
|
||||||
>>> model = TFAutoModelForQuestionAnswering.from_pretrained('bert-base-uncased')
|
>>> model = TFAutoModelForQuestionAnswering.from_pretrained('bert-base-uncased')
|
||||||
|
|
||||||
>>> # Update configuration during loading
|
>>> # Update configuration during loading
|
||||||
@@ -1288,7 +1287,7 @@ class TFAutoModelForTokenClassification:
|
|||||||
Examples::
|
Examples::
|
||||||
|
|
||||||
>>> from transformers import AutoConfig, TFAutoModelForTokenClassification
|
>>> from transformers import AutoConfig, TFAutoModelForTokenClassification
|
||||||
>>> # Download configuration from S3 and cache.
|
>>> # Download configuration from huggingface.co and cache.
|
||||||
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
||||||
>>> model = TFAutoModelForTokenClassification.from_config(config)
|
>>> model = TFAutoModelForTokenClassification.from_config(config)
|
||||||
"""
|
"""
|
||||||
@@ -1316,7 +1315,7 @@ class TFAutoModelForTokenClassification:
|
|||||||
|
|
||||||
>>> from transformers import AutoConfig, TFAutoModelForTokenClassification
|
>>> from transformers import AutoConfig, TFAutoModelForTokenClassification
|
||||||
|
|
||||||
>>> # Download model and configuration from S3 and cache.
|
>>> # Download model and configuration from huggingface.co and cache.
|
||||||
>>> model = TFAutoModelForTokenClassification.from_pretrained('bert-base-uncased')
|
>>> model = TFAutoModelForTokenClassification.from_pretrained('bert-base-uncased')
|
||||||
|
|
||||||
>>> # Update configuration during loading
|
>>> # Update configuration during loading
|
||||||
@@ -1386,7 +1385,7 @@ class TFAutoModelForMultipleChoice:
|
|||||||
Examples::
|
Examples::
|
||||||
|
|
||||||
>>> from transformers import AutoConfig, TFAutoModelForMultipleChoice
|
>>> from transformers import AutoConfig, TFAutoModelForMultipleChoice
|
||||||
>>> # Download configuration from S3 and cache.
|
>>> # Download configuration from huggingface.co and cache.
|
||||||
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
||||||
>>> model = TFAutoModelForMultipleChoice.from_config(config)
|
>>> model = TFAutoModelForMultipleChoice.from_config(config)
|
||||||
"""
|
"""
|
||||||
@@ -1414,7 +1413,7 @@ class TFAutoModelForMultipleChoice:
|
|||||||
|
|
||||||
>>> from transformers import AutoConfig, TFAutoModelForMultipleChoice
|
>>> from transformers import AutoConfig, TFAutoModelForMultipleChoice
|
||||||
|
|
||||||
>>> # Download model and configuration from S3 and cache.
|
>>> # Download model and configuration from huggingface.co and cache.
|
||||||
>>> model = TFAutoModelForMultipleChoice.from_pretrained('bert-base-uncased')
|
>>> model = TFAutoModelForMultipleChoice.from_pretrained('bert-base-uncased')
|
||||||
|
|
||||||
>>> # Update configuration during loading
|
>>> # Update configuration during loading
|
||||||
@@ -1484,7 +1483,7 @@ class TFAutoModelForNextSentencePrediction:
|
|||||||
Examples::
|
Examples::
|
||||||
|
|
||||||
>>> from transformers import AutoConfig, TFAutoModelForNextSentencePrediction
|
>>> from transformers import AutoConfig, TFAutoModelForNextSentencePrediction
|
||||||
>>> # Download configuration from S3 and cache.
|
>>> # Download configuration from huggingface.co and cache.
|
||||||
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
>>> config = AutoConfig.from_pretrained('bert-base-uncased')
|
||||||
>>> model = TFAutoModelForNextSentencePrediction.from_config(config)
|
>>> model = TFAutoModelForNextSentencePrediction.from_config(config)
|
||||||
"""
|
"""
|
||||||
@@ -1512,7 +1511,7 @@ class TFAutoModelForNextSentencePrediction:
|
|||||||
|
|
||||||
>>> from transformers import AutoConfig, TFAutoModelForNextSentencePrediction
|
>>> from transformers import AutoConfig, TFAutoModelForNextSentencePrediction
|
||||||
|
|
||||||
>>> # Download model and configuration from S3 and cache.
|
>>> # Download model and configuration from huggingface.co and cache.
|
||||||
>>> model = TFAutoModelForNextSentencePrediction.from_pretrained('bert-base-uncased')
|
>>> model = TFAutoModelForNextSentencePrediction.from_pretrained('bert-base-uncased')
|
||||||
|
|
||||||
>>> # Update configuration during loading
|
>>> # Update configuration during loading
|
||||||
|
|||||||
@@ -250,10 +250,9 @@ class AutoTokenizer:
|
|||||||
pretrained_model_name_or_path (:obj:`str`):
|
pretrained_model_name_or_path (:obj:`str`):
|
||||||
Can be either:
|
Can be either:
|
||||||
|
|
||||||
- A string with the `shortcut name` of a predefined tokenizer to load from cache or download, e.g.,
|
- A string, the `model id` of a predefined tokenizer hosted inside a model repo on huggingface.co.
|
||||||
``bert-base-uncased``.
|
Valid model ids can be located at the root-level, like ``bert-base-uncased``, or namespaced under
|
||||||
- A string with the `identifier name` of a predefined tokenizer that was user-uploaded to our S3,
|
a user or organization name, like ``dbmdz/bert-base-german-cased``.
|
||||||
e.g., ``dbmdz/bert-base-german-cased``.
|
|
||||||
- A path to a `directory` containing vocabulary files required by the tokenizer, for instance saved
|
- A path to a `directory` containing vocabulary files required by the tokenizer, for instance saved
|
||||||
using the :func:`~transformers.PreTrainedTokenizer.save_pretrained` method, e.g.,
|
using the :func:`~transformers.PreTrainedTokenizer.save_pretrained` method, e.g.,
|
||||||
``./my_model_directory/``.
|
``./my_model_directory/``.
|
||||||
@@ -280,6 +279,9 @@ class AutoTokenizer:
|
|||||||
The specific model version to use. It can be a branch name, a tag name, or a commit id, since we use a
|
The specific model version to use. It can be a branch name, a tag name, or a commit id, since we use a
|
||||||
git-based system for storing models and other artifacts on huggingface.co, so ``revision`` can be any
|
git-based system for storing models and other artifacts on huggingface.co, so ``revision`` can be any
|
||||||
identifier allowed by git.
|
identifier allowed by git.
|
||||||
|
subfolder (:obj:`str`, `optional`):
|
||||||
|
In case the relevant files are located inside a subfolder of the model repo on huggingface.co (e.g. for
|
||||||
|
facebook/rag-token-base), specify it here.
|
||||||
use_fast (:obj:`bool`, `optional`, defaults to :obj:`True`):
|
use_fast (:obj:`bool`, `optional`, defaults to :obj:`True`):
|
||||||
Whether or not to try to load the fast version of the tokenizer.
|
Whether or not to try to load the fast version of the tokenizer.
|
||||||
kwargs (additional keyword arguments, `optional`):
|
kwargs (additional keyword arguments, `optional`):
|
||||||
@@ -291,10 +293,10 @@ class AutoTokenizer:
|
|||||||
|
|
||||||
>>> from transformers import AutoTokenizer
|
>>> from transformers import AutoTokenizer
|
||||||
|
|
||||||
>>> # Download vocabulary from S3 and cache.
|
>>> # Download vocabulary from huggingface.co and cache.
|
||||||
>>> tokenizer = AutoTokenizer.from_pretrained('bert-base-uncased')
|
>>> tokenizer = AutoTokenizer.from_pretrained('bert-base-uncased')
|
||||||
|
|
||||||
>>> # Download vocabulary from S3 (user-uploaded) and cache.
|
>>> # Download vocabulary from huggingface.co (user-uploaded) and cache.
|
||||||
>>> tokenizer = AutoTokenizer.from_pretrained('dbmdz/bert-base-german-cased')
|
>>> tokenizer = AutoTokenizer.from_pretrained('dbmdz/bert-base-german-cased')
|
||||||
|
|
||||||
>>> # If vocabulary files are in a directory (e.g. tokenizer was saved using `save_pretrained('./test/saved_model/')`)
|
>>> # If vocabulary files are in a directory (e.g. tokenizer was saved using `save_pretrained('./test/saved_model/')`)
|
||||||
|
|||||||
@@ -214,10 +214,9 @@ class EncoderDecoderModel(PreTrainedModel):
|
|||||||
encoder_pretrained_model_name_or_path (:obj: `str`, `optional`):
|
encoder_pretrained_model_name_or_path (:obj: `str`, `optional`):
|
||||||
Information necessary to initiate the encoder. Can be either:
|
Information necessary to initiate the encoder. Can be either:
|
||||||
|
|
||||||
- A string with the `shortcut name` of a pretrained model to load from cache or download, e.g.,
|
- A string, the `model id` of a pretrained model hosted inside a model repo on huggingface.co.
|
||||||
``bert-base-uncased``.
|
Valid model ids can be located at the root-level, like ``bert-base-uncased``, or namespaced under
|
||||||
- A string with the `identifier name` of a pretrained model that was user-uploaded to our S3, e.g.,
|
a user or organization name, like ``dbmdz/bert-base-german-cased``.
|
||||||
``dbmdz/bert-base-german-cased``.
|
|
||||||
- A path to a `directory` containing model weights saved using
|
- A path to a `directory` containing model weights saved using
|
||||||
:func:`~transformers.PreTrainedModel.save_pretrained`, e.g., ``./my_model_directory/``.
|
:func:`~transformers.PreTrainedModel.save_pretrained`, e.g., ``./my_model_directory/``.
|
||||||
- A path or url to a `tensorflow index checkpoint file` (e.g, ``./tf_model/model.ckpt.index``). In
|
- A path or url to a `tensorflow index checkpoint file` (e.g, ``./tf_model/model.ckpt.index``). In
|
||||||
@@ -228,10 +227,9 @@ class EncoderDecoderModel(PreTrainedModel):
|
|||||||
decoder_pretrained_model_name_or_path (:obj: `str`, `optional`, defaults to `None`):
|
decoder_pretrained_model_name_or_path (:obj: `str`, `optional`, defaults to `None`):
|
||||||
Information necessary to initiate the decoder. Can be either:
|
Information necessary to initiate the decoder. Can be either:
|
||||||
|
|
||||||
- A string with the `shortcut name` of a pretrained model to load from cache or download, e.g.,
|
- A string, the `model id` of a pretrained model hosted inside a model repo on huggingface.co.
|
||||||
``bert-base-uncased``.
|
Valid model ids can be located at the root-level, like ``bert-base-uncased``, or namespaced under
|
||||||
- A string with the `identifier name` of a pretrained model that was user-uploaded to our S3, e.g.,
|
a user or organization name, like ``dbmdz/bert-base-german-cased``.
|
||||||
``dbmdz/bert-base-german-cased``.
|
|
||||||
- A path to a `directory` containing model weights saved using
|
- A path to a `directory` containing model weights saved using
|
||||||
:func:`~transformers.PreTrainedModel.save_pretrained`, e.g., ``./my_model_directory/``.
|
:func:`~transformers.PreTrainedModel.save_pretrained`, e.g., ``./my_model_directory/``.
|
||||||
- A path or url to a `tensorflow index checkpoint file` (e.g, ``./tf_model/model.ckpt.index``). In
|
- A path or url to a `tensorflow index checkpoint file` (e.g, ``./tf_model/model.ckpt.index``). In
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ VOCAB_FILES_NAMES = {"vocab_file": "vocab.txt"}
|
|||||||
|
|
||||||
####################################################
|
####################################################
|
||||||
# Mapping from the keyword arguments names of Tokenizer `__init__`
|
# Mapping from the keyword arguments names of Tokenizer `__init__`
|
||||||
# to pretrained vocabulary URL for all the model shortcut names.
|
# to pretrained vocabulary URL for all the model ids.
|
||||||
####################################################
|
####################################################
|
||||||
PRETRAINED_VOCAB_FILES_MAP = {
|
PRETRAINED_VOCAB_FILES_MAP = {
|
||||||
"vocab_file": {
|
"vocab_file": {
|
||||||
@@ -33,13 +33,13 @@ PRETRAINED_VOCAB_FILES_MAP = {
|
|||||||
}
|
}
|
||||||
|
|
||||||
####################################################
|
####################################################
|
||||||
# Mapping from model shortcut names to max length of inputs
|
# Mapping from model ids to max length of inputs
|
||||||
####################################################
|
####################################################
|
||||||
PRETRAINED_POSITIONAL_EMBEDDINGS_SIZES = {
|
PRETRAINED_POSITIONAL_EMBEDDINGS_SIZES = {
|
||||||
"unc-nlp/lxmert-base-uncased": 512,
|
"unc-nlp/lxmert-base-uncased": 512,
|
||||||
}
|
}
|
||||||
####################################################
|
####################################################
|
||||||
# Mapping from model shortcut names to a dictionary of additional
|
# Mapping from model ids to a dictionary of additional
|
||||||
# keyword arguments for Tokenizer `__init__`.
|
# keyword arguments for Tokenizer `__init__`.
|
||||||
# To be used for checkpoint specific configurations.
|
# To be used for checkpoint specific configurations.
|
||||||
####################################################
|
####################################################
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ VOCAB_FILES_NAMES = {"vocab_file": "vocab.txt", "tokenizer_file": "tokenizer.jso
|
|||||||
|
|
||||||
####################################################
|
####################################################
|
||||||
# Mapping from the keyword arguments names of Tokenizer `__init__`
|
# Mapping from the keyword arguments names of Tokenizer `__init__`
|
||||||
# to pretrained vocabulary URL for all the model shortcut names.
|
# to pretrained vocabulary URL for all the model ids.
|
||||||
####################################################
|
####################################################
|
||||||
PRETRAINED_VOCAB_FILES_MAP = {
|
PRETRAINED_VOCAB_FILES_MAP = {
|
||||||
"vocab_file": {
|
"vocab_file": {
|
||||||
@@ -37,13 +37,13 @@ PRETRAINED_VOCAB_FILES_MAP = {
|
|||||||
}
|
}
|
||||||
|
|
||||||
####################################################
|
####################################################
|
||||||
# Mapping from model shortcut names to max length of inputs
|
# Mapping from model ids to max length of inputs
|
||||||
####################################################
|
####################################################
|
||||||
PRETRAINED_POSITIONAL_EMBEDDINGS_SIZES = {
|
PRETRAINED_POSITIONAL_EMBEDDINGS_SIZES = {
|
||||||
"unc-nlp/lxmert-base-uncased": 512,
|
"unc-nlp/lxmert-base-uncased": 512,
|
||||||
}
|
}
|
||||||
####################################################
|
####################################################
|
||||||
# Mapping from model shortcut names to a dictionary of additional
|
# Mapping from model ids to a dictionary of additional
|
||||||
# keyword arguments for Tokenizer `__init__`.
|
# keyword arguments for Tokenizer `__init__`.
|
||||||
# To be used for checkpoint specific configurations.
|
# To be used for checkpoint specific configurations.
|
||||||
####################################################
|
####################################################
|
||||||
|
|||||||
@@ -238,10 +238,9 @@ class RagPreTrainedModel(PreTrainedModel):
|
|||||||
question_encoder_pretrained_model_name_or_path (:obj: `str`, `optional`, defaults to `None`):
|
question_encoder_pretrained_model_name_or_path (:obj: `str`, `optional`, defaults to `None`):
|
||||||
Information necessary to initiate the question encoder. Can be either:
|
Information necessary to initiate the question encoder. Can be either:
|
||||||
|
|
||||||
- A string with the `shortcut name` of a pretrained model to load from cache or download, e.g.,
|
- A string, the `model id` of a pretrained model hosted inside a model repo on huggingface.co.
|
||||||
``bert-base-uncased``.
|
Valid model ids can be located at the root-level, like ``bert-base-uncased``, or namespaced under
|
||||||
- A string with the `identifier name` of a pretrained model that was user-uploaded to our S3, e.g.,
|
a user or organization name, like ``dbmdz/bert-base-german-cased``.
|
||||||
``dbmdz/bert-base-german-cased``.
|
|
||||||
- A path to a `directory` containing model weights saved using
|
- A path to a `directory` containing model weights saved using
|
||||||
:func:`~transformers.PreTrainedModel.save_pretrained`, e.g., ``./my_model_directory/``.
|
:func:`~transformers.PreTrainedModel.save_pretrained`, e.g., ``./my_model_directory/``.
|
||||||
- A path or url to a `tensorflow index checkpoint file` (e.g, ``./tf_model/model.ckpt.index``). In
|
- A path or url to a `tensorflow index checkpoint file` (e.g, ``./tf_model/model.ckpt.index``). In
|
||||||
@@ -252,10 +251,9 @@ class RagPreTrainedModel(PreTrainedModel):
|
|||||||
generator_pretrained_model_name_or_path (:obj: `str`, `optional`, defaults to `None`):
|
generator_pretrained_model_name_or_path (:obj: `str`, `optional`, defaults to `None`):
|
||||||
Information necessary to initiate the generator. Can be either:
|
Information necessary to initiate the generator. Can be either:
|
||||||
|
|
||||||
- A string with the `shortcut name` of a pretrained model to load from cache or download, e.g.,
|
- A string, the `model id` of a pretrained model hosted inside a model repo on huggingface.co.
|
||||||
``bert-base-uncased``.
|
Valid model ids can be located at the root-level, like ``bert-base-uncased``, or namespaced under
|
||||||
- A string with the `identifier name` of a pretrained model that was user-uploaded to our S3, e.g.,
|
a user or organization name, like ``dbmdz/bert-base-german-cased``.
|
||||||
``dbmdz/bert-base-german-cased``.
|
|
||||||
- A path to a `directory` containing model weights saved using
|
- A path to a `directory` containing model weights saved using
|
||||||
:func:`~transformers.PreTrainedModel.save_pretrained`, e.g., ``./my_model_directory/``.
|
:func:`~transformers.PreTrainedModel.save_pretrained`, e.g., ``./my_model_directory/``.
|
||||||
- A path or url to a `tensorflow index checkpoint file` (e.g, ``./tf_model/model.ckpt.index``). In
|
- A path or url to a `tensorflow index checkpoint file` (e.g, ``./tf_model/model.ckpt.index``). In
|
||||||
|
|||||||
@@ -49,10 +49,12 @@ class RagTokenizer:
|
|||||||
if config is None:
|
if config is None:
|
||||||
config = RagConfig.from_pretrained(pretrained_model_name_or_path)
|
config = RagConfig.from_pretrained(pretrained_model_name_or_path)
|
||||||
|
|
||||||
question_encoder_path = os.path.join(pretrained_model_name_or_path, "question_encoder_tokenizer")
|
question_encoder = AutoTokenizer.from_pretrained(
|
||||||
generator_path = os.path.join(pretrained_model_name_or_path, "generator_tokenizer")
|
pretrained_model_name_or_path, config=config.question_encoder, subfolder="question_encoder_tokenizer"
|
||||||
question_encoder = AutoTokenizer.from_pretrained(question_encoder_path, config=config.question_encoder)
|
)
|
||||||
generator = AutoTokenizer.from_pretrained(generator_path, config=config.generator)
|
generator = AutoTokenizer.from_pretrained(
|
||||||
|
pretrained_model_name_or_path, config=config.generator, subfolder="generator_tokenizer"
|
||||||
|
)
|
||||||
return cls(question_encoder=question_encoder, generator=generator)
|
return cls(question_encoder=question_encoder, generator=generator)
|
||||||
|
|
||||||
def __call__(self, *args, **kwargs):
|
def __call__(self, *args, **kwargs):
|
||||||
|
|||||||
@@ -38,7 +38,7 @@ VOCAB_FILES_NAMES = {"vocab_file": "spiece.model"}
|
|||||||
|
|
||||||
####################################################
|
####################################################
|
||||||
# Mapping from the keyword arguments names of Tokenizer `__init__`
|
# Mapping from the keyword arguments names of Tokenizer `__init__`
|
||||||
# to pretrained vocabulary URL for all the model shortcut names.
|
# to pretrained vocabulary URL for all the model ids.
|
||||||
####################################################
|
####################################################
|
||||||
PRETRAINED_VOCAB_FILES_MAP = {
|
PRETRAINED_VOCAB_FILES_MAP = {
|
||||||
"vocab_file": {
|
"vocab_file": {
|
||||||
@@ -47,7 +47,7 @@ PRETRAINED_VOCAB_FILES_MAP = {
|
|||||||
}
|
}
|
||||||
|
|
||||||
####################################################
|
####################################################
|
||||||
# Mapping from model shortcut names to max length of inputs
|
# Mapping from model ids to max length of inputs
|
||||||
####################################################
|
####################################################
|
||||||
PRETRAINED_POSITIONAL_EMBEDDINGS_SIZES = {
|
PRETRAINED_POSITIONAL_EMBEDDINGS_SIZES = {
|
||||||
"google/reformer-crime-and-punishment": 524288,
|
"google/reformer-crime-and-punishment": 524288,
|
||||||
|
|||||||
@@ -43,7 +43,7 @@ VOCAB_FILES_NAMES = {"vocab_file": "spiece.model", "tokenizer_file": "tokenizer.
|
|||||||
|
|
||||||
####################################################
|
####################################################
|
||||||
# Mapping from the keyword arguments names of Tokenizer `__init__`
|
# Mapping from the keyword arguments names of Tokenizer `__init__`
|
||||||
# to pretrained vocabulary URL for all the model shortcut names.
|
# to pretrained vocabulary URL for all the model ids.
|
||||||
####################################################
|
####################################################
|
||||||
PRETRAINED_VOCAB_FILES_MAP = {
|
PRETRAINED_VOCAB_FILES_MAP = {
|
||||||
"vocab_file": {
|
"vocab_file": {
|
||||||
@@ -55,7 +55,7 @@ PRETRAINED_VOCAB_FILES_MAP = {
|
|||||||
}
|
}
|
||||||
|
|
||||||
####################################################
|
####################################################
|
||||||
# Mapping from model shortcut names to max length of inputs
|
# Mapping from model ids to max length of inputs
|
||||||
####################################################
|
####################################################
|
||||||
PRETRAINED_POSITIONAL_EMBEDDINGS_SIZES = {
|
PRETRAINED_POSITIONAL_EMBEDDINGS_SIZES = {
|
||||||
"google/reformer-crime-and-punishment": 524288,
|
"google/reformer-crime-and-punishment": 524288,
|
||||||
|
|||||||
@@ -50,7 +50,7 @@ _CONFIG_FOR_DOC = "T5Config"
|
|||||||
_TOKENIZER_FOR_DOC = "T5Tokenizer"
|
_TOKENIZER_FOR_DOC = "T5Tokenizer"
|
||||||
|
|
||||||
####################################################
|
####################################################
|
||||||
# This dict contains shortcut names and associated url
|
# This dict contains ids and associated url
|
||||||
# for the pretrained weights provided with the models
|
# for the pretrained weights provided with the models
|
||||||
####################################################
|
####################################################
|
||||||
T5_PRETRAINED_MODEL_ARCHIVE_LIST = [
|
T5_PRETRAINED_MODEL_ARCHIVE_LIST = [
|
||||||
|
|||||||
@@ -39,7 +39,7 @@ VOCAB_FILES_NAMES = {"vocab_file": "spiece.model"}
|
|||||||
|
|
||||||
####################################################
|
####################################################
|
||||||
# Mapping from the keyword arguments names of Tokenizer `__init__`
|
# Mapping from the keyword arguments names of Tokenizer `__init__`
|
||||||
# to pretrained vocabulary URL for all the model shortcut names.
|
# to pretrained vocabulary URL for all the model ids.
|
||||||
####################################################
|
####################################################
|
||||||
PRETRAINED_VOCAB_FILES_MAP = {
|
PRETRAINED_VOCAB_FILES_MAP = {
|
||||||
"vocab_file": {
|
"vocab_file": {
|
||||||
@@ -52,7 +52,7 @@ PRETRAINED_VOCAB_FILES_MAP = {
|
|||||||
}
|
}
|
||||||
|
|
||||||
####################################################
|
####################################################
|
||||||
# Mapping from model shortcut names to max length of inputs
|
# Mapping from model ids to max length of inputs
|
||||||
####################################################
|
####################################################
|
||||||
PRETRAINED_POSITIONAL_EMBEDDINGS_SIZES = {
|
PRETRAINED_POSITIONAL_EMBEDDINGS_SIZES = {
|
||||||
"t5-small": 512,
|
"t5-small": 512,
|
||||||
|
|||||||
@@ -42,7 +42,7 @@ VOCAB_FILES_NAMES = {"vocab_file": "spiece.model", "tokenizer_file": "tokenizer.
|
|||||||
|
|
||||||
####################################################
|
####################################################
|
||||||
# Mapping from the keyword arguments names of Tokenizer `__init__`
|
# Mapping from the keyword arguments names of Tokenizer `__init__`
|
||||||
# to pretrained vocabulary URL for all the model shortcut names.
|
# to pretrained vocabulary URL for all the model ids.
|
||||||
####################################################
|
####################################################
|
||||||
PRETRAINED_VOCAB_FILES_MAP = {
|
PRETRAINED_VOCAB_FILES_MAP = {
|
||||||
"vocab_file": {
|
"vocab_file": {
|
||||||
@@ -62,7 +62,7 @@ PRETRAINED_VOCAB_FILES_MAP = {
|
|||||||
}
|
}
|
||||||
|
|
||||||
####################################################
|
####################################################
|
||||||
# Mapping from model shortcut names to max length of inputs
|
# Mapping from model ids to max length of inputs
|
||||||
####################################################
|
####################################################
|
||||||
PRETRAINED_POSITIONAL_EMBEDDINGS_SIZES = {
|
PRETRAINED_POSITIONAL_EMBEDDINGS_SIZES = {
|
||||||
"t5-small": 512,
|
"t5-small": 512,
|
||||||
|
|||||||
@@ -1615,10 +1615,9 @@ class PreTrainedTokenizerBase(SpecialTokensMixin):
|
|||||||
pretrained_model_name_or_path (:obj:`str`):
|
pretrained_model_name_or_path (:obj:`str`):
|
||||||
Can be either:
|
Can be either:
|
||||||
|
|
||||||
- A string with the `shortcut name` of a predefined tokenizer to load from cache or download, e.g.,
|
- A string, the `model id` of a predefined tokenizer hosted inside a model repo on huggingface.co.
|
||||||
``bert-base-uncased``.
|
Valid model ids can be located at the root-level, like ``bert-base-uncased``, or namespaced under a
|
||||||
- A string with the `identifier name` of a predefined tokenizer that was user-uploaded to our S3, e.g.,
|
user or organization name, like ``dbmdz/bert-base-german-cased``.
|
||||||
``dbmdz/bert-base-german-cased``.
|
|
||||||
- A path to a `directory` containing vocabulary files required by the tokenizer, for instance saved
|
- A path to a `directory` containing vocabulary files required by the tokenizer, for instance saved
|
||||||
using the :meth:`~transformers.tokenization_utils_base.PreTrainedTokenizerBase.save_pretrained`
|
using the :meth:`~transformers.tokenization_utils_base.PreTrainedTokenizerBase.save_pretrained`
|
||||||
method, e.g., ``./my_model_directory/``.
|
method, e.g., ``./my_model_directory/``.
|
||||||
@@ -1641,6 +1640,9 @@ class PreTrainedTokenizerBase(SpecialTokensMixin):
|
|||||||
The specific model version to use. It can be a branch name, a tag name, or a commit id, since we use a
|
The specific model version to use. It can be a branch name, a tag name, or a commit id, since we use a
|
||||||
git-based system for storing models and other artifacts on huggingface.co, so ``revision`` can be any
|
git-based system for storing models and other artifacts on huggingface.co, so ``revision`` can be any
|
||||||
identifier allowed by git.
|
identifier allowed by git.
|
||||||
|
subfolder (:obj:`str`, `optional`):
|
||||||
|
In case the relevant files are located inside a subfolder of the model repo on huggingface.co (e.g. for
|
||||||
|
facebook/rag-token-base), specify it here.
|
||||||
inputs (additional positional arguments, `optional`):
|
inputs (additional positional arguments, `optional`):
|
||||||
Will be passed along to the Tokenizer ``__init__`` method.
|
Will be passed along to the Tokenizer ``__init__`` method.
|
||||||
kwargs (additional keyword arguments, `optional`):
|
kwargs (additional keyword arguments, `optional`):
|
||||||
@@ -1651,10 +1653,10 @@ class PreTrainedTokenizerBase(SpecialTokensMixin):
|
|||||||
Examples::
|
Examples::
|
||||||
|
|
||||||
# We can't instantiate directly the base class `PreTrainedTokenizerBase` so let's show our examples on a derived class: BertTokenizer
|
# We can't instantiate directly the base class `PreTrainedTokenizerBase` so let's show our examples on a derived class: BertTokenizer
|
||||||
# Download vocabulary from S3 and cache.
|
# Download vocabulary from huggingface.co and cache.
|
||||||
tokenizer = BertTokenizer.from_pretrained('bert-base-uncased')
|
tokenizer = BertTokenizer.from_pretrained('bert-base-uncased')
|
||||||
|
|
||||||
# Download vocabulary from S3 (user-uploaded) and cache.
|
# Download vocabulary from huggingface.co (user-uploaded) and cache.
|
||||||
tokenizer = BertTokenizer.from_pretrained('dbmdz/bert-base-german-cased')
|
tokenizer = BertTokenizer.from_pretrained('dbmdz/bert-base-german-cased')
|
||||||
|
|
||||||
# If vocabulary files are in a directory (e.g. tokenizer was saved using `save_pretrained('./test/saved_model/')`)
|
# If vocabulary files are in a directory (e.g. tokenizer was saved using `save_pretrained('./test/saved_model/')`)
|
||||||
@@ -1676,6 +1678,7 @@ class PreTrainedTokenizerBase(SpecialTokensMixin):
|
|||||||
proxies = kwargs.pop("proxies", None)
|
proxies = kwargs.pop("proxies", None)
|
||||||
local_files_only = kwargs.pop("local_files_only", False)
|
local_files_only = kwargs.pop("local_files_only", False)
|
||||||
revision = kwargs.pop("revision", None)
|
revision = kwargs.pop("revision", None)
|
||||||
|
subfolder = kwargs.pop("subfolder", None)
|
||||||
|
|
||||||
s3_models = list(cls.max_model_input_sizes.keys())
|
s3_models = list(cls.max_model_input_sizes.keys())
|
||||||
vocab_files = {}
|
vocab_files = {}
|
||||||
@@ -1722,13 +1725,20 @@ class PreTrainedTokenizerBase(SpecialTokensMixin):
|
|||||||
# Look for the tokenizer files
|
# Look for the tokenizer files
|
||||||
for file_id, file_name in {**cls.vocab_files_names, **additional_files_names}.items():
|
for file_id, file_name in {**cls.vocab_files_names, **additional_files_names}.items():
|
||||||
if os.path.isdir(pretrained_model_name_or_path):
|
if os.path.isdir(pretrained_model_name_or_path):
|
||||||
|
if subfolder is not None:
|
||||||
|
full_file_name = os.path.join(pretrained_model_name_or_path, subfolder, file_name)
|
||||||
|
else:
|
||||||
full_file_name = os.path.join(pretrained_model_name_or_path, file_name)
|
full_file_name = os.path.join(pretrained_model_name_or_path, file_name)
|
||||||
if not os.path.exists(full_file_name):
|
if not os.path.exists(full_file_name):
|
||||||
logger.info("Didn't find file {}. We won't load it.".format(full_file_name))
|
logger.info("Didn't find file {}. We won't load it.".format(full_file_name))
|
||||||
full_file_name = None
|
full_file_name = None
|
||||||
else:
|
else:
|
||||||
full_file_name = hf_bucket_url(
|
full_file_name = hf_bucket_url(
|
||||||
pretrained_model_name_or_path, filename=file_name, revision=revision, mirror=None
|
pretrained_model_name_or_path,
|
||||||
|
filename=file_name,
|
||||||
|
subfolder=subfolder,
|
||||||
|
revision=revision,
|
||||||
|
mirror=None,
|
||||||
)
|
)
|
||||||
|
|
||||||
vocab_files[file_id] = full_file_name
|
vocab_files[file_id] = full_file_name
|
||||||
|
|||||||
@@ -75,7 +75,7 @@ class ModelArguments:
|
|||||||
default=None, metadata={"help": "Pretrained tokenizer name or path if not the same as model_name"}
|
default=None, metadata={"help": "Pretrained tokenizer name or path if not the same as model_name"}
|
||||||
)
|
)
|
||||||
cache_dir: Optional[str] = field(
|
cache_dir: Optional[str] = field(
|
||||||
default=None, metadata={"help": "Where do you want to store the pretrained models downloaded from s3"}
|
default=None, metadata={"help": "Where do you want to store the pretrained models downloaded from huggingface.co"}
|
||||||
)
|
)
|
||||||
use_fast_tokenizer: bool = field(
|
use_fast_tokenizer: bool = field(
|
||||||
default=True,
|
default=True,
|
||||||
@@ -98,7 +98,7 @@ class ModelArguments:
|
|||||||
default=None, metadata={"help": "Pretrained tokenizer name or path if not the same as model_name"}
|
default=None, metadata={"help": "Pretrained tokenizer name or path if not the same as model_name"}
|
||||||
)
|
)
|
||||||
cache_dir: Optional[str] = field(
|
cache_dir: Optional[str] = field(
|
||||||
default=None, metadata={"help": "Where do you want to store the pretrained models downloaded from s3"}
|
default=None, metadata={"help": "Where do you want to store the pretrained models downloaded from huggingface.co"}
|
||||||
)
|
)
|
||||||
use_fast_tokenizer: bool = field(
|
use_fast_tokenizer: bool = field(
|
||||||
default=True,
|
default=True,
|
||||||
|
|||||||
Reference in New Issue
Block a user