Update README.md

README.md

@@ -5,4 +5,36 @@ datasets:
 language:
 - en
 library_name: transformers
----
+---
+
+# T5-nl2cmd
+
+This repository contains the trained model, fine-tuned from the [Flan-T5 base](https://huggingface.co/google/flan-t5-base) model, to generate command line instructions from natural language descriptions.
+
+# Training data
+
+- Tldr.sh pages - [tldr-dataset](https://huggingface.co/datasets/Edoigtrd/tldr-pages)
+
+- nl2bash - [nl2bash](https://github.com/TellinaTool/nl2bash)
+
+# Model
+
+The model is fine-tuned from the [Flan-T5 base](https://huggingface.co/google/flan-t5-base) model.
+
+It has been trained on a single Nvidia L4 from Scaleway, for 4 hours and 4 epochs.
+
+The model aims to generate command line instructions from natural language descriptions.
+
+# Results
+
+| Metric             |   Flan-T5 - Nl2cmd |
+|--------------------|------------|
+| exact              |   0.064    |
+| rouge              |   0.530054 |
+| bleu               |   0.177511 |
+| levenstein average |   0.612479 |
+| levenstein median  |   0.608696 |
+
+# License :
+
+[Creative Commons cc-by-nc-sa 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/)