hotchpotch commited on
Commit
056273f
·
verified ·
1 Parent(s): fc84fb7

Add leaderboard database README

Browse files

Add an English dataset card explaining that the leaderboard database is a DuckDB transformation of the raw hakari-bench/results artifacts, how it is built from the GitHub scripts, how the leaderboard consumes it, and where to find the official result submission workflow.

Files changed (1) hide show
  1. README.md +90 -0
README.md ADDED
@@ -0,0 +1,90 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ pretty_name: HAKARI-Bench Leaderboard Database
3
+ tags:
4
+ - information-retrieval
5
+ - retrieval
6
+ - benchmark
7
+ - duckdb
8
+ - leaderboard
9
+ - evaluation
10
+ ---
11
+
12
+ # HAKARI-Bench Leaderboard Database
13
+
14
+ This dataset publishes the DuckDB database used by the HAKARI-Bench
15
+ leaderboard. It is a transformed, leaderboard-ready view of the raw benchmark
16
+ result files stored in [`hakari-bench/results`](https://huggingface.co/datasets/hakari-bench/results).
17
+
18
+ The raw results dataset is the source of truth: it stores per-task compressed
19
+ JSON result artifacts generated by HAKARI-Bench. This dataset repackages those
20
+ raw artifacts into `duckdb/hakari_bench.duckdb` so the leaderboard, notebooks,
21
+ and SQL-based analysis can query model scores, task metadata, variants,
22
+ runtime metadata, and precomputed viewer tables efficiently.
23
+
24
+ ## Contents
25
+
26
+ - `duckdb/hakari_bench.duckdb`: the current HAKARI-Bench leaderboard DuckDB
27
+ warehouse.
28
+
29
+ The database schema and leaderboard query conventions are documented in the
30
+ GitHub repository:
31
+
32
+ - [DuckDB schema and leaderboard query guide](https://github.com/hakari-bench/hakari-bench/blob/main/docs/duckdb_schema.md)
33
+ - [Leaderboard metric policy](https://github.com/hakari-bench/hakari-bench/blob/main/docs/leaderboard_metrics.md)
34
+
35
+ ## How This Dataset Is Built
36
+
37
+ The DuckDB file is generated by scripts in
38
+ [`hakari-bench/hakari-bench`](https://github.com/hakari-bench/hakari-bench).
39
+ The usual build path syncs the raw results dataset and rebuilds the database:
40
+
41
+ ```bash
42
+ uv run python scripts/sync_remote_results_and_rebuild.py --sync-backend xet
43
+ ```
44
+
45
+ The lower-level builder can also create or append a database from local result
46
+ directories:
47
+
48
+ ```bash
49
+ uv run python scripts/build_results_database_and_report.py \
50
+ --results-dir output/hakari-results \
51
+ --duckdb-path output/hakari-results/hakari_bench.duckdb
52
+ ```
53
+
54
+ See the [evaluation runbook](https://github.com/hakari-bench/hakari-bench/blob/main/docs/evaluation_runbook.md)
55
+ for the full rebuild, append, cache, and viewer workflow.
56
+
57
+ ## How It Is Used
58
+
59
+ The public leaderboard consumes this dataset:
60
+
61
+ - [HAKARI-Bench Leaderboard Space](https://huggingface.co/spaces/hakari-bench/leaderboard)
62
+
63
+ The HAKARI-Bench viewer can download the DuckDB directly from this dataset:
64
+
65
+ ```bash
66
+ uv run hakari-bench web \
67
+ --hf-dataset-repo-id hakari-bench/leaderboard_database \
68
+ --hf-dataset-path duckdb/hakari_bench.duckdb
69
+ ```
70
+
71
+ ## Contributing Official Results
72
+
73
+ To add model evaluation results to the official HAKARI-Bench data flow, submit
74
+ the raw `.json.xz` result files to
75
+ [`hakari-bench/results`](https://huggingface.co/datasets/hakari-bench/results).
76
+ After raw results are reviewed and merged, this leaderboard database can be
77
+ rebuilt from those files.
78
+
79
+ Use the GitHub workflow for evaluating a new model and preparing an official
80
+ results submission:
81
+
82
+ - [New model evaluation to results PR workflow](https://github.com/hakari-bench/hakari-bench/blob/main/docs/new_model_results_workflow.md)
83
+ - [Contributing result files](https://github.com/hakari-bench/hakari-bench/blob/main/docs/contributing_results.md)
84
+
85
+ ## Related Resources
86
+
87
+ - [HAKARI-Bench GitHub repository](https://github.com/hakari-bench/hakari-bench)
88
+ - [Raw result artifacts dataset](https://huggingface.co/datasets/hakari-bench/results)
89
+ - [Leaderboard database dataset](https://huggingface.co/datasets/hakari-bench/leaderboard_database)
90
+ - [Leaderboard Space](https://huggingface.co/spaces/hakari-bench/leaderboard)