Update README.md

README.md

@@ -1,3 +1,5 @@
+# Nemoretriever Page Element v3
+
 ## Model Overview
 
 ### Description
@@ -14,6 +16,18 @@ The use of this model is governed by the [NVIDIA AI Foundation Models Community
 
 **You are responsible for ensuring that your use of NVIDIA provided models complies with all applicable laws.**
 
+### Team
+
+- Theo Viel
+- Bo Liu
+- Darragh Hanley
+<!---
+- ???
+--->
+- Even Oldridge
+
+Correspondence to Theo Viel (tviel@nvidia.com) and Bo Liu (boli@nvidia.com)
+
 ### Deployment Geography
 
 Global
@@ -27,7 +41,7 @@ The **NeMo Retriever Page Elements v3** model  is designed for automating extrac
 
 ### Release Date
 
-11/15/2025 via https://build.nvidia.com/nvidia/nemoretriever-page-elements-v3
+11/15/2025 via https://huggingface.co/nvidia/nemoretriever-page-elements-v3
 
 ### References
 
@@ -76,13 +90,49 @@ Our AI models are designed and/or optimized to run on NVIDIA GPU-accelerated sys
 ### Usage
 
 
-# [TODO]
+The model requires torch.
+
+```
+import torch
+import numpy as np
+import matplotlib.pyplot as plt
+from PIL import Image
+
+from model import define_model
+from utils import plot_sample, postprocess_preds_page_element, reformat_for_plotting
+
+# Load image
+path = "./example.png"
+img = Image.open(path).convert("RGB")
+img = np.array(img)
+
+# Load model
+model = define_model("page_element_v3")
+
+# Inference
+with torch.inference_mode():
+    x = model.preprocess(img)
+    preds = model(x, img.shape)[0]
+
+print(preds)
+
+# Post-processing
+labels, bboxes, scores = postprocess_preds_page_element(preds, model.thresholds_per_class, model.labels)
+
+# Plot
+boxes_plot, confs = reformat_for_plotting(labels, bboxes, scores, img.shape, model.num_classes)
 
+plt.figure(figsize=(15, 10))
+plot_sample(img, boxes_plot, confs, labels=model.labels)
+plt.show()
+```
 
 ### Software Integration
 
+<!---
 **Runtime Engine(s):**
 - **NeMo Retriever Page Elements v3** NIM
+--->
 
 **Supported Hardware Microarchitecture Compatibility [List in Alphabetic Order]:**
 - NVIDIA Ampere
@@ -130,10 +180,12 @@ The primary evaluation set is a cut of the Azure labels and digital corpora imag
 | header_footer | 53.895 | 75.670 |
 
 
+<!---
 ## Inference:
 
 **Acceleartion Engine**: TensorRT <br>
 **Test hardware**: See [Support Matrix from NIM documentation](https://docs.nvidia.com/nim/ingestion/object-detection/latest/support-matrix.html#)
+--->
 
 ## Ethical Considerations