Update README.md

README.md

@@ -1,63 +1,63 @@
 ---
 library_name: transformers
-tags: []
+tags:
+- code
+- cybersecurity
+- vulnerability
+- cpp
+license: apache-2.0
+datasets:
+- lemon42-ai/minified-diverseful-multilabels
+metrics:
+- accuracy
+base_model:
+- answerdotai/ModernBERT-base
+pipeline_tag: text-classification
 ---
 
 # Model Card for Model ID
 
-<!-- Provide a quick summary of what the model is/does. -->
-
-
+This is derivative version of [answerdotai/ModernBERT-base](https://huggingface.co/answerdotai/ModernBERT-base). <br>
+We fine-tuned ModernBERT-base to detect vulnerability in C/C++ Code. <br>
+The actual version has an accuracy of 82% <br>
 
 ## Model Details
 
 ### Model Description
 
-<!-- Provide a longer summary of what this model is. -->
-
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
+ThreatDetect-C-Cpp can be used as a code classifier. It classify the input code into 7 labels: 'safe' (no vulnerability detected) and six other CWE weaknesses:
+| Label  | Description                                         |
+|---------|-------------------------------------------------------|
+| CWE-119 | Improper Restriction of Operations within the Bounds of a Memory Buffer |
+| CWE-125 | Out-of-bounds Read                                    |
+| CWE-20  | Improper Input Validation                            |
+| CWE-416 | Use After Free                                       |
+| CWE-703 | Improper Check or Handling of Exceptional Conditions |
+| CWE-787 | Out-of-bounds Write                                  |
+| safe | Safe code                                  |
+
+
+- **Developed by:** [lemon42-ai](https://github.com/lemon42-ai)
+- **Contributers** [Abdellah Oumida](https://www.linkedin.com/in/abdellah-oumida-ab9082234/) & [Mohamed Sbaihi](https://www.linkedin.com/in/mohammed-sbaihi-aa6493254/)
+- **Model type:** [ModernBERT, Encoder-only Transformer](https://arxiv.org/abs/2412.13663)
+- **Supported Programming Languages:** C/C++ 
+- **License:** Apache 2.0 (see original License of ModernBERT-Base)
+- **Finetuned from model:** [answerdotai/ModernBERT-base](https://huggingface.co/answerdotai/ModernBERT-base).
 
 ### Model Sources [optional]
 
-<!-- Provide the basic links for the model. -->
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+- **Repository:** [The official lemon42-ai Github repository](https://github.com/lemon42-ai/ThreatDetect-code-vulnerability-detection)
+- **Technical Blog Post:** Coming soon.
 
 ## Uses
 
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-
-### Direct Use
-
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-
-[More Information Needed]
-
-### Downstream Use [optional]
+ThreadDetect-C-Cpp can be integrated in code-related applications. For example, it can be used in pair with a code generator to detect vulnerabilities in the generated code.
 
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-
-[More Information Needed]
 
-### Out-of-Scope Use
-
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
 
 ## Bias, Risks, and Limitations
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
 
 [More Information Needed]