update README

README.md

@@ -1,3 +1,72 @@
----
-license: apache-2.0
----
+---
+language:
+- fr
+
+
+license: Apache-2.0
+datasets:
+- wikipedia
+- OPUS
+---
+
+# French ModernBERT Base Cased 128k
+
+Pretrained French language model using a masked language modeling (MLM) objective.
+
+## Model description
+
+ModernBERT is a transformers model pretrained on 2.3 billions of French Wikipedia and OPUS tokens in a self-supervised fashion.
+This means it was pretrained on the raw texts only, with no humans labelling them in any way (which is why it can use lots of publicly available data) with an automatic process to generate inputs and labels from those texts.
+
+This model has the following configuration:
+
+- 768 embedding dimension
+- 22 hidden layers
+- 1152 hidden dimension
+- 12 attention heads
+- 900M parameters
+- 129k of vocabulary size
+
+## Intended uses & limitations
+
+You can use the raw model for either masked language modeling or next sentence prediction, but it's mostly intended to be fine-tuned on a downstream task.
+
+Note that this model is primarily aimed at being fine-tuned on tasks that use the whole sentence (potentially masked) to make decisions, such as sequence classification, token classification or question answering. For tasks such as text generation you should look at model like GPT ones.
+
+### How to use
+
+Here is how to use this model to get the features of a given text in PyTorch:
+
+```python
+from transformers import ModernBERTTokenizer, ModernBERTModel
+tokenizer = ModernBERTTokenizer.from_pretrained('cservan/french-modernbert-small')
+model = ModernBERTModel.from_pretrained("cservan/french-modernbert-small")
+text = "Remplacez-moi par le texte que vous souhaitez."
+encoded_input = tokenizer(text, return_tensors='pt')
+output = model(**encoded_input)
+```
+
+
+
+
+## Training data
+
+The ModernBERT model was pretrained on 2.3 billion of token from [French Wikipedia](https://scouv.lisn.upsaclay.fr/#malbert) (excluding lists, tables and
+headers) and [OPUS](https://opus.nlpl.eu/).
+
+## Training procedure
+
+### Preprocessing
+
+The texts are lowercased and tokenized using SentencePiece and a vocabulary size of 128,000 tokens plus 1,000 unused token for downstream adataption.
+The inputs of the model are then of the form:
+
+```
+[CLS] Sentence A [SEP] Sentence B [SEP]
+```
+
+
+### Tools
+
+The tools used to pre-train the model are available [here](https://github.com/AnswerDotAI/ModernBERT)
+