configuration_arcee.py 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201
  1. # 🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨
  2. # This file was automatically generated from src/transformers/models/arcee/modular_arcee.py.
  3. # Do NOT edit this file manually as any edits will be overwritten by the generation of
  4. # the file from the modular. If any change should be done, please apply the change to the
  5. # modular_arcee.py file directly. One of our CI enforces this.
  6. # 🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨
  7. # coding=utf-8
  8. # Copyright 2025 Arcee AI and the HuggingFace Inc. team. All rights reserved.
  9. #
  10. # Licensed under the Apache License, Version 2.0 (the "License");
  11. # you may not use this file except in compliance with the License.
  12. # You may obtain a copy of the License at
  13. #
  14. # http://www.apache.org/licenses/LICENSE-2.0
  15. #
  16. # Unless required by applicable law or agreed to in writing, software
  17. # distributed under the License is distributed on an "AS IS" BASIS,
  18. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19. # See the License for the specific language governing permissions and
  20. # limitations under the License.
  21. from ...configuration_utils import PretrainedConfig
  22. from ...modeling_rope_utils import rope_config_validation
  23. class ArceeConfig(PretrainedConfig):
  24. r"""
  25. This is the configuration class to store the configuration of a [`ArceeModel`]. It is used to instantiate an Arcee
  26. model according to the specified arguments, defining the model architecture. Instantiating a configuration with the
  27. defaults will yield a similar configuration to that of the AFM-4.5B-Base.
  28. Pre-trained weights are available at
  29. [arcee-ai/AFM-4.5B](https://huggingface.co/arcee-ai/AFM-4.5B)
  30. and were used to build the examples below.
  31. Configuration objects inherit from [`PretrainedConfig`] and can be used to control the model outputs. Read the
  32. documentation from [`PretrainedConfig`] for more information.
  33. Args:
  34. vocab_size (`int`, *optional*, defaults to 32000):
  35. Vocabulary size of the Arcee model. Defines the number of different tokens that can be represented by the
  36. `inputs_ids` passed when calling [`ArceeModel`]
  37. hidden_size (`int`, *optional*, defaults to 2560):
  38. Dimension of the hidden representations.
  39. intermediate_size (`int`, *optional*, defaults to 18432):
  40. Dimension of the MLP representations.
  41. num_hidden_layers (`int`, *optional*, defaults to 32):
  42. Number of hidden layers in the Transformer decoder.
  43. num_attention_heads (`int`, *optional*, defaults to 32):
  44. Number of attention heads for each attention layer in the Transformer decoder.
  45. num_key_value_heads (`int`, *optional*):
  46. This is the number of key_value heads that should be used to implement Grouped Query Attention. If
  47. `num_key_value_heads=num_attention_heads`, the model will use Multi Head Attention (MHA), if
  48. `num_key_value_heads=1` the model will use Multi Query Attention (MQA) otherwise GQA is used. When
  49. converting a multi-head checkpoint to a GQA checkpoint, each group key and value head should be constructed
  50. by meanpooling all the original heads within that group. For more details checkout [this
  51. paper](https://huggingface.co/papers/2305.13245). If it is not specified, will default to
  52. `num_attention_heads`.
  53. hidden_act (`str` or `function`, *optional*, defaults to `"relu2"`):
  54. The non-linear activation function (function or string) in the decoder.
  55. max_position_embeddings (`int`, *optional*, defaults to 4096):
  56. The maximum sequence length that this model might ever be used with. AFM-4.5B-Base supports up to 16384 tokens.
  57. initializer_range (`float`, *optional*, defaults to 0.02):
  58. The standard deviation of the truncated_normal_initializer for initializing all weight matrices.
  59. rms_norm_eps (`float`, *optional*, defaults to 1e-05):
  60. The epsilon used by the rms normalization layers.
  61. use_cache (`bool`, *optional*, defaults to `True`):
  62. Whether or not the model should return the last key/values attentions (not used by all models). Only
  63. relevant if `config.is_decoder=True`.
  64. pad_token_id (`int`, *optional*):
  65. Padding token id.
  66. bos_token_id (`int`, *optional*, defaults to 128000):
  67. Beginning of stream token id.
  68. eos_token_id (`int`, *optional*, defaults to 128001):
  69. End of stream token id.
  70. tie_word_embeddings (`bool`, *optional*, defaults to `False`):
  71. Whether to tie weight embeddings
  72. rope_theta (`float`, *optional*, defaults to 10000.0):
  73. The base period of the RoPE embeddings.
  74. rope_scaling (`Dict`, *optional*):
  75. Dictionary containing the scaling configuration for the RoPE embeddings. NOTE: if you apply new rope type
  76. and you expect the model to work on longer `max_position_embeddings`, we recommend you to update this value
  77. accordingly.
  78. Expected contents:
  79. `rope_type` (`str`):
  80. The sub-variant of RoPE to use. Can be one of ['default', 'yarn'], with 'default' being the original RoPE implementation.
  81. `factor` (`float`, *optional*):
  82. Used with all rope types except 'default'. The scaling factor to apply to the RoPE embeddings. In
  83. most scaling types, a `factor` of x will enable the model to handle sequences of length x *
  84. original maximum pre-trained length.
  85. `original_max_position_embeddings` (`int`, *optional*):
  86. Used with 'yarn'. The original max position embeddings used during pretraining.
  87. `attention_factor` (`float`, *optional*):
  88. Used with 'yarn'. The scaling factor to be applied on the attention computation. If unspecified,
  89. it defaults to value recommended by the implementation, using the `factor` field to infer the suggested value.
  90. `beta_fast` (`float`, *optional*):
  91. Only used with 'yarn'. Parameter to set the boundary for extrapolation (only) in the linear
  92. ramp function. If unspecified, it defaults to 32.
  93. `beta_slow` (`float`, *optional*):
  94. Only used with 'yarn'. Parameter to set the boundary for interpolation (only) in the linear
  95. ramp function. If unspecified, it defaults to 1.
  96. attention_bias (`bool`, *optional*, defaults to `False`):
  97. Whether to use a bias in the query, key, value and output projection layers during self-attention.
  98. attention_dropout (`float`, *optional*, defaults to 0.0):
  99. The dropout ratio for the attention probabilities.
  100. mlp_bias (`bool`, *optional*, defaults to `False`):
  101. Whether to use a bias in up_proj, down_proj and gate_proj layers in the MLP layers.
  102. head_dim (`int`, *optional*):
  103. The attention head dimension. If None, it will default to hidden_size // num_attention_heads
  104. ```python
  105. >>> from transformers import ArceeModel, ArceeConfig
  106. >>> # Initializing an Arcee AFM-4.5B-Base style configuration
  107. >>> configuration = ArceeConfig()
  108. >>> # Initializing a model from the AFM-4.5B-Base style configuration
  109. >>> model = ArceeModel(configuration)
  110. >>> # Accessing the model configuration
  111. >>> configuration = model.config
  112. ```"""
  113. model_type = "arcee"
  114. keys_to_ignore_at_inference = ["past_key_values"]
  115. base_model_tp_plan = {
  116. "layers.*.self_attn.q_proj": "colwise",
  117. "layers.*.self_attn.k_proj": "colwise",
  118. "layers.*.self_attn.v_proj": "colwise",
  119. "layers.*.self_attn.o_proj": "rowwise",
  120. "layers.*.mlp.up_proj": "colwise",
  121. "layers.*.mlp.down_proj": "rowwise",
  122. }
  123. base_model_pp_plan = {
  124. "embed_tokens": (["input_ids"], ["inputs_embeds"]),
  125. "layers": (["hidden_states", "attention_mask"], ["hidden_states"]),
  126. "norm": (["hidden_states"], ["hidden_states"]),
  127. }
  128. def __init__(
  129. self,
  130. vocab_size=32000,
  131. hidden_size=2560,
  132. intermediate_size=18432,
  133. num_hidden_layers=32,
  134. num_attention_heads=32,
  135. num_key_value_heads=None,
  136. hidden_act="relu2",
  137. max_position_embeddings=4096,
  138. initializer_range=0.02,
  139. rms_norm_eps=1e-5,
  140. use_cache=True,
  141. pad_token_id=None,
  142. bos_token_id=128000,
  143. eos_token_id=128001,
  144. tie_word_embeddings=False,
  145. rope_theta=10000.0,
  146. rope_scaling=None,
  147. attention_bias=False,
  148. attention_dropout=0.0,
  149. mlp_bias=False,
  150. head_dim=None,
  151. **kwargs,
  152. ):
  153. super().__init__(
  154. pad_token_id=pad_token_id,
  155. bos_token_id=bos_token_id,
  156. eos_token_id=eos_token_id,
  157. tie_word_embeddings=tie_word_embeddings,
  158. **kwargs,
  159. )
  160. self.vocab_size = vocab_size
  161. self.max_position_embeddings = max_position_embeddings
  162. self.hidden_size = hidden_size
  163. self.intermediate_size = intermediate_size
  164. self.num_hidden_layers = num_hidden_layers
  165. self.num_attention_heads = num_attention_heads
  166. # for backward compatibility
  167. if num_key_value_heads is None:
  168. num_key_value_heads = num_attention_heads
  169. self.num_key_value_heads = num_key_value_heads
  170. self.hidden_act = hidden_act
  171. self.initializer_range = initializer_range
  172. self.rms_norm_eps = rms_norm_eps
  173. self.use_cache = use_cache
  174. self.rope_theta = rope_theta
  175. self.rope_scaling = rope_scaling
  176. self.attention_bias = attention_bias
  177. self.attention_dropout = attention_dropout
  178. self.mlp_bias = mlp_bias
  179. self.head_dim = head_dim if head_dim is not None else self.hidden_size // self.num_attention_heads
  180. # Validate the correctness of rotary position embeddings parameters
  181. # BC: if there is a 'type' field, copy it it to 'rope_type'.
  182. if self.rope_scaling is not None and "type" in self.rope_scaling:
  183. self.rope_scaling["rope_type"] = self.rope_scaling["type"]
  184. rope_config_validation(self)
  185. __all__ = ["ArceeConfig"]