Update README.md
Browse files
README.md
CHANGED
@@ -226,14 +226,14 @@ After training (or using pre-trained weights), extract features using [`extract_
|
|
226 |
```bash
|
227 |
accelerate launch extract_clamp3.py --epoch <epoch> <input_dir> <output_dir> [--get_global]
|
228 |
```
|
229 |
-
- **`--epoch <epoch>`:** (Optional) Specify the checkpoint epoch.
|
230 |
-
- **`<input_dir>`:** Directory containing the input files.
|
231 |
-
- **`<output_dir>`:** Destination folder for the output `.npy` features.
|
232 |
-
- **`--get_global`**: (
|
233 |
|
234 |
All extracted features are stored as `.npy` files.
|
235 |
|
236 |
-
> **Note**:
|
237 |
|
238 |
### **Retrieval and Classification**
|
239 |
#### **1. Semantic Search**
|
|
|
226 |
```bash
|
227 |
accelerate launch extract_clamp3.py --epoch <epoch> <input_dir> <output_dir> [--get_global]
|
228 |
```
|
229 |
+
- **`--epoch <epoch>`:** (Optional) Specify the checkpoint epoch.
|
230 |
+
- **`<input_dir>`:** Directory containing the input files.
|
231 |
+
- **`<output_dir>`:** Destination folder for the output `.npy` features.
|
232 |
+
- **`--get_global`**: **(Required for retrieval!)** Extracts a **global semantic vector** for each input.
|
233 |
|
234 |
All extracted features are stored as `.npy` files.
|
235 |
|
236 |
+
> **Note**: For retrieval, `--get_global` must be used. Without it, CLaMP 3 will not work correctly for retrieval tasks. You only omit `--get_global` if you are performing downstream fine-tuning or need raw feature extraction for custom tasks.
|
237 |
|
238 |
### **Retrieval and Classification**
|
239 |
#### **1. Semantic Search**
|