1# Copyright 2019 The TensorFlow Authors. All Rights Reserved. 2# 3# Licensed under the Apache License, Version 2.0 (the "License"); 4# you may not use this file except in compliance with the License. 5# You may obtain a copy of the License at 6# 7# http://www.apache.org/licenses/LICENSE-2.0 8# 9# Unless required by applicable law or agreed to in writing, software 10# distributed under the License is distributed on an "AS IS" BASIS, 11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12# See the License for the specific language governing permissions and 13# limitations under the License. 14# ============================================================================== 15"""Tests for `tf.Module`.""" 16 17import abc 18import collections 19import itertools 20 21from absl.testing import parameterized 22 23from tensorflow.python import tf2 24from tensorflow.python.distribute import ps_values 25from tensorflow.python.distribute import tpu_values 26from tensorflow.python.distribute import values as distributed_values 27from tensorflow.python.eager import context 28from tensorflow.python.eager import def_function 29from tensorflow.python.framework import composite_tensor 30from tensorflow.python.framework import ops 31from tensorflow.python.framework import test_util 32from tensorflow.python.framework import type_spec 33from tensorflow.python.module import module 34from tensorflow.python.ops import variables 35from tensorflow.python.platform import test 36 37 38class TestModuleNaming(test_util.TensorFlowTestCase): 39 40 def test_single_name(self): 41 mod = module.Module(name="simple") 42 self.assertEqual(mod.name, "simple") 43 self.assertEqual(mod.name_scope.name, "simple/") 44 45 def test_construct_in_scope(self): 46 with ops.name_scope("foo", skip_on_eager=False): 47 mod = module.Module(name="bar") 48 self.assertEqual(mod.name, "bar") 49 self.assertEqual(mod.name_scope.name, "foo/bar/") 50 51 def test_enters_name_scope_in_call(self): 52 mod = ReturnsNameScopeModule() 53 for _ in range(3): 54 self.assertEqual(mod(), mod.name_scope.name) 55 56 def test_enters_name_scope_in_other_method(self): 57 mod = ReturnsNameScopeModule() 58 for _ in range(3): 59 self.assertEqual(mod.alternative_forward(), mod.name_scope.name) 60 61 def test_subclassed_module(self): 62 mod = SubclassedReturnsNameScopeModule() 63 for _ in range(3): 64 self.assertEqual(mod.alternative_forward(), mod.name_scope.name) 65 self.assertEqual(mod.alternative_alternative_forward(), 66 mod.name_scope.name) 67 68 def test_submodule_created_late(self): 69 m = TreeModule() 70 self.assertEqual(m.name, "tree_module") 71 self.assertEqual(m.name_scope.name, "tree_module/") 72 leaf1 = m.new_leaf() 73 self.assertEqual(leaf1.name, "tree_module") 74 self.assertEqual(leaf1.name_scope.name, "tree_module/tree_module/") 75 76 def test_does_not_evaluate_property_methods(self): 77 mod = PropertyThrowsWhenCalledModule() 78 with self.assertRaises(AssertionError): 79 mod.raise_assertion_error # pylint: disable=pointless-statement 80 81 def test_overridden_name_scope(self): 82 mod = ModuleOverridingNameScope() 83 self.assertEqual(mod(), mod.name_scope.name) 84 self.assertEqual(mod.alternative_forward(), mod.name_scope.name) 85 86 def test_patched_callable(self): 87 with ops.name_scope("foo", skip_on_eager=False): 88 mod = module.Module(name="bar") 89 mod.foo = get_name_scope 90 # `foo` is not a method so we do not re-enter the name scope. 91 self.assertEqual(mod.foo(), "") 92 93 def test_property(self): 94 mod = PropertyModule() 95 mod.some_property = None, None # None, None for the linter. 96 getter_scope_name, setter_scope_name = mod.some_property 97 self.assertEqual(getter_scope_name, "property_module/") 98 self.assertEqual(setter_scope_name, "property_module/") 99 100 def test_property_no_name_scope(self): 101 mod = PropertyModule() 102 mod.no_name_scope_property = None, None # None, None for the linter. 103 getter_scope_name, setter_scope_name = mod.no_name_scope_property 104 self.assertEqual(getter_scope_name, "") 105 self.assertEqual(setter_scope_name, "") 106 107 def test_invalid_name(self): 108 msg = ".* is not a valid module name" 109 with self.assertRaisesRegex(ValueError, msg): 110 module.Module(name="$Foo") 111 112 @test_util.run_in_graph_and_eager_modes 113 def test_modules_not_numbered_in_eager(self): 114 if not context.executing_eagerly(): 115 self.skipTest("Eager specific") 116 117 mod = RecursiveModule(2) 118 self.assertEqual(mod.name_scope.name, "badger/") 119 self.assertEqual(mod.child.name_scope.name, "badger/badger/") 120 121 mod = RecursiveModule(2) 122 self.assertEqual(mod.name_scope.name, "badger/") 123 self.assertEqual(mod.child.name_scope.name, "badger/badger/") 124 125 @test_util.run_in_graph_and_eager_modes 126 def test_module_numbering_in_graph(self): 127 if context.executing_eagerly(): 128 self.skipTest("Graph specific") 129 130 mod = RecursiveModule(2) 131 self.assertEqual(mod.name_scope.name, "badger/") 132 self.assertEqual(mod.child.name_scope.name, "badger/badger/") 133 134 mod = RecursiveModule(2) 135 self.assertEqual(mod.name_scope.name, "badger_1/") 136 self.assertEqual(mod.child.name_scope.name, "badger_1/badger/") 137 138 def test_ctor_error_closes_name_scope(self): 139 with self.assertRaises(ErrorModuleError): 140 # If super constructor is called then a name scope is opened then an error 141 # is thrown. The metaclass should handle this and close the namescope 142 # before re-throwing the exception. 143 ErrorModule(call_super=True) 144 145 self.assertEqual("", get_name_scope()) 146 147 def test_ctor_error_handles_ctor_not_opening_name_scope(self): 148 with self.assertRaises(ErrorModuleError): 149 # If super ctor is not called then the name scope isn't opened. We need to 150 # ensure that this doesn't trigger an exception (e.g. the metaclass trying 151 # to __exit__ a non-existent name scope). 152 ErrorModule(call_super=False) 153 154 self.assertEqual("", get_name_scope()) 155 156 def test_forward_method_closes_name_scope(self): 157 mod = ErrorModule(call_super=True, raise_in_constructor=False) 158 with self.assertRaises(ErrorModuleError): 159 mod() 160 161 self.assertEqual("", get_name_scope()) 162 163 def test_get_attr_doesnt_enter_name_scope(self): 164 scope_names = [] 165 166 class GetAttrModule(module.Module): 167 168 def __getattr__(self, name): 169 scope_names.append((name, get_name_scope())) 170 return super().__getattr__(name) 171 172 mod = GetAttrModule() 173 with self.assertRaises(AttributeError): 174 mod.does_not_exist # pylint: disable=pointless-statement 175 self.assertIn(("does_not_exist", ""), scope_names) 176 177 def test_get_attribute_doesnt_enter_name_scope(self): 178 scope_names = [] 179 180 class GetAttributeModule(module.Module): 181 182 def __getattribute__(self, name): 183 scope_names.append((name, get_name_scope())) 184 return super().__getattribute__(name) 185 186 mod = GetAttributeModule() 187 with self.assertRaises(AttributeError): 188 mod.does_not_exist # pylint: disable=pointless-statement 189 self.assertIn(("does_not_exist", ""), scope_names) 190 191 192class VariableNamingTest(test_util.TensorFlowTestCase): 193 194 def test_variable_names(self): 195 mod = RecursiveModule(3) 196 self.assertEqual(mod.w.name, "badger/mushroom:0") 197 self.assertEqual(mod.child.w.name, "badger/badger/mushroom:0") 198 self.assertEqual(mod.child.child.w.name, "badger/badger/badger/mushroom:0") 199 200 201class NameScopeTest(test_util.TensorFlowTestCase): 202 203 @test_util.run_deprecated_v1 204 def test_not_memoized_in_tf1(self): 205 if tf2.enabled(): 206 self.skipTest("Requires TF1") 207 208 mod = module.Module(name="name") 209 name_scope_1 = mod.name_scope 210 name_scope_2 = mod.name_scope 211 self.assertIsNot(name_scope_1, name_scope_2) 212 self.assertEqual(name_scope_1.name, name_scope_2.name) 213 214 def test_memoized_in_tf2(self): 215 if not tf2.enabled(): 216 self.skipTest("Requires TF2") 217 218 mod = module.Module(name="name") 219 name_scope_1 = mod.name_scope 220 name_scope_2 = mod.name_scope 221 self.assertIs(name_scope_1, name_scope_2) 222 223 224class VariableTrackingTest(test_util.TensorFlowTestCase): 225 226 def test_variables(self): 227 m = RecursiveModule(3) 228 self.assertEqual(m.variables, (m.w, m.child.w, m.child.child.w)) 229 self.assertEqual(m.child.variables, (m.child.w, m.child.child.w)) 230 self.assertEqual(m.child.child.variables, (m.child.child.w,)) 231 232 def test_trainable_variables(self): 233 m = RecursiveModule(3) 234 self.assertEqual(m.trainable_variables, 235 (m.w, m.child.w, m.child.child.w)) 236 self.assertEqual(m.child.trainable_variables, 237 (m.child.w, m.child.child.w)) 238 self.assertEqual(m.child.child.trainable_variables, (m.child.child.w,)) 239 240 def test_trainable_variables_ignores_non_trainable(self): 241 m = RecursiveModule(3, trainable=False) 242 self.assertEqual(len(m.trainable_variables), 0) 243 self.assertEqual(len(m.child.trainable_variables), 0) 244 self.assertEqual(len(m.child.child.trainable_variables), 0) 245 246 def test_supports_distributed_variables(self): 247 mirrored = distributed_values.MirroredVariable( 248 None, [variables.Variable(1.)], variables.VariableAggregation.SUM) 249 tpu = tpu_values.TPUMirroredVariable( 250 strategy=None, values=[variables.Variable(42.)], aggregation=None) 251 aggregating = ps_values.AggregatingVariable( 252 strategy=None, v=variables.Variable(1.), aggregation=None) 253 254 m = module.Module() 255 m.a = mirrored 256 m.b = tpu 257 m.c = aggregating 258 self.assertEqual(m.variables, (mirrored, tpu, aggregating)) 259 260 def test_composite_variable(self): 261 262 class Spec(type_spec.TypeSpec): 263 264 value_type = property(lambda self: CompositeVariable) 265 266 def _component_specs(self): 267 pass 268 269 def _serialize(self): 270 pass 271 272 def _to_components(self, value): 273 return value._variables 274 275 def _from_components(self, variable_list): 276 return CompositeVariable(variable_list) 277 278 class CompositeVariable(composite_tensor.CompositeTensor): 279 280 def __init__(self, variable_list): 281 self._variables = variable_list 282 283 @property 284 def _type_spec(self): 285 return Spec() 286 287 m = module.Module() 288 m.a = CompositeVariable([variables.Variable(1.), variables.Variable(2.)]) 289 self.assertEqual(list(m.variables), list(m.a._variables)) 290 291 292class ModuleTrackingTest(test_util.TensorFlowTestCase): 293 294 def test_submodules(self): 295 m = RecursiveModule(3) 296 self.assertEqual(list(m.submodules), [m.child, m.child.child]) 297 self.assertEqual(list(m.child.submodules), [m.child.child]) 298 self.assertEqual(list(m.child.child.submodules), []) 299 300 def test_non_ctor_submodule(self): 301 m = TreeModule() 302 leaf1 = m.new_leaf() 303 self.assertEqual(set(m.submodules), {leaf1}) 304 leaf2 = m.new_leaf() 305 self.assertEqual(set(m.submodules), {leaf1, leaf2}) 306 307 308class ForwardMethodsTest(test_util.TensorFlowTestCase): 309 310 def testFunctionType(self): 311 mod = ModuleWithFunctionAnnotatedCall() 312 self.assertIsInstance(mod.forward, def_function.Function) 313 self.assertIsInstance(mod.forward_ag, def_function.Function) 314 315 def testEntersNameScope_call(self): 316 mod = ModuleWithFunctionAnnotatedCall() 317 self.assertEqual(self.evaluate(mod.forward()), 318 b"module_with_function_annotated_call/") 319 self.assertEqual(self.evaluate(mod.forward_ag()), 320 b"module_with_function_annotated_call/") 321 322 def testEntersNameScope_concreteFunction(self): 323 mod = ModuleWithFunctionAnnotatedCall() 324 self.assertEqual(self.evaluate(mod.forward.get_concrete_function()()), 325 b"module_with_function_annotated_call/") 326 self.assertEqual(self.evaluate(mod.forward_ag.get_concrete_function()()), 327 b"module_with_function_annotated_call/") 328 329 330class AbcTest(test_util.TensorFlowTestCase): 331 332 def testAbstract(self): 333 msg = "Can't instantiate.*abstract" 334 with self.assertRaisesRegex(TypeError, msg): 335 AbstractModule() # pylint: disable=abstract-class-instantiated 336 337 def testConcrete(self): 338 mod = ConcreteModule() 339 x, scope_name = mod(2.) 340 self.assertEqual(x, 4.) 341 self.assertEqual(scope_name, "concrete_module/") 342 self.assertEqual(get_name_scope(), "") 343 344 345def get_name_scope(): 346 with ops.name_scope("x", skip_on_eager=False) as ns: 347 ns = "/".join(ns.split("/")[:-2]) 348 return ns + "/" if ns else "" 349 350 351class ErrorModuleError(Exception): 352 pass 353 354 355class ErrorModule(module.Module): 356 357 def __init__(self, call_super, raise_in_constructor=True): 358 if call_super: 359 super().__init__() 360 if raise_in_constructor: 361 raise ErrorModuleError("Deliberate error!") 362 363 def __call__(self): 364 raise ErrorModuleError("Deliberate error!") 365 366 367class RecursiveModule(module.Module): 368 369 def __init__(self, depth, trainable=True): 370 super().__init__(name="badger") 371 with self.name_scope: 372 self.child = None 373 if depth > 1: 374 self.child = RecursiveModule(depth - 1, trainable=trainable) 375 self.w = variables.Variable(1.0, trainable=trainable, name="mushroom") 376 377 378class AbstractModule(module.Module, metaclass=abc.ABCMeta): 379 380 @abc.abstractmethod 381 def __call__(self, x): 382 pass 383 384 385class ConcreteModule(AbstractModule): 386 387 @module.Module.with_name_scope 388 def __call__(self, x): 389 return x ** 2, get_name_scope() 390 391 392class TreeModule(module.Module): 393 394 def __init__(self, name=None): 395 super().__init__(name=name) 396 self._leaves = [] 397 398 @module.Module.with_name_scope 399 def new_leaf(self, name=None): 400 leaf = TreeModule(name=name) 401 self._leaves.append(leaf) 402 return leaf 403 404 405class ReturnsNameScopeModule(module.Module): 406 407 @module.Module.with_name_scope 408 def alternative_forward(self): 409 return get_name_scope() 410 411 @module.Module.with_name_scope 412 def __call__(self): 413 return get_name_scope() 414 415 416class SubclassedReturnsNameScopeModule(ReturnsNameScopeModule): 417 418 @module.Module.with_name_scope 419 def alternative_alternative_forward(self): 420 return get_name_scope() 421 422 423class PropertyThrowsWhenCalledModule(module.Module): 424 425 @property 426 def raise_assertion_error(self): 427 raise AssertionError 428 429 430class ModuleOverridingNameScope(ReturnsNameScopeModule): 431 432 @property 433 def name_scope(self): 434 return ops.name_scope("yolo/", skip_on_eager=False) 435 436 437class ModuleWithFunctionAnnotatedCall(module.Module): 438 439 @def_function.function(autograph=False) 440 @module.Module.with_name_scope 441 def forward(self): 442 return get_name_scope() 443 444 @def_function.function(autograph=True) 445 @module.Module.with_name_scope 446 def forward_ag(self): 447 return get_name_scope() 448 449 450class PropertyModule(module.Module): 451 452 def __init__(self): 453 super().__init__() 454 self._setter_scope_name = None 455 456 @property 457 @module.Module.with_name_scope 458 def some_property(self): 459 getter_scope_name = get_name_scope() 460 return getter_scope_name, self._setter_scope_name 461 462 @some_property.setter 463 @module.Module.with_name_scope 464 def some_property(self, my_property): 465 self._setter_scope_name = get_name_scope() 466 467 @property 468 def no_name_scope_property(self): 469 getter_scope_name = get_name_scope() 470 return getter_scope_name, self._setter_scope_name 471 472 @no_name_scope_property.setter 473 def no_name_scope_property(self, my_property): 474 self._setter_scope_name = get_name_scope() 475 476NamedPair = collections.namedtuple("NamedPair", ("first", "second")) 477mk_index_dict = lambda v: dict(enumerate(v)) 478 479 480class FlattenTest(parameterized.TestCase, test_util.TensorFlowTestCase): 481 482 @parameterized.parameters(lambda v: NamedPair(*v), list, tuple, mk_index_dict) 483 def test_flatten(self, container_type): 484 parent = SimpleModule(container_type=container_type) 485 child = parent.c 486 487 self.assertEqual( 488 list(parent._flatten(recursive=False, predicate=is_member)), 489 [parent.a[0], parent.a[1], parent.z]) 490 491 self.assertEqual( 492 list(parent._flatten(predicate=is_member)), 493 [parent.a[0], parent.a[1], parent.z, child.a[0], child.a[1], child.z]) 494 495 def test_attribute_traversal_key(self): 496 mod = LayerModule() 497 self.assertEqual( 498 mod.variables, 499 mod._trainable_variables + mod._non_trainable_variables + [mod._bonus]) 500 501 def test_attributes_to_ignore(self): 502 class DangerousModule(module.Module): 503 _TF_MODULE_IGNORED_PROPERTIES = frozenset(itertools.chain( 504 ("dangerous_submodule", "dangerous_variable"), 505 module.Module._TF_MODULE_IGNORED_PROPERTIES 506 )) 507 508 mod = DangerousModule() 509 mod.dangerous_submodule = module.Module() 510 mod.dangerous_variable = variables.Variable(1.) 511 mod.normal_variable = variables.Variable(2.) 512 513 self.assertEmpty(mod.submodules) 514 self.assertLen(mod.variables, 1) 515 self.assertEqual(mod.variables[0], mod.normal_variable) 516 517 def test_with_path(self): 518 mod = module.Module() 519 mod.w = variables.Variable(1.) 520 mod.encoder = module.Module() 521 mod.encoder.w = [({"k": mod.w}, {"k": mod.w})] 522 mod.decoder = mod.encoder 523 524 state_dict = dict( 525 mod._flatten(with_path=True, predicate=module._is_variable)) 526 527 self.assertEqual(state_dict, 528 {("w",): mod.w, 529 ("encoder", "w", 0, 0, "k"): mod.encoder.w[0][0]["k"], 530 ("encoder", "w", 0, 1, "k"): mod.encoder.w[0][1]["k"], 531 ("decoder", "w", 0, 0, "k"): mod.decoder.w[0][0]["k"], 532 ("decoder", "w", 0, 1, "k"): mod.decoder.w[0][1]["k"]},) 533 534 def test_cycles_with_path(self): 535 mod = module.Module() 536 mod.w = variables.Variable(1.) 537 mod.encoder = module.Module() 538 mod.encoder.w = [({"k": mod.w}, {"k": mod.w})] 539 mod.decoder = mod.encoder 540 541 # This introduces two cycles: on mod.encoder.mod and mod.decoder.mod. 542 mod.decoder.mod = mod 543 544 state_dict = dict( 545 mod._flatten(with_path=True, predicate=module._is_variable)) 546 547 self.assertEqual(state_dict, 548 {("w",): mod.w, 549 ("encoder", "mod", "w"): mod.encoder.mod.w, 550 ("decoder", "mod", "w"): mod.decoder.mod.w, 551 ("encoder", "w", 0, 0, "k"): mod.encoder.w[0][0]["k"], 552 ("encoder", "w", 0, 1, "k"): mod.encoder.w[0][1]["k"], 553 ("decoder", "w", 0, 0, "k"): mod.decoder.w[0][0]["k"], 554 ("decoder", "w", 0, 1, "k"): mod.decoder.w[0][1]["k"]},) 555 556 def test_raises_error_with_path(self): 557 non_orderable = object 558 559 m = module.Module() 560 m.layers = {non_orderable(): None, non_orderable(): None} 561 with self.assertRaisesRegex(ValueError, 562 "Error processing property 'layers'"): 563 m.variables # pylint: disable=pointless-statement 564 565 566class LayerModule(module.Module): 567 568 def __init__(self): 569 super().__init__() 570 self._trainable_variables = [ 571 variables.Variable(1., name="a"), 572 variables.Variable(2., name="b"), 573 ] 574 self._non_trainable_variables = [ 575 variables.Variable(3., name="c"), 576 variables.Variable(4., name="d"), 577 ] 578 self._bonus = variables.Variable(5., name="e") 579 580 @property 581 def variables(self): 582 def key_function(name): 583 indexes = {"_trainable_variables": 0, "_non_trainable_variables": 1} 584 return indexes.get(name, 2), name 585 586 return list( 587 self._flatten( 588 predicate=module._is_variable, 589 attribute_traversal_key=key_function)) 590 591 592class MemberType: 593 """A simple type to search for.""" 594 pass 595 596 597class SimpleModule(module.Module): 598 599 def __init__(self, create_child=True, container_type=list): 600 super().__init__() 601 self.z = MemberType() 602 self.a = container_type([MemberType(), MemberType()]) 603 if create_child: 604 self.c = SimpleModule(create_child=False) 605 606is_member = lambda v: isinstance(v, MemberType) 607 608if __name__ == "__main__": 609 test.main() 610