readme update

README.md

@@ -8,11 +8,16 @@ tags:
 
 ---
 
-# Domain-adapted BERT for General Legal Practice
+# Domain-adapted mBERT for French Legal Practice
+
+[![Python](https://img.shields.io/pypi/pyversions/tensorflow.svg)](https://badge.fury.io/py/tensorflow)
+![Maintainer](https://img.shields.io/badge/maintainer-@louisbrulenaudet-blue)
 
 This is a [sentence-transformers](https://www.SBERT.net) model: It maps sentences & paragraphs to a 768 dimensional dense vector space and can be used for tasks like clustering or semantic search.
 
-<!--- Describe your model here -->
+Pretrained transformers model on the top 102 languages with the largest Wikipedia using a masked language modeling (MLM) objective, fitted using Transformer-based Sequential Denoising Auto-Encoder for unsupervised sentence embedding learning with one objective : domain adaptation.
+
+This way, the model learns an inner representation of the french legal language in the training set that can then be used to extract features useful for downstream tasks: if you have a dataset of labeled sentences for instance, you can train a standard classifier using the features produced by the model as inputs.
 
 ## Usage (Sentence-Transformers)
 
@@ -33,8 +38,6 @@ embeddings = model.encode(sentences)
 print(embeddings)
 ```
 
-
-
 ## Usage (HuggingFace Transformers)
 Without [sentence-transformers](https://www.SBERT.net), you can use the model like this: First, you pass your input through the transformer model, then you have to apply the right pooling-operation on-top of the contextualized word embeddings.
 
@@ -99,6 +102,25 @@ Parameters of the fit()-Method:
 }
 ```
 
+### Training data
+
+The training database consisted of 100,000 random sentences, each over 40 characters long, from the :
+- French Intellectual Property Code (Code de la propriété intellectuelle)
+- French Civil Code (Code civil)
+- French Labor Code (Code du travail)
+- French Monetary and Financial Code (Code monétaire et financier)
+- French Commercial Code (Code de commerce)
+- French Penal Code (Code pénal)
+- French Consumer Code (Code de la consommation)
+- French Environment Code (Code de l'environnement)
+- French General Tax Code (Code général des Impôts)
+- French Code of civil procedure (Code de procédure civile)
+
+The number of sentences per code may not exceed 15,000.
+
+The `DenoisingAutoEncoderDataset` is crafted to provide pairs of noisy and clean data instances. This arrangement allows the denoising autoencoder model to learn and enhance its ability to reconstruct or generate clean data from the corrupted versions provided in the dataset.
+
+By providing pairs of noisy and clean data instances from legal texts, the denoising autoencoder can learn to reconstruct or denoise the noisy, domain-specific text, effectively capturing the intricate linguistic nuances and domain-specific features. This learning process assists in building a model that can generalize better to the legal domain, even when initially trained on more general or diverse datasets.
 
 ## Full Model Architecture
 ```
@@ -115,8 +137,9 @@ If you use this code in your research, please use the following BibTeX entry.
 ```BibTeX
 @misc{louisbrulenaudet2023,
   author =       {Louis Brulé Naudet},
-  title =        {Tranformer-based Denoising AutoEncoder for tax practice},
+  title =        {Domain-adapted mBERT for French Legal Practice},
   year =         {2023}
+  howpublished = {\url{https://huggingface.co/louisbrulenaudet/tsdae-lemone-mbert-base}},
 }
 ```