高质量后端接口开源模型微调文档提示词

角色定义与任务定位

请以“开源项目技术文档架构师”的身份进行创作。你的核心目标是：为一套涉及后端接口的开源模型微调项目，生成一份专业、清晰、可操作性强的官方技术文档。这份文档旨在指导开发者快速理解、配置并成功运行微调流程，确保接口的稳定性、可维护性与高性能。

适用场景

• 为GitHub、Gitee等平台上的开源模型微调项目撰写README或核心使用指南。
• 编写需要对外提供API调用服务的模型微调项目文档。
• 制作面向开发者社区的技术布道或集成教程。
• 构建项目内部标准化、结构化的微调流程说明。

核心提示词

可直接复制并填充具体信息后使用的基础提示框架：

• 撰写《[项目名称]后端接口微调指南》：从环境配置、数据准备、参数调整到接口调用与监控的完整流程。
• 详细说明如何通过RESTful API / gRPC接口提交训练数据、启动微调任务、查询状态与获取微调后的模型。
• 提供关键后端配置示例：包括但不限于Docker部署脚本、环境变量列表、数据库连接池配置、请求超时与重试策略。
• 列出微调前后端接口的完整端点列表、请求/响应体格式（JSON Schema示例）、身份认证方式及速率限制。
• 给出常见错误代码排查手册：针对“训练数据加载失败”、“GPU内存不足”、“接口响应超时”等典型问题的解决方案。

风格方向

• 专业严谨：采用技术文档的标准行文风格，逻辑严密，术语准确。
• 用户友好：避免冗长理论，以步骤化、清单化、示例化的方式呈现，降低阅读负担。
• 结构化视觉：在描述中暗示清晰的文档结构，如模块分割、层级标题、代码块高亮、流程图（用文字描述流程）和对比表格（用文字描述对比项）。

构图建议（信息组织框架）

• 顶层架构图：用文字简述“用户请求 -> API网关 -> 微调调度服务 -> 计算集群 -> 模型存储 -> 结果返回”的数据流。
• 模块化展开：按照“快速开始 -> 核心概念 -> 接口详解 -> 高级配置 -> 故障排除 -> 最佳实践”的顺序组织内容。
• 重点突出：将“接口调用示例”和“参数调优建议”作为视觉焦点模块，使用醒目的代码块和警告/提示框形式进行强调。

细节强化

• 数据格式：强调训练数据集的标准化要求（如JSONL格式）、预处理脚本的使用方法及数据校验接口的调用方式。
• 性能参数：明确指出影响微调速度与资源消耗的关键参数（如batch_size, learning_rate, num_epochs），并给出针对不同硬件配置的推荐值范围。
• 安全与运维：包含接口鉴权（API Key/OAuth）、输入数据安全检查、模型版本管理、服务健康检查端点的设置说明。
• 扩展性提示：说明如何通过插件或配置扩展自定义数据处理器、评估指标或回调函数。

使用建议

• 生成时，请将“[项目名称]”替换为具体的开源模型名称，如“LLaMA-Factory”、“ChatGLM-Tuning”等。
• 在“核心提示词”部分提供的每一条，都可以作为独立段落或章节的生成起点，组合使用能构建完整文档。
• 生成内容后，建议结合实际项目代码，填充具体的代码示例、配置文件内容及真实的接口URL，使文档即刻可用。
• 可根据读者群体（新手/专家）调整“细节强化”部分的深度，新手导向则增加基础概念解释，专家导向则侧重架构设计与性能压测。