mirror of
https://github.com/huggingface/transformers.git
synced 2025-07-17 03:28:22 +06:00

* Add API to register a new object in auto classes * Fix test * Documentation * Add to tokenizers and test * Add cleanup after tests * Be more careful * Move import * Move import * Cleanup in TF test too * Add consistency check * Add documentation * Style * Update docs/source/model_doc/auto.rst Co-authored-by: Lysandre Debut <lysandre@huggingface.co> * Update src/transformers/models/auto/auto_factory.py Co-authored-by: Lysandre Debut <lysandre@huggingface.co> Co-authored-by: Lysandre Debut <lysandre@huggingface.co>
80 lines
3.2 KiB
Python
80 lines
3.2 KiB
Python
# coding=utf-8
|
|
# Copyright 2019-present, the HuggingFace Inc. team.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
import os
|
|
import tempfile
|
|
import unittest
|
|
|
|
from transformers.models.auto.configuration_auto import CONFIG_MAPPING, AutoConfig
|
|
from transformers.models.bert.configuration_bert import BertConfig
|
|
from transformers.models.roberta.configuration_roberta import RobertaConfig
|
|
from transformers.testing_utils import DUMMY_UNKNOWN_IDENTIFIER
|
|
|
|
|
|
SAMPLE_ROBERTA_CONFIG = os.path.join(os.path.dirname(os.path.abspath(__file__)), "fixtures/dummy-config.json")
|
|
|
|
|
|
class NewModelConfig(BertConfig):
|
|
model_type = "new-model"
|
|
|
|
|
|
class AutoConfigTest(unittest.TestCase):
|
|
def test_config_from_model_shortcut(self):
|
|
config = AutoConfig.from_pretrained("bert-base-uncased")
|
|
self.assertIsInstance(config, BertConfig)
|
|
|
|
def test_config_model_type_from_local_file(self):
|
|
config = AutoConfig.from_pretrained(SAMPLE_ROBERTA_CONFIG)
|
|
self.assertIsInstance(config, RobertaConfig)
|
|
|
|
def test_config_model_type_from_model_identifier(self):
|
|
config = AutoConfig.from_pretrained(DUMMY_UNKNOWN_IDENTIFIER)
|
|
self.assertIsInstance(config, RobertaConfig)
|
|
|
|
def test_config_for_model_str(self):
|
|
config = AutoConfig.for_model("roberta")
|
|
self.assertIsInstance(config, RobertaConfig)
|
|
|
|
def test_pattern_matching_fallback(self):
|
|
"""
|
|
In cases where config.json doesn't include a model_type,
|
|
perform a few safety checks on the config mapping's order.
|
|
"""
|
|
# no key string should be included in a later key string (typical failure case)
|
|
keys = list(CONFIG_MAPPING.keys())
|
|
for i, key in enumerate(keys):
|
|
self.assertFalse(any(key in later_key for later_key in keys[i + 1 :]))
|
|
|
|
def test_new_config_registration(self):
|
|
try:
|
|
AutoConfig.register("new-model", NewModelConfig)
|
|
# Wrong model type will raise an error
|
|
with self.assertRaises(ValueError):
|
|
AutoConfig.register("model", NewModelConfig)
|
|
# Trying to register something existing in the Transformers library will raise an error
|
|
with self.assertRaises(ValueError):
|
|
AutoConfig.register("bert", BertConfig)
|
|
|
|
# Now that the config is registered, it can be used as any other config with the auto-API
|
|
config = NewModelConfig()
|
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
|
config.save_pretrained(tmp_dir)
|
|
new_config = AutoConfig.from_pretrained(tmp_dir)
|
|
self.assertIsInstance(new_config, NewModelConfig)
|
|
|
|
finally:
|
|
if "new-model" in CONFIG_MAPPING._extra_content:
|
|
del CONFIG_MAPPING._extra_content["new-model"]
|