Update README.md

README.md

@@ -1,15 +1,15 @@
----
-license: other
-language:
-- en
-pipeline_tag: object-detection
-tags:
-- image
-- detection
-- pdf
-- ingestion
-- yolox
----
+---
+license: other
+language:
+- en
+pipeline_tag: object-detection
+tags:
+- image
+- detection
+- pdf
+- ingestion
+- yolox
+---
 # Nemoretriever Page Element v3
 
 ## Model Overview
@@ -98,8 +98,24 @@ Our AI models are designed and/or optimized to run on NVIDIA GPU-accelerated sys
 
 ### Usage
 
+The model requires torch, and the custom code available in this repository.
 
-The model requires torch.
+1. Clone the repository
+
+- Make sure git-lfs is installed (https://git-lfs.com)
+```
+git lfs install
+```
+- Using https
+```
+git clone https://huggingface.co/nvidia/nemoretriever-page-elements-v3
+```
+- Or using ssh
+```
+git clone git@hf.co:nvidia/nemoretriever-page-elements-v3
+```
+
+2. Run the model using the following code:
 
 ```
 import torch
@@ -136,6 +152,9 @@ plot_sample(img, boxes_plot, confs, labels=model.labels)
 plt.show()
 ```
 
+Note that this repository only provides minimal code to infer the model.
+If you wish to do additional training, [refer to the original repo](https://github.com/Megvii-BaseDetection/YOLOX).
+
 ### Software Integration
 
 <!---