File size: 4,728 Bytes
318f189 baa1156 318f189 baa1156 318f189 baa1156 318f189 baa1156 318f189 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 | #!/usr/bin/env python3
"""Build the Hugging Face dataset card from repository metadata."""
from __future__ import annotations
import argparse
import json
import re
import sys
from collections import Counter
from pathlib import Path
ROOT = Path(__file__).resolve().parents[1]
HEADER = ROOT / "meta" / "hf_card_header.yaml"
BODY = ROOT / "meta" / "hf_card_body.md"
RESOURCES = ROOT / "data" / "resources.jsonl"
CITATION = ROOT / "CITATION.cff"
REQUIRED_METADATA = (
"license",
"language",
"pretty_name",
"size_categories",
"task_categories",
"tags",
"configs",
)
TOKEN_RE = re.compile(r"\{\{([A-Z0-9_]+)\}\}")
def load_rows() -> list[dict[str, str]]:
return [json.loads(line) for line in RESOURCES.read_text(encoding="utf-8").splitlines() if line.strip()]
def project_context() -> dict[str, str]:
rows = load_rows()
statuses = Counter(row.get("source_status", "") for row in rows)
resource_types = Counter(row.get("resource_type", "") for row in rows)
loop_layers = Counter(row.get("loop_layer", "") for row in rows)
audit_dates = sorted({row.get("audited_at", "")[:10] for row in rows if row.get("audited_at")})
version_match = re.search(r"^version:\s*([^\s]+)\s*$", CITATION.read_text(encoding="utf-8"), re.MULTILINE)
patterns = [path for path in (ROOT / "patterns").glob("*.md") if path.name not in {"README.md", "MATRIX.md"}]
contracts = list((ROOT / "examples").glob("*-loop.json"))
runnable = [path for path in (ROOT / "examples" / "runnable").iterdir() if path.is_file() and path.name != "README.md"]
executable = [path for path in runnable if path.suffix != ".md"]
runtime_templates = [path for path in runnable if path.suffix == ".md"]
language_count = 1 + len(list(ROOT.glob("README.*.md")))
return {
"RESOURCE_COUNT": str(len(rows)),
"PAPER_COUNT": str(resource_types["Paper"]),
"MODEL_COUNT": str(loop_layers["model"]),
"MODEL_PAPER_COUNT": str(sum(row.get("loop_layer") == "model" and row.get("resource_type") == "Paper" for row in rows)),
"FIELD_COUNT": str(len(rows[0]) if rows else 0),
"REACHABLE_COUNT": str(statuses["ok"]),
"RESTRICTED_COUNT": str(statuses["restricted"]),
"LOCAL_COUNT": str(statuses["local_ok"]),
"BROKEN_COUNT": str(sum(statuses[key] for key in ("broken", "unreachable", "local_missing"))),
"AUDIT_DATE": audit_dates[-1] if audit_dates else "not recorded",
"PATTERN_COUNT": str(len(patterns)),
"CONTRACT_COUNT": str(len(contracts)),
"RUNNABLE_COUNT": str(len(runnable)),
"EXECUTABLE_COUNT": str(len(executable)),
"RUNTIME_TEMPLATE_COUNT": str(len(runtime_templates)),
"LANGUAGE_COUNT": str(language_count),
"VERSION": version_match.group(1) if version_match else "unversioned",
}
def validate_header(header: str) -> list[str]:
failures: list[str] = []
lines = header.strip().splitlines()
if len(lines) < 3 or lines[0] != "---" or lines[-1] != "---":
failures.append("meta/hf_card_header.yaml must be wrapped in YAML front matter delimiters")
for key in REQUIRED_METADATA:
if not re.search(rf"^{re.escape(key)}:\s*", header, re.MULTILINE):
failures.append(f"meta/hf_card_header.yaml is missing {key}")
return failures
def render_card() -> tuple[str, list[str]]:
header = HEADER.read_text(encoding="utf-8").strip()
body = BODY.read_text(encoding="utf-8")
context = project_context()
failures = validate_header(header)
rendered = TOKEN_RE.sub(lambda match: context.get(match.group(1), match.group(0)), body)
unresolved = sorted(set(TOKEN_RE.findall(rendered)))
if unresolved:
failures.append("unresolved dataset-card tokens: " + ", ".join(unresolved))
return f"{header}\n\n{rendered.lstrip()}", failures
def main() -> int:
parser = argparse.ArgumentParser(description=__doc__)
parser.add_argument("--check", action="store_true", help="validate the card template without writing it")
parser.add_argument("--output", type=Path, help="write the rendered card to this path")
args = parser.parse_args()
card, failures = render_card()
if failures:
print("Hugging Face dataset card check failed:", file=sys.stderr)
for failure in failures:
print(f"- {failure}", file=sys.stderr)
return 1
if args.check:
return 0
if args.output:
args.output.parent.mkdir(parents=True, exist_ok=True)
args.output.write_text(card, encoding="utf-8")
print(f"Wrote {args.output}")
else:
sys.stdout.write(card)
return 0
if __name__ == "__main__":
raise SystemExit(main())
|