跳过内容

标题: 贡献给Instructor: 评估、问题和拉取请求 描述: 加入我们,通过评估、报告问题和在GitHub上提交拉取请求来增强Instructor库。合作并贡献!


我们非常欢迎您为Instructor做出贡献。

评估

我们邀请您以pytest的形式贡献评估,以此来监控openai模型和instructor库的质量。要开始,请查看jxnl/instructor/tests/llm/test_openai/evals并以pytest测试的形式贡献您自己的评估。这些评估将每周运行一次,结果将被发布。

问题

如果您发现了一个错误,请在我们的GitHub问题跟踪器上提交一个问题。

为了帮助我们重现这个错误,请提供一个最小可复现的示例,包括代码片段和完整的错误信息。

  1. 您正在使用的 response_model
  2. 您正在使用的 messages
  3. 您正在使用的 model

拉取请求

我们欢迎拉取请求!有很多事情可以做,我们很乐意讨论您想要做出的任何贡献。

如果不是小的改动,请先提交一个问题

如果你需要灵感,可以查看help wantedgood first issue标签。

Grit 用于强制执行最佳实践。你可以在提交拉取请求之前运行 grit check 来检查你的代码。

贡献者

附加资源

为了增强您对文档的理解,这里有一些有用的参考资料:

了解更多信息,请参阅mkdocs serve文档,并确保在运行命令之前安装requirements-doc.txt中列出的必要依赖项。

  • mkdocs serve: mkdocs serve 命令用于在开发阶段本地预览您的文档。当您在终端中运行此命令时,MkDocs 会启动一个开发服务器,允许您在网页浏览器中查看并与您的文档进行交互。这对于在发布文档之前检查您的更改效果非常有帮助。

  • 代码块中的高亮行: 代码块中的hl_lines功能允许您在代码块中突出显示特定行。这在解释示例或提供指令时,用于引起对特定代码行的注意非常有用。您可以在代码块配置中使用hl_lines选项来指定要突出显示的行。有关更多详细信息和示例,您可以参考hl_lines文档

  • 警告提示: 警告提示是一种在文档中视觉上强调或引起注意某些信息的方式。它们有多种样式,如注释、警告、提示等。警告提示提供了一种结构化和一致的方式来呈现重要内容。有关使用示例和将警告提示纳入文档的详细信息,您可以参考警告提示文档

有关文档结构和功能的更多详细信息,请参阅MkDocs Material 文档

感谢您的贡献,祝您编程愉快!