Align backbone stage selection with out_indices & out_features (#27606)

* Iteratre over out_features instead of stage_names

* Update for all backbones

* Add tests

* Fix

* Align timm backbone behaviour with other backbones

* Fix tests

* Stricter checks on set out_features and out_indices

* Revert back stage selection logic

* Remove out-of-order logic

* Document restriction in docstrings

tests/test_backbone_common.py

@@ -201,3 +201,27 @@ class BackboneTesterMixin:
             if self.has_attentions:
                 outputs = backbone(**inputs_dict, output_attentions=True)
                 self.assertIsNotNone(outputs.attentions)
+
+    def test_backbone_stage_selection(self):
+        config, inputs_dict = self.model_tester.prepare_config_and_inputs_for_common()
+        batch_size = inputs_dict["pixel_values"].shape[0]
+
+        for backbone_class in self.all_model_classes:
+            config.out_indices = [-2, -1]
+            backbone = backbone_class(config)
+            backbone.to(torch_device)
+            backbone.eval()
+
+            outputs = backbone(**inputs_dict)
+
+            # Test number of feature maps returned
+            self.assertIsInstance(outputs.feature_maps, tuple)
+            self.assertTrue(len(outputs.feature_maps) == 2)
+
+            # Order of channels returned is same as order of channels iterating over stage names
+            channels_from_stage_names = [
+                backbone.out_feature_channels[name] for name in backbone.stage_names if name in backbone.out_features
+            ]
+            self.assertEqual(backbone.channels, channels_from_stage_names)
+            for feature_map, n_channels in zip(outputs.feature_maps, backbone.channels):
+                self.assertTrue(feature_map.shape[:2], (batch_size, n_channels))

tests/utils/test_backbone_utils.py

@@ -14,6 +14,8 @@
 
 import unittest
 
+import pytest
+
 from transformers.utils.backbone_utils import (
     BackboneMixin,
     get_aligned_output_features_output_indices,
@@ -47,37 +49,61 @@ class BackboneUtilsTester(unittest.TestCase):
 
     def test_verify_out_features_out_indices(self):
         # Stage names must be set
-        with self.assertRaises(ValueError):
+        with pytest.raises(ValueError, match="Stage_names must be set for transformers backbones"):
             verify_out_features_out_indices(["a", "b"], (0, 1), None)
 
         # Out features must be a list
-        with self.assertRaises(ValueError):
+        with pytest.raises(ValueError, match="out_features must be a list got <class 'tuple'>"):
             verify_out_features_out_indices(("a", "b"), (0, 1), ["a", "b"])
 
         # Out features must be a subset of stage names
-        with self.assertRaises(ValueError):
+        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"])
 
+        # 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 self.assertRaises(ValueError):
+        with pytest.raises(ValueError, match="out_indices must be a list or tuple, got <class 'int'>"):
             verify_out_features_out_indices(None, 0, ["a", "b"])
 
         # Out indices must be a subset of stage names
-        with self.assertRaises(ValueError):
+        with pytest.raises(
+            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"])
 
+        # 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"])
+
         # Out features and out indices must be the same length
-        with self.assertRaises(ValueError):
+        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"])
 
         # Out features should match out indices
-        with self.assertRaises(ValueError):
+        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"])
 
         # Out features and out indices should be in order
-        with self.assertRaises(ValueError):
+        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"])
 
+        with pytest.raises(
+            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"])
+
         # Check passes with valid inputs
         verify_out_features_out_indices(["a", "b", "d"], (0, 1, -1), ["a", "b", "c", "d"])