diff --git a/src/transformers/utils/backbone_utils.py b/src/transformers/utils/backbone_utils.py index 6f72494ad839c2..8a265375b6eb03 100644 --- a/src/transformers/utils/backbone_utils.py +++ b/src/transformers/utils/backbone_utils.py @@ -47,8 +47,8 @@ def verify_out_features_out_indices( ) if out_indices is not None: - if not isinstance(out_indices, (list, tuple)): - raise ValueError(f"out_indices must be a list or tuple, got {type(out_indices)}") + if not isinstance(out_indices, list): + raise ValueError(f"out_indices must be a list, got {type(out_indices)}") # Convert negative indices to their positive equivalent: [-1,] -> [len(stage_names) - 1,] positive_indices = tuple(idx % len(stage_names) if idx < 0 else idx for idx in out_indices) if any(idx for idx in positive_indices if idx not in range(len(stage_names))): @@ -58,7 +58,7 @@ def verify_out_features_out_indices( msg += f"(equivalent to {positive_indices}))" if positive_indices != out_indices else "" raise ValueError(msg) if positive_indices != tuple(sorted(positive_indices)): - sorted_negative = tuple(idx for _, idx in sorted(zip(positive_indices, out_indices), key=lambda x: x[0])) + sorted_negative = [idx for _, idx in sorted(zip(positive_indices, out_indices), key=lambda x: x[0])] raise ValueError( f"out_indices must be in the same order as stage_names, expected {sorted_negative} got {out_indices}" ) @@ -122,6 +122,7 @@ def get_aligned_output_features_output_indices( out_indices (`List[int]` or `Tuple[int]`): The indices of the features for the backbone to output. stage_names (`List[str]`): The names of the stages of the backbone. """ + out_indices = list(out_indices) if out_indices is not None else None # First verify that the out_features and out_indices are valid verify_out_features_out_indices(out_features=out_features, out_indices=out_indices, stage_names=stage_names) output_features, output_indices = _align_output_features_output_indices( @@ -147,7 +148,10 @@ def _init_timm_backbone(self, config) -> None: # the timm model has out_features = ['act', 'layer1', 'layer2', 'layer3', 'layer4'] self.stage_names = [stage["module"] for stage in self._backbone.feature_info.info] self.num_features = [stage["num_chs"] for stage in self._backbone.feature_info.info] - out_indices = self._backbone.feature_info.out_indices + + # In some timm versions, out_indices reflects the input type of out_indices on the `create_model` call, + # in later versions >= 1, it is always a tuple + out_indices = list(self._backbone.feature_info.out_indices) out_features = self._backbone.feature_info.module_name() # We verify the out indices and out features are valid diff --git a/tests/models/timm_backbone/test_modeling_timm_backbone.py b/tests/models/timm_backbone/test_modeling_timm_backbone.py index 1cd04cd4843933..3926ae983b35c7 100644 --- a/tests/models/timm_backbone/test_modeling_timm_backbone.py +++ b/tests/models/timm_backbone/test_modeling_timm_backbone.py @@ -131,7 +131,7 @@ def test_timm_transformer_backbone_equivalence(self): # Out indices are set to the last layer by default. For timm models, we don't know # the number of layers in advance, so we set it to (-1,), whereas for transformers # models, we set it to [len(stage_names) - 1] (kept for backward compatibility). - self.assertEqual(timm_model.out_indices, (-1,)) + self.assertEqual(timm_model.out_indices, [-1]) self.assertEqual(transformers_model.out_indices, [len(timm_model.stage_names) - 1]) timm_model = AutoBackbone.from_pretrained(timm_checkpoint, use_timm_backbone=True, out_indices=[1, 2, 3]) diff --git a/tests/utils/test_backbone_utils.py b/tests/utils/test_backbone_utils.py index cd9a5a29a8c071..2e1242e4202835 100644 --- a/tests/utils/test_backbone_utils.py +++ b/tests/utils/test_backbone_utils.py @@ -70,52 +70,55 @@ def test_verify_out_features_out_indices(self): with pytest.raises( ValueError, match=r"out_features must be a subset of stage_names: \['a'\] got \['a', 'b'\]" ): - verify_out_features_out_indices(["a", "b"], (0, 1), ["a"]) + verify_out_features_out_indices(["a", "b"], [0, 1], ["a"]) # Out features must contain no duplicates with pytest.raises(ValueError, match=r"out_features must not contain any duplicates, got \['a', 'a'\]"): verify_out_features_out_indices(["a", "a"], None, ["a"]) - # Out indices must be a list or tuple - with pytest.raises(ValueError, match="out_indices must be a list or tuple, got "): + # Out indices must be a list + with pytest.raises(ValueError, match="out_indices must be a list, got "): verify_out_features_out_indices(None, 0, ["a", "b"]) + with pytest.raises(ValueError, match="out_indices must be a list, got "): + verify_out_features_out_indices(None, (0, 1), ["a", "b"]) + # Out indices must be a subset of stage names with pytest.raises( - ValueError, match=r"out_indices must be valid indices for stage_names \['a'\], got \(0, 1\)" + ValueError, match=r"out_indices must be valid indices for stage_names \['a'\], got \[0, 1\]" ): - verify_out_features_out_indices(None, (0, 1), ["a"]) + verify_out_features_out_indices(None, [0, 1], ["a"]) # Out indices must contain no duplicates - with pytest.raises(ValueError, match=r"out_indices must not contain any duplicates, got \(0, 0\)"): - verify_out_features_out_indices(None, (0, 0), ["a"]) + with pytest.raises(ValueError, match=r"out_indices must not contain any duplicates, got \[0, 0\]"): + verify_out_features_out_indices(None, [0, 0], ["a"]) # Out features and out indices must be the same length with pytest.raises( ValueError, match="out_features and out_indices should have the same length if both are set" ): - verify_out_features_out_indices(["a", "b"], (0,), ["a", "b", "c"]) + verify_out_features_out_indices(["a", "b"], [0], ["a", "b", "c"]) # Out features should match out indices with pytest.raises( ValueError, match="out_features and out_indices should correspond to the same stages if both are set" ): - verify_out_features_out_indices(["a", "b"], (0, 2), ["a", "b", "c"]) + verify_out_features_out_indices(["a", "b"], [0, 2], ["a", "b", "c"]) # Out features and out indices should be in order with pytest.raises( ValueError, match=r"out_features must be in the same order as stage_names, expected \['a', 'b'\] got \['b', 'a'\]", ): - verify_out_features_out_indices(["b", "a"], (0, 1), ["a", "b"]) + verify_out_features_out_indices(["b", "a"], [0, 1], ["a", "b"]) with pytest.raises( - ValueError, match=r"out_indices must be in the same order as stage_names, expected \(-2, 1\) got \(1, -2\)" + ValueError, match=r"out_indices must be in the same order as stage_names, expected \[-2, 1\] got \[1, -2\]" ): - verify_out_features_out_indices(["a", "b"], (1, -2), ["a", "b"]) + verify_out_features_out_indices(["a", "b"], [1, -2], ["a", "b"]) # Check passes with valid inputs - verify_out_features_out_indices(["a", "b", "d"], (0, 1, -1), ["a", "b", "c", "d"]) + verify_out_features_out_indices(["a", "b", "d"], [0, 1, -1], ["a", "b", "c", "d"]) def test_backbone_mixin(self): backbone = BackboneMixin()