Simplify dataset card and link to GitHub usage documentation
Browse files
README.md
CHANGED
|
@@ -282,8 +282,6 @@ Dependencies are checked for necessity and non-leakage, and answers must be visu
|
|
| 282 |
</table>
|
| 283 |
</div>
|
| 284 |
|
| 285 |
-
Main results from **Table 2** of the manuscript. All model scores use 128 fixed frames and sequential self-rollout. Scores are percentages; higher is better.
|
| 286 |
-
|
| 287 |
### Evaluation with fewer frames
|
| 288 |
|
| 289 |
13 open-weight models evaluated with 64 or 32 fixed frames per video.
|
|
@@ -542,153 +540,7 @@ Main results from **Table 2** of the manuscript. All model scores use 128 fixed
|
|
| 542 |
|
| 543 |
**Table 4** · Fixed frames and sequential self-rollout. Scores are percentages. [Compare frame counts on the project page →](https://videomembench.github.io/#frame-results)
|
| 544 |
|
| 545 |
-
|
| 546 |
-
|
| 547 |
-
The repository contains one evaluation split, `test`:
|
| 548 |
-
|
| 549 |
-
```text
|
| 550 |
-
annotations.jsonl # 326 video-level dialogue records
|
| 551 |
-
videos/
|
| 552 |
-
videomembench-1.mp4
|
| 553 |
-
...
|
| 554 |
-
videomembench-326.mp4
|
| 555 |
-
```
|
| 556 |
-
|
| 557 |
-
### Load annotations
|
| 558 |
-
|
| 559 |
-
```bash
|
| 560 |
-
pip install huggingface_hub
|
| 561 |
-
```
|
| 562 |
-
|
| 563 |
-
```python
|
| 564 |
-
import json
|
| 565 |
-
from huggingface_hub import hf_hub_download
|
| 566 |
-
|
| 567 |
-
annotation_path = hf_hub_download(
|
| 568 |
-
repo_id="VideoMemBench/data",
|
| 569 |
-
repo_type="dataset",
|
| 570 |
-
filename="annotations.jsonl",
|
| 571 |
-
)
|
| 572 |
-
with open(annotation_path, encoding="utf-8") as source:
|
| 573 |
-
dialogues = [json.loads(line) for line in source if line.strip()]
|
| 574 |
-
|
| 575 |
-
print(len(dialogues)) # 326
|
| 576 |
-
print(dialogues[0]["video_path"])
|
| 577 |
-
print(dialogues[0]["dialogue"][0]["question"])
|
| 578 |
-
```
|
| 579 |
-
|
| 580 |
-
### Download videos for evaluation
|
| 581 |
-
|
| 582 |
-
The full video collection is approximately **146.5 GB** (136.4 GiB). The following downloads the annotations and videos together:
|
| 583 |
-
|
| 584 |
-
```python
|
| 585 |
-
from huggingface_hub import snapshot_download
|
| 586 |
-
|
| 587 |
-
data_dir = snapshot_download(
|
| 588 |
-
repo_id="VideoMemBench/data",
|
| 589 |
-
repo_type="dataset",
|
| 590 |
-
local_dir="data",
|
| 591 |
-
allow_patterns=["annotations.jsonl", "videos/*.mp4"],
|
| 592 |
-
)
|
| 593 |
-
```
|
| 594 |
-
|
| 595 |
-
Downloads use your local Hugging Face authentication when access is required.
|
| 596 |
-
|
| 597 |
-
## Data format
|
| 598 |
-
|
| 599 |
-
`annotations.jsonl` is UTF-8 JSONL: each line contains one video and its ordered dialogue.
|
| 600 |
-
|
| 601 |
-
| Field | Description |
|
| 602 |
-
| --- | --- |
|
| 603 |
-
| `video_id` | Unique video identifier, such as `videomembench-1`. |
|
| 604 |
-
| `video_name` | Video filename, such as `videomembench-1.mp4`. |
|
| 605 |
-
| `video_path` | Path relative to the repository root, such as `videos/videomembench-1.mp4`. |
|
| 606 |
-
| `dialogue` | Questions in their original conversation order. |
|
| 607 |
-
| `dialogue[].turn_id` | Turn identifier within the dialogue (`T1`, `T2`, ...). |
|
| 608 |
-
| `dialogue[].type` | `open_structured`, `multi_choice_question`, or `true_or_false_question`. |
|
| 609 |
-
| `dialogue[].question` | Question text. |
|
| 610 |
-
| `dialogue[].options` | Lettered options for multiple-choice questions; `null` otherwise. |
|
| 611 |
-
| `dialogue[].answer` | Option key, a True/False reference, or a free-form reference answer. |
|
| 612 |
-
| `dialogue[].dependency` | `null` for an independent turn; otherwise the parent IDs and dependency types. |
|
| 613 |
-
|
| 614 |
-
A dependency object contains `depends_on`, a list of earlier turn IDs, and `dep_type`, which maps each parent ID to `episodic` or `answer`. Preserve turn order during evaluation. Reference answers and dependency labels are evaluation metadata and must not be supplied to the answering model.
|
| 615 |
-
|
| 616 |
-
<details>
|
| 617 |
-
<summary><strong>Example record structure</strong></summary>
|
| 618 |
-
|
| 619 |
-
The placeholder text below illustrates the structure and is not a benchmark question. JSONL stores each record on one line; it is expanded here for readability.
|
| 620 |
-
|
| 621 |
-
```json
|
| 622 |
-
{
|
| 623 |
-
"video_id": "videomembench-1",
|
| 624 |
-
"video_name": "videomembench-1.mp4",
|
| 625 |
-
"video_path": "videos/videomembench-1.mp4",
|
| 626 |
-
"dialogue": [
|
| 627 |
-
{
|
| 628 |
-
"turn_id": "T1",
|
| 629 |
-
"type": "open_structured",
|
| 630 |
-
"dependency": null,
|
| 631 |
-
"question": "<independent question>",
|
| 632 |
-
"options": null,
|
| 633 |
-
"answer": "<reference answer>"
|
| 634 |
-
},
|
| 635 |
-
{
|
| 636 |
-
"turn_id": "T2",
|
| 637 |
-
"type": "multi_choice_question",
|
| 638 |
-
"dependency": {
|
| 639 |
-
"depends_on": ["T1"],
|
| 640 |
-
"dep_type": {"T1": "episodic"}
|
| 641 |
-
},
|
| 642 |
-
"question": "<dependent question>",
|
| 643 |
-
"options": {"A": "<option A>", "B": "<option B>", "C": "<option C>", "D": "<option D>"},
|
| 644 |
-
"answer": "C"
|
| 645 |
-
}
|
| 646 |
-
]
|
| 647 |
-
}
|
| 648 |
-
```
|
| 649 |
-
|
| 650 |
-
</details>
|
| 651 |
-
|
| 652 |
-
## Evaluation
|
| 653 |
-
|
| 654 |
-
Use the [official evaluation code](https://github.com/Oliiveralien/VideoMemBench) with Python 3.11 or newer:
|
| 655 |
-
|
| 656 |
-
```bash
|
| 657 |
-
git clone https://github.com/Oliiveralien/VideoMemBench.git
|
| 658 |
-
cd VideoMemBench
|
| 659 |
-
pip install -e .
|
| 660 |
-
```
|
| 661 |
-
|
| 662 |
-
Place the downloaded files under `data/`. The Hub records include `video_path` for locating video files. The evaluation code resolves files from `video_name` and `--video-root`, and its strict validator does not accept the extra `video_path` field. Create an evaluation copy as follows:
|
| 663 |
-
|
| 664 |
-
```python
|
| 665 |
-
import json
|
| 666 |
-
from pathlib import Path
|
| 667 |
-
|
| 668 |
-
data_dir = Path("data")
|
| 669 |
-
with (data_dir / "annotations.jsonl").open(encoding="utf-8") as source, \
|
| 670 |
-
(data_dir / "annotations.eval.jsonl").open("w", encoding="utf-8") as target:
|
| 671 |
-
for line in source:
|
| 672 |
-
if not line.strip():
|
| 673 |
-
continue
|
| 674 |
-
record = json.loads(line)
|
| 675 |
-
record.pop("video_path", None)
|
| 676 |
-
target.write(json.dumps(record, ensure_ascii=False) + "\n")
|
| 677 |
-
```
|
| 678 |
-
|
| 679 |
-
Validate the evaluation copy and prepare the shared 128-frame cache:
|
| 680 |
-
|
| 681 |
-
```bash
|
| 682 |
-
python -m videomembench.data data/annotations.eval.jsonl
|
| 683 |
-
python -m videomembench.video \
|
| 684 |
-
--annotations data/annotations.eval.jsonl \
|
| 685 |
-
--video-root data/videos \
|
| 686 |
-
--frame-cache cache/f128
|
| 687 |
-
```
|
| 688 |
-
|
| 689 |
-
Set the annotation path to `data/annotations.eval.jsonl`, configure the model and judge endpoints in [`configs/evaluation.toml`](https://github.com/Oliiveralien/VideoMemBench/blob/main/configs/evaluation.toml), and follow the repository's inference and scoring instructions.
|
| 690 |
-
|
| 691 |
-
The main evaluation uses 128 uniformly sampled, timestamped frames with a maximum side length of 512 pixels. Models answer turns sequentially while retaining their own full response history. Reference answers, dependencies, audio, and subtitles are not provided to the answering model. Open answers are graded by GPT-5.4 mini. See the [evaluation protocol](https://github.com/Oliiveralien/VideoMemBench/blob/main/docs/PROTOCOL.md) for complete details.
|
| 692 |
|
| 693 |
## License and terms of use
|
| 694 |
|
|
|
|
| 282 |
</table>
|
| 283 |
</div>
|
| 284 |
|
|
|
|
|
|
|
| 285 |
### Evaluation with fewer frames
|
| 286 |
|
| 287 |
13 open-weight models evaluated with 64 or 32 fixed frames per video.
|
|
|
|
| 540 |
|
| 541 |
**Table 4** · Fixed frames and sequential self-rollout. Scores are percentages. [Compare frame counts on the project page →](https://videomembench.github.io/#frame-results)
|
| 542 |
|
| 543 |
+
For download and evaluation instructions, see the [GitHub documentation](https://github.com/Oliiveralien/VideoMemBench#readme).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 544 |
|
| 545 |
## License and terms of use
|
| 546 |
|