Files
ComfyUI-Lora-Manager/tests/enrich_hf_validation/run_validation.py
Will Miao 5494a70f40 chore(tests): commit validation dataset and baseline reports into repo
Move the HF model list from ~/Documents/ into tests/enrich_hf_validation/test_data/
and commit the pipeline validation baseline artifacts (report.json,
preprocessing_audit.json, README snapshots) into baselines/.

Update config.py and run_validation.py defaults to use repo-relative paths
via os.path.dirname(__file__) instead of ~/Documents/ hardcode.

Originates from changes in 8fb00998 (validation pipeline audit).
2026-07-05 17:03:45 +08:00

452 lines
15 KiB
Python

#!/usr/bin/env python3
"""CLI entry point for the HF metadata enrichment validation suite.
Usage::
# Full run (44 models, serial, ~1-2 h)
python -m tests.enrich_hf_validation.run_validation \\
--output /tmp/hf_enrich_validation
# Quick smoke test with 2 models
python -m tests.enrich_hf_validation.run_validation --sample 2
# Resume from a previous partial run
python -m tests.enrich_hf_validation.run_validation --resume
# Audit preprocessing only (no LLM calls, fast)
python -m tests.enrich_hf_validation.run_validation --audit-only
# Custom settings file
python -m tests.enrich_hf_validation.run_validation \\
--settings /custom/path/settings.json
"""
from __future__ import annotations
import argparse
import asyncio
import json
import logging
import os
import sys
import time
from typing import Any, Dict, List, Tuple
# Ensure the project root is on sys.path so that ``from py import ...`` works.
_PROJECT_ROOT = os.path.normpath(
os.path.join(os.path.dirname(__file__), "..", "..")
)
if _PROJECT_ROOT not in sys.path:
sys.path.insert(0, _PROJECT_ROOT)
# Add ComfyUI root to sys.path so ``folder_paths`` can be imported.
# Project layout: ComfyUI/custom_nodes/ComfyUI-Lora-Manager/
_COMFYUI_ROOT = os.path.normpath(os.path.join(_PROJECT_ROOT, "..", ".."))
if _COMFYUI_ROOT not in sys.path:
sys.path.insert(0, _COMFYUI_ROOT)
from tests.enrich_hf_validation.config import (
init_supported_base_models,
load_settings,
)
from tests.enrich_hf_validation.metadata_constructor import (
RepoEntry,
create_all_initial_metadata,
load_repo_ids,
)
from tests.enrich_hf_validation.enrichment_runner import EnrichmentRunner
from tests.enrich_hf_validation.evaluation_engine import (
aggregate_scores,
evaluate_batch,
)
from tests.enrich_hf_validation.preprocessing_auditor import (
audit_records_to_serializable,
run_audit,
)
from tests.enrich_hf_validation.report_generator import (
generate_markdown_report,
save_json_report,
)
logger = logging.getLogger(__name__)
def _setup_logging(verbose: bool) -> None:
level = logging.DEBUG if verbose else logging.INFO
fmt = "%(asctime)s [%(levelname)s] %(name)s: %(message)s"
logging.basicConfig(level=level, format=fmt, stream=sys.stderr)
# Quiet noisy third-party loggers
for name in ("aiohttp", "asyncio", "urllib3"):
logging.getLogger(name).setLevel(logging.WARNING)
def _parse_args(argv: List[str]) -> argparse.Namespace:
parser = argparse.ArgumentParser(
description="Validate and optimise HF metadata enrichment via LLM.",
)
parser.add_argument(
"--models",
default=os.path.join(os.path.dirname(__file__), "test_data", "hf_lora_models_with_safetensors.txt"),
help="Path to the HF repo entries file (format: repo_id, model_name.safetensors per line)",
)
parser.add_argument(
"--settings",
default="~/.config/ComfyUI-LoRA-Manager/settings.json",
help="Path to LoRA Manager settings.json",
)
parser.add_argument(
"--output",
default="/tmp/hf_enrich_validation",
help="Output directory for reports and intermediate data",
)
parser.add_argument(
"--sample",
type=int,
default=0,
help="Process only the first N models (for quick smoke tests)",
)
parser.add_argument(
"--resume",
action="store_true",
help="Resume from previous partial run (uses progress.json)",
)
parser.add_argument(
"--no-enrich",
action="store_true",
help="Skip enrichment phase (evaluate existing metadata only)",
)
parser.add_argument(
"--audit-only",
action="store_true",
help="Run preprocessing audit only (no enrichment, no evaluation)",
)
parser.add_argument(
"--timeout",
type=int,
default=240,
help="Per-model LLM timeout in seconds (default: 240)",
)
parser.add_argument(
"-v", "--verbose",
action="store_true",
help="Enable debug logging",
)
return parser.parse_args(argv)
# ---------------------------------------------------------------------------
# Phase helpers
# ---------------------------------------------------------------------------
def _phase_header(label: str) -> None:
sep = "=" * 60
print(f"\n{sep}", file=sys.stderr)
print(f" PHASE: {label}", file=sys.stderr)
print(sep, file=sys.stderr)
# ---------------------------------------------------------------------------
# Read back LLM config after enrichment (for consistency reporting)
# ---------------------------------------------------------------------------
def _get_actual_llm_config() -> Dict[str, str]:
"""Read what LLMService is actually using, if initialized.
Only meaningful when called AFTER enrichment has started (i.e. after
``AgentService.get_instance()`` has been called).
"""
try:
from py.services.llm_service import LLMService
instance = LLMService._instance
if instance is None:
return {"status": "not initialized"}
cfg = instance._get_config()
return {
"provider": cfg.get("provider", ""),
"model": cfg.get("model", ""),
"api_base": cfg.get("api_base", ""),
}
except Exception as exc:
return {"status": f"error: {exc}"}
def _compare_llm_config(
pipeline_cfg: Dict[str, Any],
actual_cfg: Dict[str, str],
) -> List[str]:
"""Compare pipeline-loaded vs LLMService-used config.
Returns warning messages if they differ.
"""
warnings: List[str] = []
if not actual_cfg or actual_cfg.get("status", "") == "not initialized":
warnings.append(
"LLMService was not initialized during this run — cannot verify "
"config consistency."
)
return warnings
field_map = [
("llm_provider", "provider"),
("llm_model", "model"),
("llm_api_base", "api_base"),
]
for pipeline_key, llm_key in field_map:
pv = (pipeline_cfg.get(pipeline_key) or "").strip()
lv = (actual_cfg.get(llm_key) or "").strip()
if pv and lv and pv != lv:
warnings.append(
f"LLM config mismatch: --settings has '{pv}' for {pipeline_key}, "
f"but LLMService uses '{lv}'. "
f"The pipeline's --settings path ({pipeline_cfg.get('settings_path', '?')}) "
"may differ from where SettingsManager reads."
)
if not warnings and actual_cfg:
warnings.append(
"✅ LLM config matches between pipeline --settings and LLMService."
)
return warnings
# ---------------------------------------------------------------------------
# Phase 1.5: preprocessing audit
# ---------------------------------------------------------------------------
async def _run_preprocessing_audit(
entries: List[RepoEntry],
output_dir: str,
) -> Dict[str, Any]:
"""Execute the preprocessing audit and save results."""
_phase_header("Preprocessing audit")
print(f" Auditing {len(entries)} repos ...", file=sys.stderr)
readmes_dir = os.path.join(output_dir, "readmes")
t0 = time.perf_counter()
records, summary = await run_audit(entries, readmes_dir=readmes_dir)
elapsed = time.perf_counter() - t0
# Save audit data
audit_path = os.path.join(output_dir, "preprocessing_audit.json")
with open(audit_path, "w", encoding="utf-8") as fh:
json.dump(
{
"summary": summary,
"records": audit_records_to_serializable(records),
},
fh,
indent=2,
ensure_ascii=False,
)
print(f" Audit complete: {len(records)} repos in {elapsed:.0f}s", file=sys.stderr)
print(f" Section extraction activated: {summary.get('section_extraction_pct', 0)}%", file=sys.stderr)
print(f" Basename in extracted section: {summary.get('basename_in_section_pct', 0)}%", file=sys.stderr)
print(f" Avg compression: {summary.get('avg_compression_pct', 0)}%", file=sys.stderr)
print(f" Avg cleaned length: {summary.get('avg_cleaned_length', 0)} chars", file=sys.stderr)
print(f" Audit data: {audit_path}", file=sys.stderr)
if summary.get("top_flags"):
print(" Top flags:", file=sys.stderr)
for flag, count in summary["top_flags"][:5]:
print(f" - {flag}: {count}x", file=sys.stderr)
return summary
async def _run_enrichment(
model_paths: List[str],
repos: List[str],
output_dir: str,
timeout: int,
verbose: bool,
) -> Dict[str, Any]:
"""Execute the enrichment phase."""
runner = EnrichmentRunner(
output_dir=output_dir,
per_model_timeout=timeout,
)
result = await runner.run(model_paths, repos)
# Print quick summary
progress = result["progress"]
total_done = (
len(progress.get("completed", []))
+ len(progress.get("failed", []))
+ len(progress.get("timed_out", []))
)
print(
f"\n Enrichment complete: {total_done} processed "
f"({len(progress.get('completed', []))} ok, "
f"{len(progress.get('failed', []))} failed, "
f"{len(progress.get('timed_out', []))} timed out)",
file=sys.stderr,
)
return result
def _collect_enriched_metadata(
model_paths: List[str],
repos: List[str],
results: List[Dict[str, Any]],
) -> List[Dict[str, Any]]:
"""Read enriched .metadata.json for each model.
Uses the same path convention as the rest of the codebase:
``os.path.splitext(model_path)[0] + '.metadata.json'``.
Returns a list of dicts with keys: repo_id, model_path, success,
errors, metadata.
"""
enriched: List[Dict[str, Any]] = []
# Build a lookup from repo_id to enrichment result
result_lookup: Dict[str, Dict[str, Any]] = {}
for r in results:
result_lookup[r["repo_id"]] = r
for model_path, repo_id in zip(model_paths, repos):
res = result_lookup.get(repo_id, {})
metadata_path = f"{os.path.splitext(model_path)[0]}.metadata.json"
metadata: Dict[str, Any] = {}
if os.path.exists(metadata_path):
try:
with open(metadata_path, "r", encoding="utf-8") as fh:
metadata = json.load(fh)
except (json.JSONDecodeError, OSError) as exc:
logger.warning("Failed to read %s: %s", metadata_path, exc)
else:
logger.warning(
"Metadata file not found for %s (expected: %s)",
repo_id, metadata_path,
)
enriched.append({
"repo_id": repo_id,
"model_path": model_path,
"success": res.get("success", False),
"errors": res.get("errors", []),
"metadata": metadata,
})
return enriched
# ---------------------------------------------------------------------------
# Main
# ---------------------------------------------------------------------------
async def main(argv: List[str]) -> int:
args = _parse_args(argv)
_setup_logging(args.verbose)
output_dir = os.path.abspath(os.path.expanduser(args.output))
os.makedirs(output_dir, exist_ok=True)
# ---- Phase 0: Initialise shared state ----
_phase_header("Initialise")
settings = load_settings(args.settings)
logger.info(
"LLM config from --settings: provider=%s model=%s api_base=%s",
settings["llm_provider"],
settings["llm_model"],
settings["llm_api_base"],
)
# Load the production base model list (replaces the old hardcoded list)
await init_supported_base_models()
# ---- Load entries ----
_phase_header("Load repo entries & construct initial metadata")
entries = load_repo_ids(args.models, max_models=args.sample if args.sample > 0 else None)
model_paths, repo_ids = create_all_initial_metadata(
entries, output_dir, skip_existing=True,
)
print(f" {len(model_paths)} repos ready", file=sys.stderr)
# ---- Phase 1.5: Preprocessing audit ----
audit_summary: Dict[str, Any] = {}
t_start = time.perf_counter()
audit_summary = await _run_preprocessing_audit(entries, output_dir)
if args.audit_only:
total_wall = time.perf_counter() - t_start
print(f"\n Audit-only done in {total_wall:.0f}s", file=sys.stderr)
print(f" Audit data: {output_dir}/preprocessing_audit.json", file=sys.stderr)
return 0
# ---- Phase 2: Enrichment ----
enrichment_results: List[Dict[str, Any]] = []
if not args.no_enrich:
_phase_header("Enrich metadata via LLM")
enrichment_out = await _run_enrichment(
model_paths, repo_ids, output_dir, args.timeout, args.verbose,
)
enrichment_results = enrichment_out["results"]
else:
print(" Enrichment skipped (--no-enrich)", file=sys.stderr)
t_enrich = time.perf_counter()
# ---- Phase 3: Evaluation ----
_phase_header("Evaluate enriched metadata")
enriched = _collect_enriched_metadata(model_paths, repo_ids, enrichment_results)
scores = evaluate_batch(enriched)
agg = aggregate_scores(scores)
print(
f" Mean total score: {agg.get('total_score', {}).get('mean', 'N/A')} / 100",
file=sys.stderr,
)
print(
f" Models scored: {agg.get('model_count', 0)}",
file=sys.stderr,
)
# ---- Phase 4: Report generation ----
_phase_header("Generate reports")
duration_summary: Dict[str, Any] | None = None
if enrichment_results:
durations = [r.get("duration_s", 0) for r in enrichment_results if r.get("duration_s")]
if durations:
sorted_d = sorted(durations)
m = len(sorted_d) // 2
duration_summary = {
"total_wall_s": round(t_enrich - t_start, 1),
"mean_s": round(sum(durations) / len(durations), 1),
"median_s": round(sorted_d[m] if len(sorted_d) % 2 else (sorted_d[m - 1] + sorted_d[m]) / 2, 1),
"min_s": round(min(durations), 1),
"max_s": round(max(durations), 1),
}
# Check LLM config consistency after enrichment (LLMService is now initialized)
actual_llm_cfg = _get_actual_llm_config()
config_warnings = _compare_llm_config(settings, actual_llm_cfg)
save_json_report(
agg, scores, enrichment_results, output_dir, duration_summary,
audit_summary=audit_summary, config_warnings=config_warnings,
)
generate_markdown_report(
agg, scores, output_dir, duration_summary,
audit_summary=audit_summary, config_warnings=config_warnings,
)
# ---- Final summary ----
total_wall = time.perf_counter() - t_start
print(f"\n Done in {total_wall:.0f}s ({total_wall / 60:.1f} min)", file=sys.stderr)
print(f" Reports: {output_dir}/report.md, {output_dir}/report.json", file=sys.stderr)
print(file=sys.stderr)
return 0 if agg.get("success_count", 0) > 0 else 1
def entry_point() -> int:
return asyncio.run(main(sys.argv[1:]))
if __name__ == "__main__":
sys.exit(entry_point())