From 2a10cabf66beb28f33af76f09b47e8ab969b6d77 Mon Sep 17 00:00:00 2001 From: Bagatur <22008038+baskaryan@users.noreply.github.com> Date: Tue, 12 Dec 2023 12:52:32 -0800 Subject: [PATCH] docs: core and community readme (#14623) --- README.md | 3 +- libs/community/README.md | 31 ++++++++++++++++++++- libs/core/README.md | 59 +++++++++++++++++++++++++++++++++++++++- 3 files changed, 89 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 38dd3c40dc2..428e762164e 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,7 @@ ⚑ Building applications with LLMs through composability ⚑ [![Release Notes](https://img.shields.io/github/release/langchain-ai/langchain)](https://github.com/langchain-ai/langchain/releases) -[![CI](https://github.com/langchain-ai/langchain/actions/workflows/langchain_ci.yml/badge.svg)](https://github.com/langchain-ai/langchain/actions/workflows/langchain_ci.yml) -[![Experimental CI](https://github.com/langchain-ai/langchain/actions/workflows/langchain_experimental_ci.yml/badge.svg)](https://github.com/langchain-ai/langchain/actions/workflows/langchain_experimental_ci.yml) +[![CI](https://github.com/langchain-ai/langchain/actions/workflows/check_diffs.yml/badge.svg)](https://github.com/langchain-ai/langchain/actions/workflows/check_diffs.yml) [![Downloads](https://static.pepy.tech/badge/langchain/month)](https://pepy.tech/project/langchain) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Twitter](https://img.shields.io/twitter/url/https/twitter.com/langchainai.svg?style=social&label=Follow%20%40LangChainAI)](https://twitter.com/langchainai) diff --git a/libs/community/README.md b/libs/community/README.md index d0f8c668bdc..2e718f6b812 100644 --- a/libs/community/README.md +++ b/libs/community/README.md @@ -1 +1,30 @@ -# langchain-community \ No newline at end of file +# πŸ¦œοΈπŸ§‘β€πŸ€β€πŸ§‘ LangChain Community + +[![Downloads](https://static.pepy.tech/badge/langchain_community/month)](https://pepy.tech/project/langchain_community) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) + +## Quick Install + +```bash +pip install langchain-community +``` + +## What is it? + +LangChain Community contains third-party integrations that implement the base interfaces defined in LangChain Core, making them ready-to-use in any LangChain application. + +For full documentation see the [API reference](https://api.python.langchain.com/en/stable/community_api_reference.html). + +![LangChain Stack](docs/static/img/langchain_stack.png) + +## πŸ“• Releases & Versioning + +`langchain-community` is currently on version `0.0.x` + +All changes will be accompanied by a patch version increase. + +## πŸ’ Contributing + +As an open-source project in a rapidly developing field, we are extremely open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation. + +For detailed information on how to contribute, see [here](.github/CONTRIBUTING.md).# langchain-community \ No newline at end of file diff --git a/libs/core/README.md b/libs/core/README.md index ef81c1da1ee..4da77665fa9 100644 --- a/libs/core/README.md +++ b/libs/core/README.md @@ -1 +1,58 @@ -# langchain-core +# 🦜🍎️ LangChain Core + +[![Downloads](https://static.pepy.tech/badge/langchain_core/month)](https://pepy.tech/project/langchain_core) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) + +## Quick Install + +```bash +pip install langchain-core +``` + +## What is it? + +LangChain Core contains the base abstractions that power the rest of the LangChain ecosystem. +These abstractions are designed to be as modular and simple as possible. +Examples of these abstractions include those for language models, document loaders, embedding models, vectorstores, retrievers, and more. +The benefit of having these abstractions is that any provider can implement the required interface and then easily be used in the rest of the LangChain ecosystem. + +For full documentation see the [API reference](https://api.python.langchain.com/en/stable/core_api_reference.html). + +## What is LangChain Expression Language? + +LangChain Core also contains LangChain Expression Language, or LCEL, a runtime that allows users to compose arbitrary sequences together and get several benefits that are important when building LLM applications. +We call these sequences β€œrunnables”. + +All runnables expose the same interface with single-invocation, batch, streaming and async methods. +This design is useful because it is not enough to have a single sync interface when building an LLM application. +Batch is needed for efficient processing of many inputs. +Streaming (and streaming of intermediate steps) is needed to show the user that progress is being made. +Async interfaces are nice when moving into production. +Rather than having to write multiple implementations for all of those, LCEL allows you to write a runnable once and invoke it in many different ways. + +For more check out the [LCEL docs](https://python.langchain.com/docs/expression_language/). + +![LangChain Stack](docs/static/img/langchain_stack.png) + +## πŸ“• Releases & Versioning + +`langchain-core` is currently on version `0.1.x`. + +As `langchain-core` contains the base abstractions and runtime for the whole LangChain ecosystem, we will communicate any breaking changes with advance notice and version bumps. The exception for this is anything in `langchain_core.beta`. The reason for `langchain_core.beta` is that given the rate of change of the field, being able to move quickly is still a priority, and this module is our attempt to do so. + +Minor version increases will occur for: + +- Breaking changes for any public interfaces NOT in `langchain_core.beta` + +Patch version increases will occur for: + +- Bug fixes +- New features +- Any changes to private interfaces +- Any changes to `langchain_core.beta` + +## πŸ’ Contributing + +As an open-source project in a rapidly developing field, we are extremely open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation. + +For detailed information on how to contribute, see [here](.github/CONTRIBUTING.md). \ No newline at end of file