nielsr HF staff commited on
Commit
d718814
·
verified ·
1 Parent(s): 6ee74d0

Add pipeline tag, library name and link to paper

Browse files

This PR improves the model card by adding the `pipeline_tag` so that the model can be found in the search at https://huggingface.co./models?pipeline_tag=feature-extraction.
It also adds the correct `library_name`. Finally, a link to the paper has been added for easier discovery of the paper the model is associated with.

Files changed (1) hide show
  1. README.md +4 -3
README.md CHANGED
@@ -1,5 +1,7 @@
1
  ---
2
  license: cc-by-nc-4.0
 
 
3
  ---
4
  <h1 align="center">Salesforce/SFR-Embedding-Code-400M_R</h1>
5
 
@@ -7,7 +9,7 @@ license: cc-by-nc-4.0
7
 
8
  The Salesforce/SFR-Embedding-Code is a generalist embedding model family for multilingual and multi-task code and Text retrieval. It demonstrates superior performance compared to various open-source code embedding models across multiple code retrieval tasks.
9
 
10
- Check out our [paper](https://arxiv.org/abs/2411.12644) for more details!
11
 
12
  ### Ethical Considerations
13
  This release is for research purposes only in support of an academic paper. Our models, datasets, and code are not specifically designed or evaluated for all downstream purposes. We strongly recommend users evaluate and address potential concerns related to accuracy, safety, and fairness before deploying this model. We encourage users to consider the common limitations of AI, comply with applicable laws, and leverage best practices when selecting use cases, particularly for high-risk scenarios where errors or misuse could significantly impact people’s lives, rights, or safety. For further guidance on use cases, refer to our [AUP](https://www.salesforce.com/content/dam/web/en_us/www/documents/legal/Agreements/policies/ExternalFacing_Services_Policy.pdf) and [AI AUP](https://www.salesforce.com/content/dam/web/en_us/www/documents/legal/Agreements/policies/ai-acceptable-use-policy.pdf).
@@ -91,5 +93,4 @@ print(cos_sim(embeddings[0], embeddings[1:]))
91
  journal={arXiv preprint arXiv:2411.12644},
92
  year={2024}
93
  }
94
- ```
95
-
 
1
  ---
2
  license: cc-by-nc-4.0
3
+ library_name: transformers
4
+ pipeline_tag: feature-extraction
5
  ---
6
  <h1 align="center">Salesforce/SFR-Embedding-Code-400M_R</h1>
7
 
 
9
 
10
  The Salesforce/SFR-Embedding-Code is a generalist embedding model family for multilingual and multi-task code and Text retrieval. It demonstrates superior performance compared to various open-source code embedding models across multiple code retrieval tasks.
11
 
12
+ Check out our [paper](https://huggingface.co/papers/2411.12644) for more details!
13
 
14
  ### Ethical Considerations
15
  This release is for research purposes only in support of an academic paper. Our models, datasets, and code are not specifically designed or evaluated for all downstream purposes. We strongly recommend users evaluate and address potential concerns related to accuracy, safety, and fairness before deploying this model. We encourage users to consider the common limitations of AI, comply with applicable laws, and leverage best practices when selecting use cases, particularly for high-risk scenarios where errors or misuse could significantly impact people’s lives, rights, or safety. For further guidance on use cases, refer to our [AUP](https://www.salesforce.com/content/dam/web/en_us/www/documents/legal/Agreements/policies/ExternalFacing_Services_Policy.pdf) and [AI AUP](https://www.salesforce.com/content/dam/web/en_us/www/documents/legal/Agreements/policies/ai-acceptable-use-policy.pdf).
 
93
  journal={arXiv preprint arXiv:2411.12644},
94
  year={2024}
95
  }
96
+ ```