Update README.md

README.md

@@ -48,6 +48,68 @@ colbert-ai==0.2.21 # for colbert retriever
 flash-attn==2.7.4.post1  # for DSE retrievers to run with flash attention
 ```
 
+## How to use these checkpoints
+
+We standardize codes for all retrievers in two python files
+
+- **For text retrievers**: refer to [`text_wrapper.py`](https://huggingface.co/MMDocIR/MMDocIR_Retrievers/blob/main/text_wrapper.py)
+- **For vision retrievers**: refer to [`vision_wrapper.py`](https://huggingface.co/MMDocIR/MMDocIR_Retrievers/blob/main/vision_wrapper.py)
+
+If you want to encode [MMDocIR_Evaluation_Dataset](https://huggingface.co/datasets/MMDocIR/MMDocIR_Evaluation_Dataset) with these retrievers, you can refer to code [MMDocIR](https://github.com/MMDocRAG/MMDocIR/tree/main)/[encode.py](https://github.com/MMDocRAG/MMDocIR/blob/main/encode.py) and [inference command](https://github.com/MMDocRAG/MMDocIR?tab=readme-ov-file#3-inference-command).
+
+If you want to encode your own queries/pages/layouts with these retrievers, some simple demo codes are:
+
+- **For text retrievers**:
+
+  ```python
+  From text_wrapper import DPR, BGE, GTE, E5, ColBERTReranker, Contriever
+  
+  retriever = E5()
+  query = ['how much protein should a child consume', 'What is the CDC requirements for women?']
+  passage = [
+      "As a general guideline, the CDC's average requirement of protein for women ages 19 to 70 is 46 grams per day. But, as you can see from this chart, you'll need to increase that if you're expecting or training for a marathon. Check out the chart below to see how much protein you should be eating each day.",
+      "Definition of summit for English Language Learners. : 1  the highest point of a mountain : the top of a mountain. : 2  the highest level. : 3  a meeting or series of meetings between the leaders of two or more governments.",
+      "Definition of summit for English Language Learners. : 1  the highest point of a mountain : the top of a mountain. : 2  the highest level. : 3  a meeting or series of meetings between the leaders of two or more governments."
+  ]
+  query_embeds = retriever.embed_queries(query)
+  passage_embeds = retriever.embed_quotes(passage)
+  scores = retriever.score(query, passage)
+  print(scores)
+  ```
+
+- **For image retrievers**:
+
+  ```python
+  From vision_wrapper import DSE, ColQwen2Retriever, ColPaliRetriever
+  
+  retriever = DSE(model_name="checkpoint/dse-phi3-v1", bs=2)
+  
+  query = ['how much protein should a child consume', 'What is the CDC requirements for women?']
+  prefix = "/home/user/xxx"
+  images = [
+      "0704.0418_1.jpg",
+      "0704.0418_2.jpg",
+      "0704.0418_3.jpg",
+      "0705.1104_0.jpg",
+      "0705.1104_1.jpg",
+      "0705.1104_2.jpg",
+      "0704.0418_1.jpg",
+      "0704.0418_2.jpg",
+      "0704.0418_3.jpg",
+      "0705.1104_0.jpg",
+      "0705.1104_1.jpg",
+      "0705.1104_2.jpg",
+  ]
+  images = [Image.open(prefix+x) for x in images]
+  q_embeds = retriever.embed_queries(queries)
+  img_embeds = retriever.embed_quotes(images)
+  
+  scores = retriever.score(q_embeds, img_embeds)
+  print(scores)
+  ```
+
+
+
 
 ## 💾Citation
 If you use any datasets or models from this organization in your research, please cite our work as follows: