mirror of
https://github.com/hwchase17/langchain.git
synced 2026-04-03 10:55:08 +00:00
aff771923a
Use docusaurus versioning with a callout, merged master as well @hwchase17 @baskaryan --------- Signed-off-by: Weichen Xu <weichen.xu@databricks.com> Signed-off-by: Rahul Tripathi <rauhl.psit.ec@gmail.com> Co-authored-by: Leonid Ganeline <leo.gan.57@gmail.com> Co-authored-by: Leonid Kuligin <lkuligin@yandex.ru> Co-authored-by: Averi Kitsch <akitsch@google.com> Co-authored-by: Erick Friis <erick@langchain.dev> Co-authored-by: Nuno Campos <nuno@langchain.dev> Co-authored-by: Nuno Campos <nuno@boringbits.io> Co-authored-by: Bagatur <22008038+baskaryan@users.noreply.github.com> Co-authored-by: Eugene Yurtsev <eyurtsev@gmail.com> Co-authored-by: Martín Gotelli Ferenaz <martingotelliferenaz@gmail.com> Co-authored-by: Fayfox <admin@fayfox.com> Co-authored-by: Eugene Yurtsev <eugene@langchain.dev> Co-authored-by: Dawson Bauer <105886620+djbauer2@users.noreply.github.com> Co-authored-by: Ravindu Somawansa <ravindu.somawansa@gmail.com> Co-authored-by: Dhruv Chawla <43818888+Dominastorm@users.noreply.github.com> Co-authored-by: ccurme <chester.curme@gmail.com> Co-authored-by: Bagatur <baskaryan@gmail.com> Co-authored-by: WeichenXu <weichen.xu@databricks.com> Co-authored-by: Benito Geordie <89472452+benitoThree@users.noreply.github.com> Co-authored-by: kartikTAI <129414343+kartikTAI@users.noreply.github.com> Co-authored-by: Kartik Sarangmath <kartik@thirdai.com> Co-authored-by: Sevin F. Varoglu <sfvaroglu@octoml.ai> Co-authored-by: MacanPN <martin.triska@gmail.com> Co-authored-by: Prashanth Rao <35005448+prrao87@users.noreply.github.com> Co-authored-by: Hyeongchan Kim <kozistr@gmail.com> Co-authored-by: sdan <git@sdan.io> Co-authored-by: Guangdong Liu <liugddx@gmail.com> Co-authored-by: Rahul Triptahi <rahul.psit.ec@gmail.com> Co-authored-by: Rahul Tripathi <rauhl.psit.ec@gmail.com> Co-authored-by: pjb157 <84070455+pjb157@users.noreply.github.com> Co-authored-by: Eun Hye Kim <ehkim1440@gmail.com> Co-authored-by: kaijietti <43436010+kaijietti@users.noreply.github.com> Co-authored-by: Pengcheng Liu <pcliu.fd@gmail.com> Co-authored-by: Tomer Cagan <tomer@tomercagan.com> Co-authored-by: Christophe Bornet <cbornet@hotmail.com>
55 lines
2.3 KiB
Plaintext
55 lines
2.3 KiB
Plaintext
---
|
|
sidebar_position: 0.5
|
|
---
|
|
# Repository Structure
|
|
|
|
If you plan on contributing to LangChain code or documentation, it can be useful
|
|
to understand the high level structure of the repository.
|
|
|
|
LangChain is organized as a [monorep](https://en.wikipedia.org/wiki/Monorepo) that contains multiple packages.
|
|
|
|
Here's the structure visualized as a tree:
|
|
|
|
```text
|
|
.
|
|
├── cookbook # Tutorials and examples
|
|
├── docs # Contains content for the documentation here: https://python.langchain.com/
|
|
├── libs
|
|
│ ├── langchain # Main package
|
|
│ │ ├── tests/unit_tests # Unit tests (present in each package not shown for brevity)
|
|
│ │ ├── tests/integration_tests # Integration tests (present in each package not shown for brevity)
|
|
│ ├── langchain-community # Third-party integrations
|
|
│ ├── langchain-core # Base interfaces for key abstractions
|
|
│ ├── langchain-experimental # Experimental components and chains
|
|
│ ├── partners
|
|
│ ├── langchain-partner-1
|
|
│ ├── langchain-partner-2
|
|
│ ├── ...
|
|
│
|
|
├── templates # A collection of easily deployable reference architectures for a wide variety of tasks.
|
|
```
|
|
|
|
The root directory also contains the following files:
|
|
|
|
* `pyproject.toml`: Dependencies for building docs and linting docs, cookbook.
|
|
* `Makefile`: A file that contains shortcuts for building, linting and docs and cookbook.
|
|
|
|
There are other files in the root directory level, but their presence should be self-explanatory. Feel free to browse around!
|
|
|
|
## Documentation
|
|
|
|
The `/docs` directory contains the content for the documentation that is shown
|
|
at https://python.langchain.com/ and the associated API Reference https://api.python.langchain.com/en/latest/langchain_api_reference.html.
|
|
|
|
See the [documentation](/docs/contributing/documentation/style_guide) guidelines to learn how to contribute to the documentation.
|
|
|
|
## Code
|
|
|
|
The `/libs` directory contains the code for the LangChain packages.
|
|
|
|
To learn more about how to contribute code see the following guidelines:
|
|
|
|
- [Code](./code.mdx) Learn how to develop in the LangChain codebase.
|
|
- [Integrations](./integrations.mdx) to learn how to contribute to third-party integrations to langchain-community or to start a new partner package.
|
|
- [Testing](./testing.mdx) guidelines to learn how to write tests for the packages.
|