Update README.md
Browse files
README.md
CHANGED
@@ -42,6 +42,8 @@ configs:
|
|
42 |
### **UniIR: Training and Benchmarking Universal Multimodal Information Retrievers**
|
43 |
[**🌐 Homepage**](https://tiger-ai-lab.github.io/UniIR/) | [**🤗 Paper**](https://huggingface.co/papers/2311.17136) | [**📖 arXiv**](https://arxiv.org/pdf/2311.17136.pdf) | [**GitHub**](https://github.com/TIGER-AI-Lab/UniIR)
|
44 |
|
|
|
|
|
45 |
## 🔔News
|
46 |
|
47 |
- **🔥[2023-12-21]: Our M-BEIR Benchmark is now available for use.**
|
@@ -152,8 +154,23 @@ Within the `qrels` directory, you will find qrels for both the validation and te
|
|
152 |
|
153 |
## **How to Use**
|
154 |
### Downloading the M-BEIR Dataset
|
155 |
-
|
156 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
157 |
|
158 |
### Decompressing M-BEIR Images
|
159 |
After downloading, you will need to decompress the image files. Follow these steps in your terminal:
|
|
|
42 |
### **UniIR: Training and Benchmarking Universal Multimodal Information Retrievers**
|
43 |
[**🌐 Homepage**](https://tiger-ai-lab.github.io/UniIR/) | [**🤗 Paper**](https://huggingface.co/papers/2311.17136) | [**📖 arXiv**](https://arxiv.org/pdf/2311.17136.pdf) | [**GitHub**](https://github.com/TIGER-AI-Lab/UniIR)
|
44 |
|
45 |
+
<a href="#install-git-lfs" style="color: red;">How to download the M-BEIR Dataset</a>
|
46 |
+
|
47 |
## 🔔News
|
48 |
|
49 |
- **🔥[2023-12-21]: Our M-BEIR Benchmark is now available for use.**
|
|
|
154 |
|
155 |
## **How to Use**
|
156 |
### Downloading the M-BEIR Dataset
|
157 |
+
<a name="install-git-lfs"></a>
|
158 |
+
#### Step 1: Install Git Large File Storage (LFS)
|
159 |
+
Before you begin, ensure that **Git LFS** is installed on your system. Git LFS is essential for handling large data files. If you do not have Git LFS installed, follow these steps:
|
160 |
+
|
161 |
+
Download and install Git LFS from the official website.
|
162 |
+
After installation, run the following command in your terminal to initialize Git LFS:
|
163 |
+
```
|
164 |
+
git lfs install
|
165 |
+
```
|
166 |
+
|
167 |
+
#### Step 2: Clone the M-BEIR Dataset Repository
|
168 |
+
Once Git LFS is set up, you can clone the M-BEIR repo from the current Page. Open your terminal and execute the following command:
|
169 |
+
```
|
170 |
+
git clone https://huggingface.co/datasets/TIGER-Lab/M-BEIR
|
171 |
+
```
|
172 |
+
Please note that the M-BEIR dataset is quite large, and downloading it can take several hours, depending on your internet connection.
|
173 |
+
During this time, your terminal may not show much activity. The terminal might appear stuck, but if there's no error message, the download process is still ongoing.
|
174 |
|
175 |
### Decompressing M-BEIR Images
|
176 |
After downloading, you will need to decompress the image files. Follow these steps in your terminal:
|