mirror of
https://github.com/hwchase17/langchain
synced 2024-10-31 15:20:26 +00:00
a214fe8a2d
Mainly created for the code space url that was broken but fixed the others in the same PR.
104 lines
6.2 KiB
Markdown
104 lines
6.2 KiB
Markdown
# 🦜️🔗 LangChain
|
|
|
|
⚡ 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)
|
|
[![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)
|
|
[![](https://dcbadge.vercel.app/api/server/6adMQxSpJS?compact=true&style=flat)](https://discord.gg/6adMQxSpJS)
|
|
[![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/langchain-ai/langchain)
|
|
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/langchain-ai/langchain)
|
|
[![GitHub star chart](https://img.shields.io/github/stars/langchain-ai/langchain?style=social)](https://star-history.com/#langchain-ai/langchain)
|
|
[![Dependency Status](https://img.shields.io/librariesio/github/langchain-ai/langchain)](https://libraries.io/github/langchain-ai/langchain)
|
|
[![Open Issues](https://img.shields.io/github/issues-raw/langchain-ai/langchain)](https://github.com/langchain-ai/langchain/issues)
|
|
|
|
|
|
Looking for the JS/TS version? Check out [LangChain.js](https://github.com/hwchase17/langchainjs).
|
|
|
|
**Production Support:** As you move your LangChains into production, we'd love to offer more hands-on support.
|
|
Fill out [this form](https://airtable.com/appwQzlErAS2qiP0L/shrGtGaVBVAz7NcV2) to share more about what you're building, and our team will get in touch.
|
|
|
|
## 🚨Breaking Changes for select chains (SQLDatabase) on 7/28/23
|
|
|
|
In an effort to make `langchain` leaner and safer, we are moving select chains to `langchain_experimental`.
|
|
This migration has already started, but we are remaining backwards compatible until 7/28.
|
|
On that date, we will remove functionality from `langchain`.
|
|
Read more about the motivation and the progress [here](https://github.com/hwchase17/langchain/discussions/8043).
|
|
Read how to migrate your code [here](MIGRATE.md).
|
|
|
|
## Quick Install
|
|
|
|
`pip install langchain`
|
|
or
|
|
`pip install langsmith && conda install langchain -c conda-forge`
|
|
|
|
## 🤔 What is this?
|
|
|
|
Large language models (LLMs) are emerging as a transformative technology, enabling developers to build applications that they previously could not. However, using these LLMs in isolation is often insufficient for creating a truly powerful app - the real power comes when you can combine them with other sources of computation or knowledge.
|
|
|
|
This library aims to assist in the development of those types of applications. Common examples of these applications include:
|
|
|
|
**❓ Question Answering over specific documents**
|
|
|
|
- [Documentation](https://python.langchain.com/docs/use_cases/question_answering/)
|
|
- End-to-end Example: [Question Answering over Notion Database](https://github.com/hwchase17/notion-qa)
|
|
|
|
**💬 Chatbots**
|
|
|
|
- [Documentation](https://python.langchain.com/docs/use_cases/chatbots/)
|
|
- End-to-end Example: [Chat-LangChain](https://github.com/hwchase17/chat-langchain)
|
|
|
|
**🤖 Agents**
|
|
|
|
- [Documentation](https://python.langchain.com/docs/modules/agents/)
|
|
- End-to-end Example: [GPT+WolframAlpha](https://huggingface.co/spaces/JavaFXpert/Chat-GPT-LangChain)
|
|
|
|
## 📖 Documentation
|
|
|
|
Please see [here](https://python.langchain.com) for full documentation on:
|
|
|
|
- Getting started (installation, setting up the environment, simple examples)
|
|
- How-To examples (demos, integrations, helper functions)
|
|
- Reference (full API docs)
|
|
- Resources (high-level explanation of core concepts)
|
|
|
|
## 🚀 What can this help with?
|
|
|
|
There are six main areas that LangChain is designed to help with.
|
|
These are, in increasing order of complexity:
|
|
|
|
**📃 LLMs and Prompts:**
|
|
|
|
This includes prompt management, prompt optimization, a generic interface for all LLMs, and common utilities for working with LLMs.
|
|
|
|
**🔗 Chains:**
|
|
|
|
Chains go beyond a single LLM call and involve sequences of calls (whether to an LLM or a different utility). LangChain provides a standard interface for chains, lots of integrations with other tools, and end-to-end chains for common applications.
|
|
|
|
**📚 Data Augmented Generation:**
|
|
|
|
Data Augmented Generation involves specific types of chains that first interact with an external data source to fetch data for use in the generation step. Examples include summarization of long pieces of text and question/answering over specific data sources.
|
|
|
|
**🤖 Agents:**
|
|
|
|
Agents involve an LLM making decisions about which Actions to take, taking that Action, seeing an Observation, and repeating that until done. LangChain provides a standard interface for agents, a selection of agents to choose from, and examples of end-to-end agents.
|
|
|
|
**🧠 Memory:**
|
|
|
|
Memory refers to persisting state between calls of a chain/agent. LangChain provides a standard interface for memory, a collection of memory implementations, and examples of chains/agents that use memory.
|
|
|
|
**🧐 Evaluation:**
|
|
|
|
[BETA] Generative models are notoriously hard to evaluate with traditional metrics. One new way of evaluating them is using language models themselves to do the evaluation. LangChain provides some prompts/chains for assisting in this.
|
|
|
|
For more information on these concepts, please see our [full documentation](https://python.langchain.com).
|
|
|
|
## 💁 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).
|