Feature Extraction
sentence-transformers
Safetensors
Transformers
codexembed2b
code
retrieval
custom_code
Instructions to use Salesforce/SFR-Embedding-Code-2B_R with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- sentence-transformers
How to use Salesforce/SFR-Embedding-Code-2B_R with sentence-transformers:
from sentence_transformers import SentenceTransformer model = SentenceTransformer("Salesforce/SFR-Embedding-Code-2B_R", trust_remote_code=True) sentences = [ "The weather is lovely today.", "It's so sunny outside!", "He drove to the stadium." ] embeddings = model.encode(sentences) similarities = model.similarity(embeddings, embeddings) print(similarities.shape) # [3, 3] - Transformers
How to use Salesforce/SFR-Embedding-Code-2B_R with Transformers:
# Use a pipeline as a high-level helper from transformers import pipeline pipe = pipeline("feature-extraction", model="Salesforce/SFR-Embedding-Code-2B_R", trust_remote_code=True)# Load model directly from transformers import AutoModel model = AutoModel.from_pretrained("Salesforce/SFR-Embedding-Code-2B_R", trust_remote_code=True, device_map="auto") - Notebooks
- Google Colab
- Kaggle
| # 🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨 | |
| # This file was automatically generated from <path_to_diff_file.py>. | |
| # Do NOT edit this file manually as any edits will be overwritten by the generation of | |
| # the file from the diff. If any change should be done, please apply the change to the | |
| # diff.py file directly. | |
| # 🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨 | |
| # coding=utf-8 | |
| # Copyright 2024 Google Inc. HuggingFace Inc. team. All rights reserved. | |
| # | |
| # | |
| # Licensed under the Apache License, Version 2.0 (the "License"); | |
| # you may not use this file except in compliance with the License. | |
| # You may obtain a copy of the License at | |
| # | |
| # http://www.apache.org/licenses/LICENSE-2.0 | |
| # | |
| # Unless required by applicable law or agreed to in writing, software | |
| # distributed under the License is distributed on an "AS IS" BASIS, | |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| # See the License for the specific language governing permissions and | |
| # limitations under the License. | |
| from transformers import PretrainedConfig | |
| class CodeXEmbedConfig(PretrainedConfig): | |
| r""" | |
| This is the configuration class to store the configuration of a [`Gemma2Model`]. It is used to instantiate an Gemma2 | |
| model according to the specified arguments, defining the model architecture. Instantiating a configuration with the | |
| defaults will yield a similar configuration to that of the Gemma2-7B. | |
| e.g. [google/gemma2-7b](https://huggingface.co/google/gemma2-7b) | |
| Configuration objects inherit from [`PretrainedConfig`] and can be used to control the model outputs. Read the | |
| documentation from [`PretrainedConfig`] for more information. | |
| Args: | |
| vocab_size (`int`, *optional*, defaults to 256000): | |
| Vocabulary size of the Gemma2 model. Defines the number of different tokens that can be represented by the | |
| `inputs_ids` passed when calling [`Gemma2Model`] | |
| hidden_size (`int`, *optional*, defaults to 3072): | |
| Dimension of the hidden representations. | |
| intermediate_size (`int`, *optional*, defaults to 24576): | |
| Dimension of the MLP representations. | |
| num_hidden_layers (`int`, *optional*, defaults to 28): | |
| Number of hidden layers in the Transformer decoder. | |
| num_attention_heads (`int`, *optional*, defaults to 16): | |
| Number of attention heads for each attention layer in the Transformer decoder. | |
| num_key_value_heads (`int`, *optional*, defaults to 16): | |
| This is the number of key_value heads that should be used to implement Grouped Query Attention. If | |
| `num_key_value_heads=num_attention_heads`, the model will use Multi Head Attention (MHA), if | |
| `num_key_value_heads=1` the model will use Multi Query Attention (MQA) otherwise GQA is used. When | |
| converting a multi-head checkpoint to a GQA checkpoint, each group key and value head should be constructed | |
| by meanpooling all the original heads within that group. For more details checkout [this | |
| paper](https://arxiv.org/pdf/2305.13245.pdf). If it is not specified, will default to | |
| `num_attention_heads`. | |
| head_dim (`int`, *optional*, defaults to 256): | |
| The attention head dimension. | |
| hidden_activation (`str` or `function`, *optional*, defaults to `"gelu_pytorch_tanh"`): | |
| The non-linear activation function (function or string) in the decoder. | |
| max_position_embeddings (`int`, *optional*, defaults to 8192): | |
| The maximum sequence length that this model might ever be used with. | |
| initializer_range (`float`, *optional*, defaults to 0.02): | |
| The standard deviation of the truncated_normal_initializer for initializing all weight matrices. | |
| rms_norm_eps (`float`, *optional*, defaults to 1e-06): | |
| The epsilon used by the rms normalization layers. | |
| use_cache (`bool`, *optional*, defaults to `True`): | |
| Whether or not the model should return the last key/values attentions (not used by all models). Only | |
| relevant if `config.is_decoder=True`. | |
| pad_token_id (`int`, *optional*, defaults to 0): | |
| Padding token id. | |
| eos_token_id (`int`, *optional*, defaults to 1): | |
| End of stream token id. | |
| bos_token_id (`int`, *optional*, defaults to 2): | |
| Beginning of stream token id. | |
| tie_word_embeddings (`bool`, *optional*, defaults to `True`): | |
| Whether to tie weight embeddings | |
| rope_theta (`float`, *optional*, defaults to 10000.0): | |
| The base period of the RoPE embeddings. | |
| attention_bias (`bool`, defaults to `False`, *optional*, defaults to `False`): | |
| Whether to use a bias in the query, key, value and output projection layers during self-attention. | |
| attention_dropout (`float`, *optional*, defaults to 0.0): | |
| The dropout ratio for the attention probabilities. | |
| final_logit_softcapping (`float`, *optional*, defaults to 30.0): scaling factor when applying tanh softcapping on the logits. | |
| attn_logit_softcapping (`float`, *optional*, defaults to 50.0): scaling factor when applying tanh softcapping on the attention scores. | |
| query_pre_attn_scalar (`float`, *optional*, defaults to 224): scaling factor used on the attention scores | |
| sliding_window (`int`, *optional*, defaults to 4096): in Gemma2, every other layer uses sliding window attention. This is the | |
| size of the sliding window. | |
| ```python | |
| >>> from transformers import Gemma2Model, CodeXEmbedConfig | |
| >>> # Initializing a Gemma2 gemma2-9b style configuration | |
| >>> configuration = CodeXEmbedConfig() | |
| >>> # Initializing a model from the gemma2-9b style configuration | |
| >>> model = Gemma2Model(configuration) | |
| >>> # Accessing the model configuration | |
| >>> configuration = model.config | |
| ```""" | |
| model_type = "codexembed2b" | |
| keys_to_ignore_at_inference = ["past_key_values"] | |
| def __init__( | |
| self, | |
| vocab_size=256000, | |
| hidden_size=3072, | |
| intermediate_size=24576, | |
| num_hidden_layers=28, | |
| num_attention_heads=16, | |
| num_key_value_heads=16, | |
| head_dim=256, | |
| hidden_activation="gelu_pytorch_tanh", | |
| max_position_embeddings=8192, | |
| initializer_range=0.02, | |
| rms_norm_eps=1e-6, | |
| use_cache=True, | |
| pad_token_id=0, | |
| eos_token_id=1, | |
| bos_token_id=2, | |
| tie_word_embeddings=True, | |
| rope_theta=10000.0, | |
| attention_bias=False, | |
| attention_dropout=0.0, | |
| final_logit_softcapping=30.0, | |
| attn_logit_softcapping=50.0, | |
| query_pre_attn_scalar=224, | |
| sliding_window=4096, | |
| **kwargs, | |
| ): | |
| self.vocab_size = vocab_size | |
| self.max_position_embeddings = max_position_embeddings | |
| self.hidden_size = hidden_size | |
| self.intermediate_size = intermediate_size | |
| self.num_hidden_layers = num_hidden_layers | |
| self.num_attention_heads = num_attention_heads | |
| self.head_dim = head_dim | |
| self.num_key_value_heads = num_key_value_heads | |
| self.hidden_activation = hidden_activation | |
| self.initializer_range = initializer_range | |
| self.rms_norm_eps = rms_norm_eps | |
| self.use_cache = use_cache | |
| self.rope_theta = rope_theta | |
| self.attention_bias = attention_bias | |
| self.attention_dropout = attention_dropout | |
| self.attn_logit_softcapping = attn_logit_softcapping | |
| super().__init__( | |
| pad_token_id=pad_token_id, | |
| bos_token_id=bos_token_id, | |
| eos_token_id=eos_token_id, | |
| tie_word_embeddings=tie_word_embeddings, | |
| **kwargs, | |
| ) | |
| self.final_logit_softcapping = final_logit_softcapping | |
| self.query_pre_attn_scalar = query_pre_attn_scalar | |
| self.sliding_window = sliding_window | |
| self.cache_implementation = "hybrid" | |
| MODEL_TYPE = "codexembed2b" | |
| from transformers import AutoConfig | |
| AutoConfig.register(MODEL_TYPE, CodeXEmbedConfig) |