Update README.md

README.md

@@ -9,31 +9,51 @@ metrics:
 model-index:
 - name: vulnerability-severity-classification-roberta-base
   results: []
+datasets:
+- CIRCL/vulnerability-scores
 ---
 
-<!-- This model card has been generated automatically according to the information the Trainer had access to. You
-should probably proofread and complete it, then remove this comment. -->
-
 # vulnerability-severity-classification-roberta-base
 
-This model is a fine-tuned version of [roberta-base](https://huggingface.co/roberta-base) on an unknown dataset.
+This model is a fine-tuned version of [roberta-base](https://huggingface.co/FacebookAI/roberta-base) on a the dataset [CIRCL/vulnerability-scores](https://huggingface.co/datasets/CIRCL/vulnerability-scores).
+
 It achieves the following results on the evaluation set:
 - Loss: 0.5372
 - Accuracy: 0.8138
 
 ## Model description
 
-More information needed
+It is a classification model and is aimed to assist in classifying vulnerabilities by severity based on their descriptions.
+
+
+## How to get started with the model
+
+```python
+from transformers import AutoModelForSequenceClassification, AutoTokenizer
+import torch
+
+labels = ["low", "medium", "high", "critical"]
+
+model_name = "CIRCL/vulnerability-severity-classification-roberta-base"
+tokenizer = AutoTokenizer.from_pretrained(model_name)
+model = AutoModelForSequenceClassification.from_pretrained(model_name)
+model.eval()
 
-## Intended uses & limitations
+test_description = "langchain_experimental 0.0.14 allows an attacker to bypass the CVE-2023-36258 fix and execute arbitrary code via the PALChain in the python exec method."
+inputs = tokenizer(test_description, return_tensors="pt", truncation=True, padding=True)
 
-More information needed
+# Run inference
+with torch.no_grad():
+    outputs = model(**inputs)
+    predictions = torch.nn.functional.softmax(outputs.logits, dim=-1)
 
-## Training and evaluation data
 
-More information needed
+# Print results
+print("Predictions:", predictions)
+predicted_class = torch.argmax(predictions, dim=-1).item()
+print("Predicted severity:", labels[predicted_class])
+```
 
-## Training procedure
 
 ### Training hyperparameters
 
@@ -62,4 +82,4 @@ The following hyperparameters were used during training:
 - Transformers 4.49.0
 - Pytorch 2.6.0+cu124
 - Datasets 3.3.2
-- Tokenizers 0.21.0
+- Tokenizers 0.21.0