Create README.md

README.md

@@ -0,0 +1,51 @@
+---
+license: mit
+language:
+- fr
+library_name: transformers
+inference: false
+pipeline_tag: feature-extraction
+---
+# CamemBERTa-L2
+
+This model is a pruned version of the pre-trained [CamemBERTa](https://huggingface.co/almanach/camemberta-base) checkpoint, obtained by [dropping the top-layers](https://doi.org/10.48550/arXiv.2004.03844) from the original model.
+
+## Usage
+
+You can use the raw model for masked language modeling (MLM), but it's mostly intended to be fine-tuned on a downstream task, especially one that uses the whole sentence to make decisions such as text classification, extractive question answering, or semantic search. For tasks such as text generation, you should look at autoregressive models like [BelGPT-2](https://huggingface.co/antoinelouis/belgpt2).
+
+You can use this model directly with a pipeline for [masked language modeling](https://huggingface.co/tasks/fill-mask):
+
+```python
+from transformers import pipeline
+
+unmasker = pipeline('fill-mask', model='antoinelouis/camemberta-L2')
+unmasker("Bonjour, je suis un [MASK] modèle.")
+```
+
+You can also use this model to [extract the features](https://huggingface.co/tasks/feature-extraction) of a given text:
+
+```python
+from transformers import AutoTokenizer, AutoModel
+
+tokenizer = AutoTokenizer.from_pretrained('antoinelouis/camemberta-L2')
+model = AutoModel.from_pretrained('antoinelouis/camemberta-L2')
+
+text = "Remplacez-moi par le texte de votre choix."
+encoded_input = tokenizer(text, return_tensors='pt')
+output = model(**encoded_input)
+```
+
+## Variations
+
+CamemBERTa has originally been released in a base (112M) version. The following checkpoints prune the base variation by dropping the top 2, 4, 6, 8, and 10 pretrained encoding layers, respectively.
+
+| Model                                                                | #Params |  Size | Pruning |
+|----------------------------------------------------------------------|:-------:|:-----:|:-------:|
+| [CamemBERTa-base](https://huggingface.co/almanach/camemberta-base)   |  111.8M | 447MB |    -    |
+|                                                                      |         |       |         |
+| [CamemBERTa-L10](https://huggingface.co/antoinelouis/camemberta-L10) |  97.6M  | 386MB |   -14%  |
+| [CamemBERTa-L8](https://huggingface.co/antoinelouis/camemberta-L8)   |  83.5M  | 334MB |   -25%  |
+| [CamemBERTa-L6](https://huggingface.co/antoinelouis/camemberta-L6)   |  69.3M  | 277MB |   -38%  |
+| [CamemBERTa-L4](https://huggingface.co/antoinelouis/camemberta-L4)   |  55.1M  | 220MB |   -51%  |
+| [CamemBERTa-L2](https://huggingface.co/antoinelouis/camemberta-L2)   |  40.9M  | 164MB |   -63%  |