Update README.md

README.md

@@ -13,17 +13,35 @@ model-index:
 
 This model is a fine-tuned version of [microsoft/layoutxlm-base](https://huggingface.co/microsoft/layoutxlm-base) on the [XUND](https://github.com/doc-analysis/XFUND) dataset (French split).
 
-## Model description
+## Model usage
 
-More information needed
+Here's how to use this model:
+
+```
+from transformers import AutoProcessor, AutoModelForTokenClassification
+from PIL import Image
+
+processor = AutoProcessor.from_pretrained("nielsr/layoutxlm-finetuned-xfund-fr")
+model = AutoModelForTokenClassification.from_pretrained(nielsr/layoutxlm-finetuned-xfund-fr")
+
+# assuming you have a French document, turned into an image
+image = Image("...").convert("RGB")
+
+# prepare for the model
+encoding = processor(image, return_tensors="pt")
+
+with torch.no_grad():
+  outputs = model(**encoding)
+  logits = outputs.logits
+```
 
 ## Intended uses & limitations
 
-More information needed
+This model can be used for NER on French scanned documents. It can recognize 4 categories: "question", "answer", "header" and "other".
 
 ## Training and evaluation data
 
-More information needed
+This checkpoint used the French portion of the multilingual [XUND](https://github.com/doc-analysis/XFUND) dataset.
 
 ## Training procedure