Update README.md

README.md

@@ -15,136 +15,25 @@ size_categories:
 
 <!-- Provide a quick summary of the dataset. -->
 
-This dataset card aims to be a base template for new datasets. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md?plain=1).
+近年来，在文本检索领域已有大量相关工作，但现有工作大多分散在不同的数据集上，且结果对比片面，缺少一个较为全面的文本检索性能指标测试基准。  
+本项目旨在为大模型增强的文本检索建立可复现的基准：在统一的数据与流水线下比较传统 BM25 与向量检索的性能指标，并检验“重写 + 向量化”过程中各环节的贡献。
 
-## Dataset Details
-
-### Dataset Description
+## Dataset Description
 
 <!-- Provide a longer summary of what this dataset is. -->
 
+项目数据集来自 2 个开放数据集：
+- Multi-CPR：包含三个应用场景（医疗、电商、视频），数据格式为单轮问答
+- LexRAG：包含中文法律咨询场景，数据格式为多轮对话
 
+我们从multi-CPR数据集的3个场景中分别提取了1000条query和约10000条corpus，并以对应的索引作为groundtruth。
 
-- **Curated by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-
-### Dataset Sources [optional]
-
-<!-- Provide the basic links for the dataset. -->
-
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-
-## Uses
-
-<!-- Address questions around how the dataset is intended to be used. -->
-
-### Direct Use
-
-<!-- This section describes suitable use cases for the dataset. -->
-
-[More Information Needed]
-
-### Out-of-Scope Use
-
-<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
-
-[More Information Needed]
-
-## Dataset Structure
-
-<!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
-
-[More Information Needed]
-
-## Dataset Creation
-
-### Curation Rationale
-
-<!-- Motivation for the creation of this dataset. -->
-
-[More Information Needed]
-
-### Source Data
-
-<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
-
-#### Data Collection and Processing
-
-<!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
-
-[More Information Needed]
-
-#### Who are the source data producers?
-
-<!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
-
-[More Information Needed]
-
-### Annotations [optional]
-
-<!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
-
-#### Annotation process
-
-<!-- This section describes the annotation process such as annotation tools used in the process, the amount of data annotated, annotation guidelines provided to the annotators, interannotator statistics, annotation validation, etc. -->
-
-[More Information Needed]
-
-#### Who are the annotators?
-
-<!-- This section describes the people or systems who created the annotations. -->
-
-[More Information Needed]
-
-#### Personal and Sensitive Information
-
-<!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->
-
-[More Information Needed]
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
-
-## Citation [optional]
-
-<!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
-
-**BibTeX:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
+对于LexRAG数据集，我们选取了其中的对话历史+最新问题场景，即，每次用于query的文本等于该次会话的前面所有轮次问答历史+当前最新一轮的提问。
 
-## Dataset Card Authors [optional]
+数据已经完成清洗和预处理，可直接用作重写和评估脚本的输入。
 
-[More Information Needed]
+query数据存放在`.\data\rawData\xxx_query.txt`
 
-## Dataset Card Contact
+passage数据`.\data\rawData\xxx_subset.tsv`
 
-[More Information Needed]
+groundtruth标签/索引存放在`.\data\qrelData\xxx_dev.tsv`