跳转到主要内容
osmosis-ai 包含编写 reward 函数、构建 rollout agent 以及与 Osmosis 平台 交互所需的全部工具 —— 根据使用场景可选择三种安装级别。
前提条件:使用 SDK 连接训练平台前,您需要拥有一个 Osmosis 平台账户。请通过 pip install osmosis-ai && osmosis login 进行安装和身份认证。

环境要求

  • Python 3.10 或更高版本
  • pip 包管理器

通过 pip 安装

pip install osmosis-ai
这将安装核心 Python 库和 CLI 工具。

可选依赖

根据您的使用场景安装额外功能:
# For running remote rollout servers (FastAPI + Uvicorn)
pip install "osmosis-ai[server]"

# For development (pytest, formatting tools)
pip install "osmosis-ai[dev]"

# Install everything
pip install "osmosis-ai[full]"

设置 API 密钥

为您将使用的 LLM 提供商配置 API 密钥:
# OpenAI
export OPENAI_API_KEY="sk-..."

# Anthropic (Claude)
export ANTHROPIC_API_KEY="sk-ant-..."

# Google Gemini
export GOOGLE_API_KEY="..."
您只需为将要使用的提供商设置 API 密钥。SDK 支持 OpenAI、Anthropic、Gemini、xAI、OpenRouter 和 Cerebras。

使用 .env 文件

在您的项目中创建一个 .env 文件:
OPENAI_API_KEY=sk-...
ANTHROPIC_API_KEY=sk-ant-...
在代码中加载它:
from dotenv import load_dotenv
load_dotenv()

验证安装

测试 Python SDK:
from osmosis_ai import osmosis_reward

@osmosis_reward
def test_fn(solution_str: str, ground_truth: str, extra_info: dict = None, **kwargs) -> float:
    return 1.0

print(test_fn("hello", "hello"))  # Output: 1.0
测试 CLI:
osmosis --help

故障排除

导入错误:确保您安装的是 osmosis-ai(而非 osmosis-sdk
pip install osmosis-ai
CLI 未找到:重新安装并验证 PATH
pip install --force-reinstall osmosis-ai
which osmosis
API 密钥错误:验证环境变量是否已设置
import os
print(os.getenv("OPENAI_API_KEY"))

后续步骤