Update README.md

README.md

@@ -7,6 +7,8 @@ tags:
 model-index:
 - name: vulnerability-description-generation-gpt2-large
   results: []
+datasets:
+- CIRCL/vulnerability
 ---
 
 <!-- This model card has been generated automatically according to the information the Trainer had access to. You
@@ -14,21 +16,31 @@ should probably proofread and complete it, then remove this comment. -->
 
 # vulnerability-description-generation-gpt2-large
 
-This model is a fine-tuned version of [openai-community/gpt2-large](https://huggingface.co/openai-community/gpt2-large) on an unknown dataset.
+This model is a fine-tuned version of [openai-community/gpt2-large](https://huggingface.co/openai-community/gpt2-large) on the dataset [CIRCL/vulnerability](https://huggingface.co/datasets/CIRCL/vulnerability).
+
 It achieves the following results on the evaluation set:
 - Loss: 1.2889
 
+codecarbon information:
+- Energy consumed for RAM : 2.726718 kWh. RAM Power : 94.34470081329346 W
+- Energy consumed for all CPUs : 1.228363 kWh. Total CPU Power : 42.5 W
+- Energy consumed for all GPUs : 14.324482 kWh. Total GPU Power : 171.6372824939248 W
+- 18.279562 kWh of electricity used since the beginning.
+
 ## Model description
 
-More information needed
+It is a text generation model and is aimed to assist in writing vulnerability descriptions.
 
-## Intended uses & limitations
 
-More information needed
+## How to get started with the model
 
-## Training and evaluation data
+```python
+from transformers import pipeline
+pipe = pipeline("text-generation", model="CIRCL/vulnerability-description-generation-gpt2-large")
 
-More information needed
+>>> print(pipe("A new vulnerability in OpenSSL allows", max_length=300))
+[{'generated_text': 'A new vulnerability in OpenSSL allows remote attackers to create insecure connections. The impact of this vulnerability is that one or more TLS connections will be created under one username or one username/logon in a session for which another username or logon is valid. An attacker that can control the username or logon string of an openSSL host can effectively manipulate the OpenSSL host in a way that enables the attacker to create arbitrary openSSL connections by calling `http-server-create` in a non-secure sequence across other hosts. The vulnerability may be used to perform a man-in-the-middle attack, making the attacker completely different to the attacker. An exploitation may include MITM attacks and man-in-the-middle attacks. NOTE: the vendor states that "SUSE OpenSSL\'s implementation of \'openSSL_connect`, is not vulnerable to MITM attacks. If the attack vector is a MITM attack, OpenSSL will work under any circumstances." The CVE has been assigned for tracking purposes. In no way does the vendor\'s position change that an OpenSSL client should not use openSSL in the context of another OpenSSL server, but an attacker must choose the vulnerability according to their configuration if they are to exploit their attack. NOTE: the vendor indicates that it has considered the impact of this vulnerability "moderate". If by any measure, an OpenSSL client is susceptible to MITM attacks, that vulnerability would be considered low because it would be difficult to exploit a vulnerability that'}]
+```
 
 ## Training procedure
 
@@ -58,4 +70,4 @@ The following hyperparameters were used during training:
 - Transformers 4.49.0
 - Pytorch 2.6.0+cu124
 - Datasets 3.4.0
-- Tokenizers 0.21.1
+- Tokenizers 0.21.1