在开始贡献LangChain的代码或文档之前,了解仓库的高层次结构会非常有帮助。LangChain组织为一个单体仓库(monorepo),其中包含多个包。可以参考我们的安装指南了解如何将它们组合在一起。接下来,我们通过树状图方式来可视化仓库结构:
.
├── cookbook # 教程和示例
├── docs # 文档内容,展示在此:https://python.langchain.com/
├── libs
│ ├── langchain
│ │ ├── langchain
│ │ ├── tests/unit_tests # 单元测试(每个包都有,简略展示)
│ │ ├── tests/integration_tests # 集成测试(每个包都有,简略展示)
│ ├── community # 第三方集成
│ │ ├── langchain-community
│ ├── core # 关键抽象的基础接口
│ │ ├── langchain-core
│ ├── experimental # 实验性组件和链条
│ │ ├── langchain-experimental
│ ├── cli # 命令行接口
│ │ ├── langchain-cli
│ ├── text-splitters
│ │ ├── langchain-text-splitters
│ ├── standard-tests
│ │ ├── langchain-standard-tests
│ ├── partners
│ ├── langchain-partner-1
│ ├── langchain-partner-2
│ ├── ...
│
├── templates # 各种任务的易于部署的参考架构集合
根目录还包含以下文件:
pyproject.toml
:用于构建文档和检查文档的依赖项。Makefile
:包含构建、检查和文档及示例的快捷方式。
其他文件在根目录级别也存在,但它们的存在应该是不言自明的。欢迎随意浏览!
文档
/docs
目录包含展示在https://python.langchain.com/上的文档内容及其相关API参考:https://api.python.langchain.com/en/latest/langchain_api_reference.html。查看文档指南以了解如何贡献文档内容。
代码
/libs
目录包含LangChain包的代码。要了解更多关于如何贡献代码,请参阅以下指南:
- 代码:了解如何在LangChain代码库中进行开发。
- 集成:学习如何贡献到第三方集成
langchain-community
或启动新的合作伙伴包。 - 测试:指导学习如何为包编写测试。
如果遇到问题欢迎在评论区交流。
—END—