transformers

1
# coding=utf-8
2
# Copyright 2019 HuggingFace Inc.
3
#
4
# Licensed under the Apache License, Version 2.0 (the "License");
5
# you may not use this file except in compliance with the License.
6
# You may obtain a copy of the License at
7
#
8
#     http://www.apache.org/licenses/LICENSE-2.0
9
#
10
# Unless required by applicable law or agreed to in writing, software
11
# distributed under the License is distributed on an "AS IS" BASIS,
12
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
# See the License for the specific language governing permissions and
14
# limitations under the License.
15

16
import copy
17
import json
18
import os
19
import tempfile
20

21
from transformers import is_torch_available
22

23
from .test_configuration_utils import config_common_kwargs
24

25

26
class ConfigTester(object):
27
    def __init__(self, parent, config_class=None, has_text_modality=True, common_properties=None, **kwargs):
28
        self.parent = parent
29
        self.config_class = config_class
30
        self.has_text_modality = has_text_modality
31
        self.inputs_dict = kwargs
32
        self.common_properties = common_properties
33

34
    def create_and_test_config_common_properties(self):
35
        config = self.config_class(**self.inputs_dict)
36
        common_properties = (
37
            ["hidden_size", "num_attention_heads", "num_hidden_layers"]
38
            if self.common_properties is None
39
            else self.common_properties
40
        )
41

42
        # Add common fields for text models
43
        if self.has_text_modality:
44
            common_properties.extend(["vocab_size"])
45

46
        # Test that config has the common properties as getters
47
        for prop in common_properties:
48
            self.parent.assertTrue(hasattr(config, prop), msg=f"`{prop}` does not exist")
49

50
        # Test that config has the common properties as setter
51
        for idx, name in enumerate(common_properties):
52
            try:
53
                setattr(config, name, idx)
54
                self.parent.assertEqual(
55
                    getattr(config, name), idx, msg=f"`{name} value {idx} expected, but was {getattr(config, name)}"
56
                )
57
            except NotImplementedError:
58
                # Some models might not be able to implement setters for common_properties
59
                # In that case, a NotImplementedError is raised
60
                pass
61

62
        # Test if config class can be called with Config(prop_name=..)
63
        for idx, name in enumerate(common_properties):
64
            try:
65
                config = self.config_class(**{name: idx})
66
                self.parent.assertEqual(
67
                    getattr(config, name), idx, msg=f"`{name} value {idx} expected, but was {getattr(config, name)}"
68
                )
69
            except NotImplementedError:
70
                # Some models might not be able to implement setters for common_properties
71
                # In that case, a NotImplementedError is raised
72
                pass
73

74
    def create_and_test_config_to_json_string(self):
75
        config = self.config_class(**self.inputs_dict)
76
        obj = json.loads(config.to_json_string())
77
        for key, value in self.inputs_dict.items():
78
            self.parent.assertEqual(obj[key], value)
79

80
    def create_and_test_config_to_json_file(self):
81
        config_first = self.config_class(**self.inputs_dict)
82

83
        with tempfile.TemporaryDirectory() as tmpdirname:
84
            json_file_path = os.path.join(tmpdirname, "config.json")
85
            config_first.to_json_file(json_file_path)
86
            config_second = self.config_class.from_json_file(json_file_path)
87

88
        self.parent.assertEqual(config_second.to_dict(), config_first.to_dict())
89

90
    def create_and_test_config_from_and_save_pretrained(self):
91
        config_first = self.config_class(**self.inputs_dict)
92

93
        with tempfile.TemporaryDirectory() as tmpdirname:
94
            config_first.save_pretrained(tmpdirname)
95
            config_second = self.config_class.from_pretrained(tmpdirname)
96

97
        self.parent.assertEqual(config_second.to_dict(), config_first.to_dict())
98

99
        with self.parent.assertRaises(OSError):
100
            self.config_class.from_pretrained(f".{tmpdirname}")
101

102
    def create_and_test_config_from_and_save_pretrained_subfolder(self):
103
        config_first = self.config_class(**self.inputs_dict)
104

105
        subfolder = "test"
106
        with tempfile.TemporaryDirectory() as tmpdirname:
107
            sub_tmpdirname = os.path.join(tmpdirname, subfolder)
108
            config_first.save_pretrained(sub_tmpdirname)
109
            config_second = self.config_class.from_pretrained(tmpdirname, subfolder=subfolder)
110

111
        self.parent.assertEqual(config_second.to_dict(), config_first.to_dict())
112

113
    def create_and_test_config_with_num_labels(self):
114
        config = self.config_class(**self.inputs_dict, num_labels=5)
115
        self.parent.assertEqual(len(config.id2label), 5)
116
        self.parent.assertEqual(len(config.label2id), 5)
117

118
        config.num_labels = 3
119
        self.parent.assertEqual(len(config.id2label), 3)
120
        self.parent.assertEqual(len(config.label2id), 3)
121

122
    def check_config_can_be_init_without_params(self):
123
        if self.config_class.is_composition:
124
            with self.parent.assertRaises(ValueError):
125
                config = self.config_class()
126
        else:
127
            config = self.config_class()
128
            self.parent.assertIsNotNone(config)
129

130
    def check_config_arguments_init(self):
131
        kwargs = copy.deepcopy(config_common_kwargs)
132
        config = self.config_class(**kwargs)
133
        wrong_values = []
134
        for key, value in config_common_kwargs.items():
135
            if key == "torch_dtype":
136
                if not is_torch_available():
137
                    continue
138
                else:
139
                    import torch
140

141
                    if config.torch_dtype != torch.float16:
142
                        wrong_values.append(("torch_dtype", config.torch_dtype, torch.float16))
143
            elif getattr(config, key) != value:
144
                wrong_values.append((key, getattr(config, key), value))
145

146
        if len(wrong_values) > 0:
147
            errors = "\n".join([f"- {v[0]}: got {v[1]} instead of {v[2]}" for v in wrong_values])
148
            raise ValueError(f"The following keys were not properly set in the config:\n{errors}")
149

150
    def run_common_tests(self):
151
        self.create_and_test_config_common_properties()
152
        self.create_and_test_config_to_json_string()
153
        self.create_and_test_config_to_json_file()
154
        self.create_and_test_config_from_and_save_pretrained()
155
        self.create_and_test_config_from_and_save_pretrained_subfolder()
156
        self.create_and_test_config_with_num_labels()
157
        self.check_config_can_be_init_without_params()
158
        self.check_config_arguments_init()
159