TensorZero项目中eval命令参数命名规范优化

在TensorZero项目的开发过程中，团队对eval命令的参数命名进行了重要调整，将原有的--variant参数更名为--variant-name。这一变更看似微小，却体现了项目对API一致性和开发者体验的重视。

变更背景

TensorZero作为一个开源项目，其命令行工具的参数命名需要保持高度一致性。在早期的实现中，eval命令使用了--variant参数来指定变体名称，这与项目其他部分的命名习惯存在差异。特别是与推理API(inference API)相比，这种不一致性可能导致开发者在使用时产生困惑。

技术决策过程

在讨论这一变更时，团队成员首先确认了项目现有的命名规范。TensorZero的命令行参数普遍采用kebab-case(短横线连接)的命名方式，如--model-name、--batch-size等。这种命名方式在命令行工具中更为常见，也更符合Unix传统。

技术负责人GabrielBianconi最初提出了将--variant改为--variant-name的建议，以匹配推理API的命名风格。随后，团队成员virajmehta提出了关于命名格式的疑问，指出需要确保整个项目在kebab-case和snake_case之间的统一性。经过讨论，团队最终决定采用kebab-case格式，保持与项目其他部分的一致性。

实现细节

这一变更涉及以下技术点：

1. 命令行解析逻辑修改：需要更新使用clap或其他命令行解析库的相关代码
2. 文档更新：所有涉及eval命令的文档和帮助信息都需要同步更新
3. 向后兼容性考虑：虽然这是一个破坏性变更，但由于项目处于早期阶段，团队决定直接修改而非保留旧参数

对开发者的影响

对于TensorZero的使用者来说，这一变更意味着：

1. 需要将脚本中的--variant参数更新为--variant-name
2. 新的命名更加清晰明确，减少了可能的歧义
3. 与推理API保持一致的命名有助于降低学习成本

最佳实践建议

基于这一变更，我们可以总结出一些命令行工具设计的通用原则：

1. 一致性优先：整个项目的参数命名应保持统一风格
2. 清晰明确：参数名应尽可能完整表达其用途
3. 遵循惯例：采用所在生态系统的常见命名方式(如命令行工具常用kebab-case)

这一看似微小的变更体现了TensorZero团队对代码质量和开发者体验的重视，也为项目的长期维护奠定了良好的基础。