跳到内容

Instructor 命令行工具

  • 命令行实用工具

    增强 Instructor 工作流程的强大工具

    查看命令

  • 使用情况监控

    跟踪 API 使用量、成本和令牌消耗

    使用指南

  • 模型微调

    创建和管理自定义模型版本

    微调指南

  • 文档访问

    从终端快速访问文档

    文档命令

开始使用

安装

CLI 工具已包含在 Instructor 包中

pip install instructor

API 设置

将您的 OpenAI API 密钥设置为环境变量

export OPENAI_API_KEY="your-api-key-here"

可用命令

Instructor 提供了几种命令行实用工具

命令 描述 指南
instructor usage 跟踪 API 使用量和成本 使用指南
instructor finetune 创建和管理微调模型 微调指南
instructor docs 快速访问文档 见下文

Usage 命令

直接从终端监控您的 OpenAI API 使用情况

# View total usage for the current month
instructor usage

# View usage breakdown by day
instructor usage --by-day

# Calculate cost for a specific model
instructor usage --model gpt-4

有关详细的使用统计信息和选项，请参阅使用指南。

微调命令

通过交互式界面创建和管理微调模型

# Start the fine-tuning interface
instructor finetune

这将启动一个交互式应用程序，指导您完成微调过程。在微调指南中了解更多。

文档命令

从终端快速访问 Instructor 文档

# Open main documentation
instructor docs

# Search for specific topic
instructor docs validation

# Open specific page
instructor docs concepts/models

此命令会在您的默认网页浏览器中打开 Instructor 文档，方便您在需要时查找信息。

支持与贡献