configuration_dinat.py 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152
  1. # coding=utf-8
  2. # Copyright 2022 The HuggingFace Inc. team. All rights reserved.
  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. """Dilated Neighborhood Attention Transformer model configuration"""
  16. from ...configuration_utils import PretrainedConfig
  17. from ...utils import logging
  18. from ...utils.backbone_utils import BackboneConfigMixin, get_aligned_output_features_output_indices
  19. logger = logging.get_logger(__name__)
  20. class DinatConfig(BackboneConfigMixin, PretrainedConfig):
  21. r"""
  22. This is the configuration class to store the configuration of a [`DinatModel`]. It is used to instantiate a Dinat
  23. model according to the specified arguments, defining the model architecture. Instantiating a configuration with the
  24. defaults will yield a similar configuration to that of the Dinat
  25. [shi-labs/dinat-mini-in1k-224](https://huggingface.co/shi-labs/dinat-mini-in1k-224) architecture.
  26. Configuration objects inherit from [`PretrainedConfig`] and can be used to control the model outputs. Read the
  27. documentation from [`PretrainedConfig`] for more information.
  28. Args:
  29. patch_size (`int`, *optional*, defaults to 4):
  30. The size (resolution) of each patch. NOTE: Only patch size of 4 is supported at the moment.
  31. num_channels (`int`, *optional*, defaults to 3):
  32. The number of input channels.
  33. embed_dim (`int`, *optional*, defaults to 64):
  34. Dimensionality of patch embedding.
  35. depths (`list[int]`, *optional*, defaults to `[3, 4, 6, 5]`):
  36. Number of layers in each level of the encoder.
  37. num_heads (`list[int]`, *optional*, defaults to `[2, 4, 8, 16]`):
  38. Number of attention heads in each layer of the Transformer encoder.
  39. kernel_size (`int`, *optional*, defaults to 7):
  40. Neighborhood Attention kernel size.
  41. dilations (`list[list[int]]`, *optional*, defaults to `[[1, 8, 1], [1, 4, 1, 4], [1, 2, 1, 2, 1, 2], [1, 1, 1, 1, 1]]`):
  42. Dilation value of each NA layer in the Transformer encoder.
  43. mlp_ratio (`float`, *optional*, defaults to 3.0):
  44. Ratio of MLP hidden dimensionality to embedding dimensionality.
  45. qkv_bias (`bool`, *optional*, defaults to `True`):
  46. Whether or not a learnable bias should be added to the queries, keys and values.
  47. hidden_dropout_prob (`float`, *optional*, defaults to 0.0):
  48. The dropout probability for all fully connected layers in the embeddings and encoder.
  49. attention_probs_dropout_prob (`float`, *optional*, defaults to 0.0):
  50. The dropout ratio for the attention probabilities.
  51. drop_path_rate (`float`, *optional*, defaults to 0.1):
  52. Stochastic depth rate.
  53. hidden_act (`str` or `function`, *optional*, defaults to `"gelu"`):
  54. The non-linear activation function (function or string) in the encoder. If string, `"gelu"`, `"relu"`,
  55. `"selu"` and `"gelu_new"` are supported.
  56. initializer_range (`float`, *optional*, defaults to 0.02):
  57. The standard deviation of the truncated_normal_initializer for initializing all weight matrices.
  58. layer_norm_eps (`float`, *optional*, defaults to 1e-05):
  59. The epsilon used by the layer normalization layers.
  60. layer_scale_init_value (`float`, *optional*, defaults to 0.0):
  61. The initial value for the layer scale. Disabled if <=0.
  62. out_features (`list[str]`, *optional*):
  63. If used as backbone, list of features to output. Can be any of `"stem"`, `"stage1"`, `"stage2"`, etc.
  64. (depending on how many stages the model has). If unset and `out_indices` is set, will default to the
  65. corresponding stages. If unset and `out_indices` is unset, will default to the last stage. Must be in the
  66. same order as defined in the `stage_names` attribute.
  67. out_indices (`list[int]`, *optional*):
  68. If used as backbone, list of indices of features to output. Can be any of 0, 1, 2, etc. (depending on how
  69. many stages the model has). If unset and `out_features` is set, will default to the corresponding stages.
  70. If unset and `out_features` is unset, will default to the last stage. Must be in the
  71. same order as defined in the `stage_names` attribute.
  72. Example:
  73. ```python
  74. >>> from transformers import DinatConfig, DinatModel
  75. >>> # Initializing a Dinat shi-labs/dinat-mini-in1k-224 style configuration
  76. >>> configuration = DinatConfig()
  77. >>> # Initializing a model (with random weights) from the shi-labs/dinat-mini-in1k-224 style configuration
  78. >>> model = DinatModel(configuration)
  79. >>> # Accessing the model configuration
  80. >>> configuration = model.config
  81. ```"""
  82. model_type = "dinat"
  83. attribute_map = {
  84. "num_attention_heads": "num_heads",
  85. "num_hidden_layers": "num_layers",
  86. }
  87. def __init__(
  88. self,
  89. patch_size=4,
  90. num_channels=3,
  91. embed_dim=64,
  92. depths=[3, 4, 6, 5],
  93. num_heads=[2, 4, 8, 16],
  94. kernel_size=7,
  95. dilations=[[1, 8, 1], [1, 4, 1, 4], [1, 2, 1, 2, 1, 2], [1, 1, 1, 1, 1]],
  96. mlp_ratio=3.0,
  97. qkv_bias=True,
  98. hidden_dropout_prob=0.0,
  99. attention_probs_dropout_prob=0.0,
  100. drop_path_rate=0.1,
  101. hidden_act="gelu",
  102. initializer_range=0.02,
  103. layer_norm_eps=1e-5,
  104. layer_scale_init_value=0.0,
  105. out_features=None,
  106. out_indices=None,
  107. **kwargs,
  108. ):
  109. super().__init__(**kwargs)
  110. self.patch_size = patch_size
  111. self.num_channels = num_channels
  112. self.embed_dim = embed_dim
  113. self.depths = depths
  114. self.num_layers = len(depths)
  115. self.num_heads = num_heads
  116. self.kernel_size = kernel_size
  117. self.dilations = dilations
  118. self.mlp_ratio = mlp_ratio
  119. self.qkv_bias = qkv_bias
  120. self.hidden_dropout_prob = hidden_dropout_prob
  121. self.attention_probs_dropout_prob = attention_probs_dropout_prob
  122. self.drop_path_rate = drop_path_rate
  123. self.hidden_act = hidden_act
  124. self.layer_norm_eps = layer_norm_eps
  125. self.initializer_range = initializer_range
  126. # we set the hidden_size attribute in order to make Dinat work with VisionEncoderDecoderModel
  127. # this indicates the channel dimension after the last stage of the model
  128. self.hidden_size = int(embed_dim * 2 ** (len(depths) - 1))
  129. self.layer_scale_init_value = layer_scale_init_value
  130. self.stage_names = ["stem"] + [f"stage{idx}" for idx in range(1, len(depths) + 1)]
  131. self._out_features, self._out_indices = get_aligned_output_features_output_indices(
  132. out_features=out_features, out_indices=out_indices, stage_names=self.stage_names
  133. )
  134. __all__ = ["DinatConfig"]