Create README.md

README.md

@@ -0,0 +1,58 @@
+---
+license: mit
+language: fr
+library_name: transformers
+pipeline_tag: feature-extraction
+datasets:
+  - uonlp/CulturaX
+  - oscar
+  - almanach/HALvest
+  - wikimedia/wikipedia
+tags:
+  - deberta-v2
+  - deberta-v3
+  - debertav2
+  - debertav3
+  - camembert
+---
+# CamemBERT(a)-v2: A Smarter French Language Model Aged to Perfection
+
+[CamemBERTv2](https://arxiv.org/abs/2411.08868) is a French language model pretrained on a large corpus of 275B tokens of French text. It is the second version of the CamemBERT model, which is based on the RoBERTa architecture. CamemBERTv2 is trained using the Masked Language Modeling (MLM) objective with 40% mask rate for 3 epochs on 32 H100 GPUs. The dataset used for training is a combination of French [OSCAR](https://oscar-project.org/) dumps from the [CulturaX Project](https://huggingface.co/datasets/uonlp/CulturaX), French scientific documents from [HALvest](https://huggingface.co/datasets/almanach/HALvest), and the French Wikipedia.
+
+The model is a drop-in replacement for the original CamemBERT model. Note that the new tokenizer is different from the original CamemBERT tokenizer, so you will need to use Fast Tokenizers to use the model. It will work with `CamemBERTTokenizerFast` from `transformers` library even if the original `CamemBERTTokenizer` was sentencepiece-based.
+
+# Model Checkpoints
+
+This repository contains all intermediate model checkpoints with corresponding checkpoints in TF and PT structured as follows:
+
+```
+├── checkpoints/
+│   ├── iter_ckpt_rank_XX/ # Contains all iterator checkpoints from a specific rank
+│   ├── summaries/ # Tensorboard logs
+│   ├── ckpt-YYYYY.data-00000-of-00001
+│   ├── ckpt-YYYYY.index
+├── post/
+│   ├── ckpt-YYYYY/
+│   │   ├── pt/
+│   │   │   ├── config.json
+│   │   │   ├── pytorch_model.bin
+│   │   │   ├── special_tokens_map.json
+│   │   │   ├── tokenizer.json
+│   │   │   ├── tokenizer_config.json
+│   │   ├── tf/
+│   │   │   ├── ...
+```
+
+## Citation
+
+```bibtex
+@misc{antoun2024camembert20smarterfrench,
+      title={CamemBERT 2.0: A Smarter French Language Model Aged to Perfection},
+      author={Wissam Antoun and Francis Kulumba and Rian Touchent and Éric de la Clergerie and Benoît Sagot and Djamé Seddah},
+      year={2024},
+      eprint={2411.08868},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL},
+      url={https://arxiv.org/abs/2411.08868},
+}
+```