模板：ml/recommendation_ranking

源文件：examples/template_library/ml/recommendation_ranking.py

场景说明

推荐排序模板。

场景说明：CTR/排序任务，记录 NDCG/Recall@K。

复制后最少需要改动： 1. 将 exp_fn 中的伪指标逻辑替换为真实训练/评测代码； 2. 调整 grid/variants 到你的参数空间； 3. 将产物写入 ctx.run_dir / "artifacts"。

一键复制起步

cp examples/template_library/ml/recommendation_ranking.py your_experiment.py
python your_experiment.py

模板代码

"""推荐排序模板。

场景说明：CTR/排序任务，记录 NDCG/Recall@K。

复制后最少需要改动：
1. 将 `exp_fn` 中的伪指标逻辑替换为真实训练/评测代码；
2. 调整 `grid/variants` 到你的参数空间；
3. 将产物写入 `ctx.run_dir / "artifacts"`。
"""

from __future__ import annotations

import json
import random
import time
from pathlib import Path

from ztxexp import ExperimentPipeline, RunContext


def exp_fn(ctx: RunContext):
    """单次实验函数模板。"""
    cfg = ctx.config
    lr = float(cfg.get("lr", 0.001))
    time.sleep(0.05 + random.random() * 0.05)

    primary = 0.5 + random.random() * 0.45 - lr * 0.1

    artifact = {
        "run_id": ctx.run_id,
        "config": cfg,
        "note": "replace with your real training/evaluation outputs",
    }
    artifact_path = Path(ctx.run_dir) / "artifacts" / "summary.json"
    artifact_path.write_text(json.dumps(artifact, ensure_ascii=False, indent=2), encoding="utf-8")

    return {
        "ndcg": round(primary, 4),
        "recall_at_10": round(0.4 + random.random() * 0.55, 4),
    }


if __name__ == "__main__":

    pipeline = (
        ExperimentPipeline(
            results_root="./results_templates/recommendation_ranking",
            base_config={'seed': 42, 'task': 'recommendation_ranking'},
        )
        .grid({'lr': [0.0005, 0.001], 'neg_ratio': [2, 4]})
        .variants([{'model': 'dssm'}, {'model': 'din'}])
        .exclude_completed()
    )
    summary = pipeline.run(
        exp_fn,
        mode="joblib",
        workers=2,
        cpu_threshold=80,
    )
    print(summary)