跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://docs.osmosis.ai/llms.txt

Use this file to discover all available pages before exploring further.

运行 osmosis init my-project 后，会创建以下目录结构： 
my-project/
├── .osmosis/
│   ├── workspace.toml                   # 工作区元数据
│   └── skills/
│       ├── create-rollout/SKILL.md      # AI 助手技能
│       ├── evaluate-rollout/SKILL.md    # AI 助手技能
│       └── submit-training/SKILL.md     # AI 助手技能
├── rollouts/                            # AgentWorkflow + Grader 代码
├── configs/
│   ├── eval/                            # Eval 配置
│   ├── AGENTS.md                        # AI 助手配置指令
│   └── training/
│       └── default.toml                 # 训练配置模板
├── data/                                # 本地测试数据集
├── pyproject.toml                       # Python 项目配置
├── README.md                            # 项目说明
├── AGENTS.md                            # AI 编码助手指令
├── CLAUDE.md                            # Claude Code 指令
└── .gitignore                           # Git 忽略规则

​
.osmosis/workspace.toml

工作区元数据文件，记录工作区的创建方式和时间。此文件由系统自动生成，不应手动编辑。
.osmosis/workspace.toml
# Osmosis Workspace Configuration
# Generated by `osmosis init`

[workspace]
sdk_version = "0.20.0"
created_at = "2026-04-14T12:00:00+00:00"
setup_source = "osmosis init"
字段描述
sdk_version创建或最后更新工作区时使用的 osmosis-ai 版本
created_at工作区初始创建的 ISO 8601 时间戳
updated_at最后一次更新的 ISO 8601 时间戳（首次更新后添加）
setup_source始终为 "osmosis init"

​
.osmosis/skills/

面向 Claude Code、GitHub Copilot 及其他 AI 编辑器的编码助手技能文件。这些文件提供上下文感知的指令，帮助您的 AI 助手理解 Osmosis 工作区结构，协助您创建 rollout、运行评估和提交训练任务。 当您在已有工作区上运行 osmosis init 时，技能文件会自动保持最新（参见下方的更新模式）。

​
rollouts/

存放 AgentWorkflow 和 Grader 代码的目录。每个 rollout 是一个子目录，包含一个入口文件（通常是 main.py），用于定义 agent 工作流和评分逻辑。 
rollouts/
└── my-rollout/
    ├── main.py          # 入口文件：定义 AgentWorkflow + Grader
    ├── tools.py         # 工具定义
    └── prompts.py       # 系统提示词
参见构建 AgentWorkflow 了解如何编写 AgentWorkflow 入口文件。

​
configs/

两种 CLI 操作的配置文件：训练和 eval。
子目录用途参考
configs/training/osmosis train submit 的训练任务配置训练配置
configs/eval/osmosis eval run 的评估配置Eval 配置
configs/training/default.toml 模板预填充了必填字段，并注释了可选设置。完整的 TOML 配置参考请参见配置文件。

​
data/

用于评估的本地测试数据集目录。将 JSONL、CSV 或 Parquet 文件放在此处，并在 eval 配置中引用。 
# 示例：对本地数据集运行 eval
osmosis eval run configs/eval/default.toml

​
pyproject.toml

标准的 Python 项目配置，已预配置 osmosis-ai 依赖：
pyproject.toml
[project]
name = "my-project"
description = "Osmosis workspace with training rollouts"
version = "0.1.0"
requires-python = ">=3.10"
dependencies = [
    "osmosis-ai>=0.20.0",
]

​
AGENTS.md 和 CLAUDE.md

AI 编码助手的指令文件。AGENTS.md 为任何 AI 助手（GitHub Copilot、Cursor 等）提供通用指导，而 CLAUDE.md 包含 Claude Code 专用的指令。 两个文件都描述了工作区结构、约定和 Osmosis 特有模式，帮助您的 AI 助手高效地协助您编写 rollout 代码。

​
更新模式

在已有工作区上运行 osmosis init my-project（通过检测 .osmosis/workspace.toml 判断）会进入更新模式，而非报错：
  • 覆盖： AGENTS.md、CLAUDE.md、configs/AGENTS.md，以及 .osmosis/skills/ 下的所有文件
  • 更新： workspace.toml 元数据（sdk_version、updated_at 时间戳）
  • 保持不变： rollout 代码、配置、数据、pyproject.toml、.gitignore 及其他所有内容
这让您在更新 osmosis-ai 包后，可以升级到最新的 AI 助手指令和技能，而不影响现有代码。
# 升级 SDK，然后更新工作区脚手架
pip install --upgrade osmosis-ai
osmosis init my-project