update eval args

Author: 545999961

FlagEmbedding/abc/evaluation/arguments.py

@@ -86,7 +86,7 @@ class AbsEvalModelArgs:
     normalize_embeddings: bool = field(
         default=True, metadata={"help": "whether to normalize the embeddings"}
     )
-    pooling_method: bool = field(
+    pooling_method: str = field(
         default="cls", metadata={"help": "The pooling method fot the embedder."}
     )
     use_fp16: bool = field(

examples/README.md

@@ -139,6 +139,7 @@ torchrun --nproc_per_node 2 \
 We support evaluations on [MTEB](https://github.com/embeddings-benchmark/mteb), [BEIR](https://github.com/beir-cellar/beir), [MSMARCO](https://microsoft.github.io/msmarco/), [MIRACL](https://github.com/project-miracl/miracl), [MLDR](https://huggingface.co/datasets/Shitao/MLDR), [MKQA](https://github.com/apple/ml-mkqa), [AIR-Bench](https://github.com/AIR-Bench/AIR-Bench), and custom datasets. Below is an example of evaluating MSMARCO passages. For more details, please refer to the [evaluation examples](https://github.com/FlagOpen/FlagEmbedding/tree/master/examples/evaluation).
 
 ```shell
+pip install pytrec_eval
 pip install https://github.com/kyamagu/faiss-wheels/releases/download/v1.7.3/faiss_gpu-1.7.3-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
 ```
 

examples/evaluation/README.md

@@ -86,9 +86,10 @@ In this section, we will first introduce the commonly used arguments across all
 
 ### Requirements
 
-You need install faiss for evaluation:
+You need install `pytrec_eval` and `faiss` for evaluation:
 
 ```shell
+pip install pytrec_eval
 pip install https://github.com/kyamagu/faiss-wheels/releases/download/v1.7.3/faiss_gpu-1.7.3-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
 ```