zhouchangda commited on
Commit
1963b36
·
1 Parent(s): bffdba5

Clean public benchmark docs

Browse files
hf_eval_results/HF_UPSTREAM_REQUEST.md DELETED
@@ -1,92 +0,0 @@
1
- # Requesting `real5-omnidocbench` Support Upstream
2
-
3
- To make the Hugging Face native Benchmark UI recognize this benchmark, Hugging Face needs to add a new evaluation framework identifier:
4
-
5
- ```text
6
- real5-omnidocbench
7
- ```
8
-
9
- The relevant upstream enum is currently in:
10
-
11
- ```text
12
- https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/eval.ts
13
- ```
14
-
15
- ## Proposed Enum Entry
16
-
17
- ```ts
18
- "real5-omnidocbench": {
19
- name: "real5-omnidocbench",
20
- description:
21
- "Real5-OmniDocBench is a real-world document parsing robustness benchmark covering five physical acquisition scenarios: Scanning, Warping, Screen-Photography, Illumination, and Skew.",
22
- url: "https://huggingface.co/datasets/PaddlePaddle/Real5-OmniDocBench",
23
- },
24
- ```
25
-
26
- ## Dataset Configuration
27
-
28
- The dataset repository already contains a root `eval.yaml` using the requested framework:
29
-
30
- ```yaml
31
- name: Real5-OmniDocBench
32
- description: >
33
- Real5-OmniDocBench is a real-world document parsing robustness benchmark
34
- covering five physical acquisition scenarios: Scanning, Warping,
35
- Screen-Photography, Illumination, and Skew.
36
- evaluation_framework: real5-omnidocbench
37
-
38
- tasks:
39
- - id: overall
40
- config: default
41
- split: test
42
- - id: scanning
43
- config: default
44
- split: test
45
- - id: warping
46
- config: default
47
- split: test
48
- - id: screen_photography
49
- config: default
50
- split: test
51
- - id: illumination
52
- config: default
53
- split: test
54
- - id: skew
55
- config: default
56
- split: test
57
- ```
58
-
59
- ## Message Template
60
-
61
- ```text
62
- Hi Hugging Face team,
63
-
64
- We would like to add a new Hub Benchmark evaluation framework:
65
-
66
- real5-omnidocbench
67
-
68
- Dataset:
69
- https://huggingface.co/datasets/PaddlePaddle/Real5-OmniDocBench
70
-
71
- Paper:
72
- https://arxiv.org/abs/2603.04205
73
-
74
- Reason:
75
- Real5-OmniDocBench evaluates document parsing robustness under five real-world acquisition scenarios: Scanning, Warping, Screen-Photography, Illumination, and Skew. Existing framework identifiers such as olmocr-bench, mdpbench, and parsebench do not identify this benchmark directly.
76
-
77
- Proposed enum entry:
78
-
79
- "real5-omnidocbench": {
80
- name: "real5-omnidocbench",
81
- description:
82
- "Real5-OmniDocBench is a real-world document parsing robustness benchmark covering five physical acquisition scenarios: Scanning, Warping, Screen-Photography, Illumination, and Skew.",
83
- url: "https://huggingface.co/datasets/PaddlePaddle/Real5-OmniDocBench",
84
- }
85
-
86
- The dataset root eval.yaml already uses:
87
- evaluation_framework: real5-omnidocbench
88
-
89
- Could you add this framework identifier to the supported enum and add the dataset to the Benchmark allow-list so the native Benchmark Leaderboard UI can appear?
90
-
91
- Thanks.
92
- ```
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
hf_eval_results/README.md CHANGED
@@ -1,34 +1,7 @@
1
- # Hugging Face Eval Results Support
2
 
3
- This directory prepares Real5-OmniDocBench for Hugging Face's model-side
4
- `.eval_results/*.yaml` mechanism.
5
-
6
- ## Current Support Status
7
-
8
- Not fully enabled on the Hub yet.
9
-
10
- Hugging Face Evaluation Results require:
11
-
12
- 1. The dataset repo to have a root `eval.yaml`.
13
- 2. The `evaluation_framework` in that file to be one of Hugging Face's supported framework identifiers.
14
- 3. The benchmark dataset to be accepted by the beta allow-list.
15
- 4. Model repos to submit `.eval_results/*.yaml` files that reference this dataset and task IDs.
16
-
17
- As of July 11, 2026, Hugging Face documents this feature as work in progress and benchmark registration as beta / allow-listed. The supported framework enum currently includes document-related frameworks such as `olmocr-bench`, `mdpbench`, and `parsebench`, but not `real5-omnidocbench`.
18
-
19
- The intended framework identifier for this benchmark is:
20
-
21
- ```yaml
22
- evaluation_framework: real5-omnidocbench
23
- ```
24
-
25
- Hugging Face must add this identifier to its supported evaluation framework enum before the Hub can fully recognize the dataset as a native benchmark.
26
-
27
- For that reason, the repository includes the target framework name explicitly so the upstream request is unambiguous. If the Hub rejects or ignores the framework before upstream support lands, keep the file as the desired target state and reference it in the Hugging Face support request.
28
-
29
- ## Dataset-Side Candidate
30
-
31
- `eval.yaml.candidate` defines six Hub leaderboard tasks:
32
 
33
  - `overall`
34
  - `scanning`
@@ -37,7 +10,8 @@ For that reason, the repository includes the target framework name explicitly so
37
  - `illumination`
38
  - `skew`
39
 
40
- These correspond to the six score columns in the README Overall table. All six are "higher is better" scores in the current benchmark presentation.
 
41
 
42
  ## Model-Side Submission Format
43
 
@@ -66,7 +40,8 @@ Each YAML list item reports one task:
66
 
67
  ## Generate Files From Current README Data
68
 
69
- The static leaderboard data must already be generated from the external source file:
 
70
 
71
  ```bash
72
  python leaderboard/scripts/build_from_source_data.py
@@ -92,4 +67,7 @@ python hf_eval_results/scripts/validate_eval_results.py hf_eval_results/generate
92
 
93
  ## Important Limitation
94
 
95
- The Hub `.eval_results` schema stores one numeric `value` per dataset task. It does not directly encode the full multi-metric rows from the README tables. This support therefore maps the Hub-native leaderboard to the six primary Overall-table scores. The richer scenario-level metrics such as `TextEdit`, `FormulaCDM`, `TableTEDS`, and `Reading OrderEdit` remain available in the Static Space leaderboard.
 
 
 
 
1
+ # Hugging Face Eval Results
2
 
3
+ Real5-OmniDocBench defines six Hub leaderboard tasks in the repository root
4
+ `eval.yaml`:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
5
 
6
  - `overall`
7
  - `scanning`
 
10
  - `illumination`
11
  - `skew`
12
 
13
+ These correspond to the primary scores shown in the benchmark leaderboard. All
14
+ six are higher-is-better metrics.
15
 
16
  ## Model-Side Submission Format
17
 
 
40
 
41
  ## Generate Files From Current README Data
42
 
43
+ The Space leaderboard data must already be generated from the external source
44
+ file:
45
 
46
  ```bash
47
  python leaderboard/scripts/build_from_source_data.py
 
67
 
68
  ## Important Limitation
69
 
70
+ The Hub `.eval_results` schema stores one numeric `value` per dataset task.
71
+ This repository uses the six primary task scores for Hub-native submissions.
72
+ The richer scenario-level metrics remain available in the Static Space
73
+ leaderboard.
hf_eval_results/eval.yaml.candidate DELETED
@@ -1,26 +0,0 @@
1
- name: Real5-OmniDocBench
2
- description: >
3
- Real5-OmniDocBench is a real-world document parsing robustness benchmark
4
- covering five physical acquisition scenarios: Scanning, Warping,
5
- Screen-Photography, Illumination, and Skew.
6
- evaluation_framework: real5-omnidocbench
7
-
8
- tasks:
9
- - id: overall
10
- config: default
11
- split: test
12
- - id: scanning
13
- config: default
14
- split: test
15
- - id: warping
16
- config: default
17
- split: test
18
- - id: screen_photography
19
- config: default
20
- split: test
21
- - id: illumination
22
- config: default
23
- split: test
24
- - id: skew
25
- config: default
26
- split: test
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
leaderboard/DEPLOY.md CHANGED
@@ -41,14 +41,11 @@ Hugging Face also has a Hub-level Evaluation Results feature. In that flow:
41
  2. Each model repository publishes scores in `.eval_results/*.yaml`.
42
  3. Hugging Face aggregates the model results back onto the benchmark dataset page.
43
 
44
- This is better for decentralized community submissions, but it requires model repositories to publish result files and the benchmark feature is currently marked as work in progress / beta allow-listed in the official docs.
45
 
46
  For this benchmark, the current README already has complete published tables, so the Static Space is the lowest-friction path.
47
 
48
  The repository also includes `hf_eval_results/` with:
49
 
50
- - `eval.yaml.candidate` for the dataset-side benchmark registration.
51
  - `examples/model_eval_results.yaml` for model repositories.
52
  - scripts to generate and validate `.eval_results/*.yaml` files from the README-derived leaderboard data.
53
-
54
- Do not move `hf_eval_results/eval.yaml.candidate` to the dataset repository root as `eval.yaml` until Hugging Face confirms the benchmark allow-list and evaluation framework choice.
 
41
  2. Each model repository publishes scores in `.eval_results/*.yaml`.
42
  3. Hugging Face aggregates the model results back onto the benchmark dataset page.
43
 
44
+ This is useful for decentralized community submissions, and it requires model repositories to publish result files.
45
 
46
  For this benchmark, the current README already has complete published tables, so the Static Space is the lowest-friction path.
47
 
48
  The repository also includes `hf_eval_results/` with:
49
 
 
50
  - `examples/model_eval_results.yaml` for model repositories.
51
  - scripts to generate and validate `.eval_results/*.yaml` files from the README-derived leaderboard data.
 
 
leaderboard/README.md CHANGED
@@ -29,4 +29,4 @@ The generated `leaderboard/data/` directory is ignored by the dataset repository
29
  Hugging Face supports leaderboard-style presentation in two relevant ways:
30
 
31
  - Community managed leaderboards live on Spaces and are appropriate for benchmark pages with custom tables and filters.
32
- - Evaluation Results are a Hub-level benchmark feature where a dataset repo defines `eval.yaml` and model repos publish `.eval_results/*.yaml`; this is currently marked as work in progress and beta allow-listed.
 
29
  Hugging Face supports leaderboard-style presentation in two relevant ways:
30
 
31
  - Community managed leaderboards live on Spaces and are appropriate for benchmark pages with custom tables and filters.
32
+ - Evaluation Results are a Hub-level benchmark feature where a dataset repo defines `eval.yaml` and model repos publish `.eval_results/*.yaml`.