Update README.md

README.md

@@ -4,4 +4,75 @@ language:
 - fr
 tags:
 - Objectifs de développement durable (ODD)
----
+---
+
+# ilovebots/bert-sdg-french
+
+<!-- Provide a quick summary of what the model is/does. -->
+
+Ce modèle permet de classer les textes en fonction des objectifs de développement durable (ODD) des Nations Unies.
+
+![image](https://user-images.githubusercontent.com/73560591/216751462-ced482ba-5d8e-48aa-9a48-5557979a35f1.png)
+Source:https://www.un.org/development/desa/disabilities/about-us/sustainable-development-goals-sdgs-and-disability.html
+
+
+## Détails du modèle
+
+### Description du modèle
+
+<!-- Provide a longer summary of what this model is. -->
+
+Ce modèle de classification de texte a été développé en fine-tuning le modèle pré-entraîné dbmdz/bert-base-french-europeana-cased.
+Les données d'entraînement de ce modèle affiné proviennent de l'ensemble de données communautaires OSDG (OSDG-CD) accessible au public à l'adresse https://zenodo.org/record/5550238#.ZBulfcJByF4.
+Ce modèle a été réalisé dans le cadre d'une recherche universitaire à l'Université Laval.
+L'objectif était de créer un modèle de classification de texte SDG basé sur transformers en français que tout le monde pourrait utiliser.
+Les principaux détails du modèle sont mis en évidence ci-dessous :
+
+- **Model type:** Text classification
+- **Language(s) (NLP):** French
+- **License:** mit
+- **Finetuned from model [optional]:** dbmdz/bert-base-french-europeana-cased
+
+### Model Sources
+<!-- Provide the basic links for the model. -->
+- **Repository:** https://huggingface.co/ilovebots/bert-sdg-french
+
+## How to Get Started with the Model
+
+Utilisez le code ci-dessous pour commencer à utiliser le modèle.
+```python
+from transformers import AutoTokenizer, AutoModelForSequenceClassification
+tokenizer = AutoTokenizer.from_pretrained("ilovebots/bert-sdg-french")
+model = AutoModelForSequenceClassification.from_pretrained("ilovebots/bert-sdg-french")
+```
+
+
+## Training Data
+
+<!-- This should link to a Data Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
+La base disponible dans https://zenodo.org/record/5550238#.ZBulfcJByF4 a été enrichie des objectifs de développement durable des Nations Unies et traduite en en français.
+
+## Training Hyperparameters
+
+- Num_epoch = 4
+- Learning rate = 2e-5
+- Epsilon = 1e-8
+- Optimizer = AdamW
+- Batch size = 32
+- Seed random = 42
+
+
+## Evaluation
+
+#### Metrics
+
+<!-- These are the evaluation metrics being used, ideally with a description of why. -->
+- Accuracy = 0.84
+
+## Citation
+Martinez, D.F. (2023). SDG classification with BERT. https://huggingface.co/ilovebots/bert-sdg-french 
+
+<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
+
+
+<!--## Model Card Contact -->