From ca014d5b04b1d73fd8f0fe224def98a82600c991 Mon Sep 17 00:00:00 2001 From: Nuno Campos Date: Wed, 17 Jan 2024 13:56:07 -0800 Subject: [PATCH] Update readme (#16160) --- libs/core/README.md | 56 ++++++++++++++++++++++++++++++++++----------- 1 file changed, 43 insertions(+), 13 deletions(-) diff --git a/libs/core/README.md b/libs/core/README.md index 019f5b400bd..e110c443dfa 100644 --- a/libs/core/README.md +++ b/libs/core/README.md @@ -11,29 +11,50 @@ 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. +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? +## 1️⃣ Core Interface: Runnables -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”. +The concept of a Runnable is central to LangChain Core – it is the interface that most LangChain Core components implement, giving them -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. +- a common invocation interface (invoke, batch, stream, etc.) +- built-in utilities for retries, fallbacks, schemas and runtime configurability +- easy deployment with [LangServe](https://github.com/langchain-ai/langserve) + +For more check out the [runnable docs](https://python.langchain.com/docs/expression_language/interface). Examples of components that implement the interface include: LLMs, Chat Models, Prompts, Retrievers, Tools, Output Parsers. + +You can use LangChain Core objects in two ways: + +1. **imperative**, ie. call them directly, eg. `model.invoke(...)` + +2. **declarative**, with LangChain Expression Language (LCEL) + +| Feature | Imperative | Declarative | +| --------- | ------------------------------- | -------------- | +| Syntax | All of Python | LCEL | +| Tracing | ✅ – Automatic | ✅ – Automatic | +| Parallel | ✅ – with threads or coroutines | ✅ – Automatic | +| Streaming | ✅ – by yielding | ✅ – Automatic | +| Async | ✅ – by writing async functions | ✅ – Automatic | + +## ⚡️ What is LangChain Expression Language? + +LangChain Expression Language (LCEL) is a _declarative language_ for composing LangChain Core runnables into sequences (or DAGs), covering the most common patterns when building with LLMs. + +LangChain Core compiles LCEL sequences to an _optimized execution plan_, with automatic parallelization, streaming, tracing, and async support. For more check out the [LCEL docs](https://python.langchain.com/docs/expression_language/). ![Diagram outlining the hierarchical organization of the LangChain framework, displaying the interconnected parts across multiple layers.](../../docs/static/img/langchain_stack.png "LangChain Framework Overview") +For more advanced use cases, also check out [LangGraph](https://github.com/langchain-ai/langgraph), which is a graph-based runner for cyclic and recursive LLM workflows. + ## 📕 Releases & Versioning `langchain-core` is currently on version `0.1.x`. @@ -55,4 +76,13 @@ Patch version increases will occur for: 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 the [Contributing Guide](https://python.langchain.com/docs/contributing/). \ No newline at end of file +For detailed information on how to contribute, see the [Contributing Guide](https://python.langchain.com/docs/contributing/). + +## ⛰️ Why build on top of LangChain Core? + +The whole LangChain ecosystem is built on top of LangChain Core, so you're in good company when building on top of it. Some of the benefits: + +- **Modularity**: LangChain Core is designed around abstractions that are independent of each other, and not tied to any specific model provider. +- **Stability**: We are committed to a stable versioning scheme, and will communicate any breaking changes with advance notice and version bumps. +- **Battle-tested**: LangChain Core components have the largest install base in the LLM ecosystem, and are used in production by many companies. +- **Community**: LangChain Core is developed in the open, and we welcome contributions from the community.