# StarForge

> StarForge — one control plane for the whole LLM post-training lifecycle: environments, training, evaluation, serving and deployment, across any framework and any backend.

- [API 参考 (309 pages)](https://starforge.mintlify.app/_llms/zh-hans/api.md): Documentation for API 参考.

## 指南

### 开始

- [StarForge](https://starforge.mintlify.app/zh-Hans/index.md): 覆盖后训练完整生命周期的统一控制平面：环境、训练、评测、试用与部署，跨任意训练框架与任意算力后端。
- [快速开始](https://starforge.mintlify.app/zh-Hans/quickstart.md): 装上 CLI、提交一个 GRPO 作业，看着第一个点落在 loss 曲线上。

### 核心概念

- [StarForge 各部分怎么拼在一起](https://starforge.mintlify.app/zh-Hans/concepts/architecture.md): CLI → 控制平面 → 执行器 → Job Capsule。一份 JobSpec 契约。
- [术语表](https://starforge.mintlify.app/zh-Hans/concepts/glossary.md): CLI、JobSpec、控制台实际在用的名字
- [sf init 生成了什么](https://starforge.mintlify.app/zh-Hans/concepts/lab-layout.md): sf init 生成什么、CLI 上传什么、什么永远不离开笔记本
- [Recipe 与版本锁定](https://starforge.mintlify.app/zh-Hans/concepts/recipes.md): 方法目录（recipe catalog）、实验锁文件与框架版本矩阵
- [资源是怎么申请的](https://starforge.mintlify.app/zh-Hans/concepts/resources.md): 硬件 profile 与卡型 series、配额、时段窗口、多资源池
- [作业状态](https://starforge.mintlify.app/zh-Hans/concepts/job-lifecycle.md): 从 QUEUED 到 SUCCEEDED，暂停续跑、自动重试，以及何时开始计 GPU 时间

### 训练模型

#### 提交作业

- [创建和调整实验](https://starforge.mintlify.app/zh-Hans/guides/experiments.md): sf new 脚手架、config.yaml 分层继承、本地校验
- [实验配置文件](https://starforge.mintlify.app/zh-Hans/guides/config.md): defaults 继承、_override_、插值，以及实验文件里该写什么
- [提交训练作业](https://starforge.mintlify.app/zh-Hans/guides/submit.md): sf submit 全流程：资源声明、超参覆盖、数据引用、镜像与观测
- [跑一组超参 sweep](https://starforge.mintlify.app/zh-Hans/guides/sweep.md): 网格展开批量提交，控制台按组聚合对比
- [把多次 run 串成流水线](https://starforge.mintlify.app/zh-Hans/guides/pipelines.md): init-from 接力训练、--then 自动后处理、export 与 eval

#### 训练框架

- [选一个方法](https://starforge.mintlify.app/zh-Hans/guides/methods.md): NeMo-RL、verl、TRL、OpenRLHF、evalkit 与 custom
- [用 NeMo-RL 训练](https://starforge.mintlify.app/zh-Hans/guides/nemo-rl.md): sf new、配置继承、提交、拓扑，以及只在 NeMo-RL 上出现的行为
- [用 verl 训练](https://starforge.mintlify.app/zh-Hans/guides/verl.md): 必填的 --model / --train-data、Hydra 绑定、方法与 estimator、可选的实验 main.py
- [用 TRL 训练](https://starforge.mintlify.app/zh-Hans/guides/trl.md): Accelerate + TRL Trainer、必填模型/数据、OPSD teacher、镜像
- [用 OpenRLHF 训练](https://starforge.mintlify.app/zh-Hans/guides/openrlhf.md): 自建镜像、DeepSpeed + vLLM colocate、GRPO 和 REINFORCE++-baseline
- [用你自己的训练器](https://starforge.mintlify.app/zh-Hans/guides/custom-training.md): custom/custom 从头到尾：train.sh、环境变量、指标、checkpoint，以及平台不会猜的事
- [构建自定义镜像](https://starforge.mintlify.app/zh-Hans/guides/custom-images.md): Dockerfile、不要打进镜像的东西、仓库白名单、tag 和 digest

#### 数据

- [管理数据集](https://starforge.mintlify.app/zh-Hans/guides/datasets.md): 本地预处理 → 版本化上传 → 作业自动分发到共享缓存
- [收集偏好标注](https://starforge.mintlify.app/zh-Hans/guides/annotation.md): 两次训练的回答配成偏好对 → Argilla 人工标注 → 拉回来变成 DPO 训练数据

### 评测与服务

#### 评测

- [跑一次评测](https://starforge.mintlify.app/zh-Hans/guides/benchmarks.md): 用 GSM8K、MMLU、C-Eval 等给一次完成的 run 打分，落在同一张可比的看板上。
- [用 Rubric 打分](https://starforge.mintlify.app/zh-Hans/guides/rubrics.md): 同一份成文标准，同时供给训练 reward 和评测分数。
- [给硬件与 RTL 工作打分](https://starforge.mintlify.app/zh-Hans/guides/rtl-benchmarks.md): VerilogEval v2、RTLLM v2、RTL-Repo、CVDP —— 编译 Verilog、跑 testbench 判功能

#### 服务

- [注册并推广模型](https://starforge.mintlify.app/zh-Hans/guides/model-registry.md): 跨 run 的命名版本线：哪个模型在生产、上一版是哪次训练出的
- [和 checkpoint 对话](https://starforge.mintlify.app/zh-Hans/guides/playground.md): 训练产物一键起 vLLM 服务，网页聊天与 A/B 对比
- [把生产流量变成训练数据](https://starforge.mintlify.app/zh-Hans/guides/reflow.md): 把部署的真实流量变成它下一版的训练数据

### Agent 环境

- [用 Agent 环境做训练](https://starforge.mintlify.app/zh-Hans/guides/agent-envs.md): 把作业指向一个任务集让模型练习，由 verifier 决定奖励。
- [Agent 环境](https://starforge.mintlify.app/zh-Hans/extend/environments.md): 编写一个让 agent 练习的任务集：manifest、任务，以及四种协议。
- [Verifier](https://starforge.mintlify.app/zh-Hans/extend/verifiers.md): 判定任务是否完成的三种方式，以及各自的确切契约。

### 扩展平台

- [扩展点](https://starforge.mintlify.app/zh-Hans/extend/overview.md): 不改平台代码就能加进 StarForge 的所有东西，以及怎么选对那一种。
- [插件包](https://starforge.mintlify.app/zh-Hans/extend/plugins.md): manifest、目录结构，以及发布—安装—引用这条链路。
- [Algorithm 插件](https://starforge.mintlify.app/zh-Hans/extend/algorithm-plugins.md): 在运行期给训练循环打补丁——入口签名，以及它什么时候被调用。
- [Recipe 包](https://starforge.mintlify.app/zh-Hans/extend/recipe-packs.md): 不发平台版本，就往 catalog 里加一种训练方法。
- [Benchmark 包](https://starforge.mintlify.app/zh-Hans/extend/benchmark-packs.md): 声明一个评测集：跑什么、读哪些数、怎么读。
- [Rubric](https://starforge.mintlify.app/zh-Hans/extend/rubrics.md): 把「你的团队认为什么算正确答案」写下来，然后同时用作 reward 和评测标准。

### 集成

- [MCP 接入](https://starforge.mintlify.app/zh-Hans/integrations/mcp.md): Cursor / Claude 等 AI Agent 经 MCP 读取作业数据辅助调参
- [HuggingFace 集成](https://starforge.mintlify.app/zh-Hans/integrations/huggingface.md): 账号关联、gated 资源预检、export 推 Hub

### 帮助

- [故障排查](https://starforge.mintlify.app/zh-Hans/troubleshooting.md): 登录、提交、调度、训练与日志的常见问题定位
- [常见问题](https://starforge.mintlify.app/zh-Hans/faq.md): 关于平台设计与使用方式的高频疑问
- [JobSpec](https://starforge.mintlify.app/zh-Hans/reference/jobspec.md): CLI 构造、服务端准入的 forge/v2 载荷——用于读懂一次拒绝，或者自己写工具。

## CLI 参考

### CLI 参考

- [sf 命令行](https://starforge.mintlify.app/zh-Hans/cli/overview.md): 全部命令，按你想做的事分组。

### 配置

- [sf init](https://starforge.mintlify.app/zh-Hans/cli/init.md): 用安装好的 CLI 创建微调仓库
- [sf login](https://starforge.mintlify.app/zh-Hans/cli/login.md): 登录、登出与账号状态
- [sf logout](https://starforge.mintlify.app/zh-Hans/cli/logout.md): Log out
- [sf status](https://starforge.mintlify.app/zh-Hans/cli/status.md): Show account, quota and active jobs
- [sf update](https://starforge.mintlify.app/zh-Hans/cli/update.md): Update sf to the latest version
- [sf version](https://starforge.mintlify.app/zh-Hans/cli/version.md): Show the sf version

### 实验

- [sf new](https://starforge.mintlify.app/zh-Hans/cli/new.md): Create an experiment
- [sf ls](https://starforge.mintlify.app/zh-Hans/cli/ls.md): List the experiments in this project
- [sf validate](https://starforge.mintlify.app/zh-Hans/cli/validate.md): Validate an experiment config
- [sf methods](https://starforge.mintlify.app/zh-Hans/cli/methods.md): List the available post-training methods
- [sf recipe](https://starforge.mintlify.app/zh-Hans/cli/recipe.md): 方法锁（recipe.lock.json）状态与升级

### 训练

- [sf submit](https://starforge.mintlify.app/zh-Hans/cli/submit.md): 提交训练作业的完整参数参考
- [sf sweep](https://starforge.mintlify.app/zh-Hans/cli/sweep.md): 网格展开批量提交
- [sf job](https://starforge.mintlify.app/zh-Hans/cli/job.md): 作业生命周期：日志、状态、停止、暂停续训、批量操作
- [sf clean](https://starforge.mintlify.app/zh-Hans/cli/clean.md): Delete an experiment's checkpoints and logs

### 产物与评测

- [sf export](https://starforge.mintlify.app/zh-Hans/cli/export.md): Convert a checkpoint to HuggingFace format
- [sf eval](https://starforge.mintlify.app/zh-Hans/cli/eval.md): Run a recipe's native evaluation
- [sf bench](https://starforge.mintlify.app/zh-Hans/cli/bench.md): 对某次 run 或任意模型跑标准评测，以及回报外部产生的分数。
- [sf serve](https://starforge.mintlify.app/zh-Hans/cli/serve.md): Playground 推理服务的启动、列表、续期与停止

### 资源

- [sf dataset](https://starforge.mintlify.app/zh-Hans/cli/dataset.md): 数据集：本地预处理、版本化上传、可见性管理
- [sf volume](https://starforge.mintlify.app/zh-Hans/cli/volume.md): Volumes a job can mount
- [sf model](https://starforge.mintlify.app/zh-Hans/cli/model.md): Manage the model registry
- [sf env](https://starforge.mintlify.app/zh-Hans/cli/env.md): List agent RL environments
- [sf annotate](https://starforge.mintlify.app/zh-Hans/cli/annotate.md): Manage preference annotation
- [sf plugin](https://starforge.mintlify.app/zh-Hans/cli/plugin.md): 插件中心：发布、安装、锁定与治理

### 管理

- [sf admin](https://starforge.mintlify.app/zh-Hans/cli/admin.md): 管理员命令：用户、配额与维护模式

## Web 控制台

### Web 控制台

- [Web 控制台](https://starforge.mintlify.app/zh-Hans/console/overview.md): 每一屏是干什么的，以及你真正会用到哪些。
- [仪表盘](https://starforge.mintlify.app/zh-Hans/console/dashboard.md): 集群容量、你的配额，以及此刻正在跑什么。

### 训练

- [作业页](https://starforge.mintlify.app/zh-Hans/console/jobs.md): 作业列表与详情：图表、日志、验证样本、系统监控、AI 诊断
- [作业详情](https://starforge.mintlify.app/zh-Hans/console/job-detail.md): 运行中或已完成作业的八个页签，以及各自回答什么问题。
- [提交台账](https://starforge.mintlify.app/zh-Hans/console/runs.md): 服务端记录的每一次准入提交，从新到旧。
- [项目页](https://starforge.mintlify.app/zh-Hans/console/projects.md): 按项目聚合 run，沉淀项目记忆
- [对比复盘](https://starforge.mintlify.app/zh-Hans/console/review.md): 叠加多个 run，决定留哪一个。

### 评测与模型

- [Benchmarks 看板](https://starforge.mintlify.app/zh-Hans/console/benchmarks.md): 标准基准分数矩阵：跨 run、跨方法、跨基座可比
- [Rubric](https://starforge.mintlify.app/zh-Hans/console/rubrics.md): 你团队关于「什么算正确答案」的成文标准，它的版本和使用记录。
- [环境](https://starforge.mintlify.app/zh-Hans/console/environments.md): 训练可以引用的 Agent RL 环境，以及每一个声明了什么。
- [Playground 页](https://starforge.mintlify.app/zh-Hans/console/playground.md): 网页起服务、聊天与 A/B 对比
- [模型](https://starforge.mintlify.app/zh-Hans/console/models.md): 注册表：一条跨 run 的命名版本线，以及哪个版本在生产。
- [模型部署](https://starforge.mintlify.app/zh-Hans/console/model-deployments.md): 把训练产物或第三方模型发布为可自愈、可回滚的内网 OpenAI 服务

### 目录

- [方法](https://starforge.mintlify.app/zh-Hans/console/methods.md): 这套部署提供的后训练方法，以及每一个你能调的超参。
- [数据集](https://starforge.mintlify.app/zh-Hans/console/datasets.md): 有版本的数据集资产、文件清单，以及数据质量报告。
- [插件](https://starforge.mintlify.app/zh-Hans/console/plugins.md): 扩展货架：有哪些已发布、哪些会执行代码、管理员能禁用什么。

### 你的账号

- [用量与配额](https://starforge.mintlify.app/zh-Hans/console/usage.md): 你此刻占着多少、一共花了多少，以及 GPU-时都去哪了。
- [个人资料](https://starforge.mintlify.app/zh-Hans/console/profile.md): 你的昵称、密码，以及每一台以你的身份登录的设备。
- [通知](https://starforge.mintlify.app/zh-Hans/console/notifications.md): 你的消息流，以及它怎么在控制台之外找到你。
- [分享作业](https://starforge.mintlify.app/zh-Hans/console/sharing.md): 给别人一个 run 或一次复盘的只读链接，不需要给他账号。
- [MCP 接入](https://starforge.mintlify.app/zh-Hans/console/mcp.md): 让 Cursor、Claude 或 Codex 读到你的作业配置、指标和日志。
- [集成](https://starforge.mintlify.app/zh-Hans/console/integrations.md): 关联 Hugging Face 账号，让作业能读受限模型、能推送导出结果。
- [新手教程](https://starforge.mintlify.app/zh-Hans/console/tutorial.md): 产品内的上手引导：先四个概念，再五步跑通第一次训练。

### 管理

- [管理页](https://starforge.mintlify.app/zh-Hans/console/admin.md): 用户配额、硬件注册表、时段窗口、Rubrics、审计与用量
- [设置](https://starforge.mintlify.app/zh-Hans/console/admin-settings.md): 平台开关、训练镜像、硬件注册表和时段窗口。
- [定时任务](https://starforge.mintlify.app/zh-Hans/console/admin-tasks.md): 后台任务的排期、运行历史，以及立即执行一次。
- [审计日志](https://starforge.mintlify.app/zh-Hans/console/audit.md): 谁提交了、谁被拒了、谁改了什么。

## 部署运维

### 把部署跑起来

- [部署选型](https://starforge.mintlify.app/zh-Hans/ops/overview.md): 四种执行后端：local、node、kuberay、slurm
- [环境要求](https://starforge.mintlify.app/zh-Hans/ops/requirements.md): 安装之前需要准备什么——从一台 GPU 机器到一个受集中治理的集群。
- [用 Docker Compose 部署](https://starforge.mintlify.app/zh-Hans/ops/install-compose.md): Postgres、Redis 和控制台跑在一台机器上——最快的一套真实部署。
- [在 Kubernetes 上部署](https://starforge.mintlify.app/zh-Hans/ops/install-kubernetes.md): 用 kustomize 把控制台部进集群，以及 KubeRay 执行器依赖的那个 RWX 卷。
- [用 Helm 部署](https://starforge.mintlify.app/zh-Hans/ops/install-helm.md): 同一套 Kubernetes 部署，改为 values 驱动——适合多环境或 GitOps 流水线。
- [通用安装](https://starforge.mintlify.app/zh-Hans/ops/install.md): Console 进程、数据库、对象存储与反向代理
- [离线内网部署](https://starforge.mintlify.app/zh-Hans/ops/airgapped.md): 在没有 Hugging Face、PyPI 和公共镜像仓库出口的网络里跑 StarForge。

### 执行器

- [Fleet](https://starforge.mintlify.app/zh-Hans/ops/fleets.md): 注册机器：什么是 Fleet、节点怎么加入、排空与存活判定
- [local 后端](https://starforge.mintlify.app/zh-Hans/ops/executor-local.md): 单机 Docker 执行器：GPU 分配、共享目录、回收
- [node 后端](https://starforge.mintlify.app/zh-Hans/ops/executor-node.md): 裸机机器：forgelet daemon、共享盘、一作业一节点
- [kuberay 后端](https://starforge.mintlify.app/zh-Hans/ops/executor-kuberay.md): K8s + KubeRay：operator、RBAC、作业包分发、GPU 调度
- [slurm 后端](https://starforge.mintlify.app/zh-Hans/ops/executor-slurm.md): HPC 形态：slurmrestd、运行时 profile、异构 hetjob

### 平台治理

- [配置参考](https://starforge.mintlify.app/zh-Hans/ops/configuration.md): StarForge 部署读取的每一项设置，含类型、默认值和用途。
- [鉴权与账号](https://starforge.mintlify.app/zh-Hans/ops/auth.md): 本地账号、OIDC 单点登录与平台的 token 体系
- [角色与配额](https://starforge.mintlify.app/zh-Hans/ops/roles-and-quotas.md): 谁能做什么，以及他们能占住多少集群。
- [硬件注册表与配额](https://starforge.mintlify.app/zh-Hans/ops/hardware.md): 卡型 series、profile、用户配额与时段窗口的运维配置
- [存储布局](https://starforge.mintlify.app/zh-Hans/ops/storage.md): 一个根目录，一切由它派生，以及哪些部分可以安全回收。
- [观测与 ingest](https://starforge.mintlify.app/zh-Hans/ops/observability.md): 训练指标、日志、产物怎么回到控制台，以及部署时要注意什么

### 日常运维

- [维护模式](https://starforge.mintlify.app/zh-Hans/ops/maintenance.md): 排空集群而不丢工作，然后从原地恢复。
- [上游版本采纳 SOP](https://starforge.mintlify.app/zh-Hans/ops/upgrades.md): NeMo-RL / verl / TRL 出新版本时，平台怎么跟进
- [备份与恢复](https://starforge.mintlify.app/zh-Hans/ops/backup.md): 真正必须活下来的是什么，以及哪些丢了也没关系。
- [运维排障](https://starforge.mintlify.app/zh-Hans/ops/troubleshooting.md): 那些症状指向的地方和真正原因不在一处的故障。
- [E2E 闭环测试](https://starforge.mintlify.app/zh-Hans/ops/e2e-testing.md): 无 GPU 环境跑通「提交 → 调度 → 容器训练 → 回传」全链路

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [Simplified Chinese / API 参考 (309 pages)](https://starforge.mintlify.app/_llms/zh-hans/api.md): Documentation for Simplified Chinese / API 参考.
- [English (428 pages)](https://starforge.mintlify.app/_llms/en.md): Documentation for English.
- [English / API Reference (309 pages)](https://starforge.mintlify.app/_llms/en/api-reference.md): Documentation for English / API Reference.