mirror of
https://github.com/hwchase17/langchain
synced 2024-11-08 07:10:35 +00:00
a5999351cf
Adds release workflow that (1) creates a GitHub release and (2) publishes built artifacts to PyPI **Release Workflow** 1. Checkout `master` locally and cut a new branch 1. Run `poetry version <rule>` to version bump (e.g., `poetry version patch`) 1. Commit changes and push to remote branch 1. Ensure all quality check workflows pass 1. Explicitly tag PR with `release` label 1. Merge to mainline At this point, a release workflow should be triggered because: * The PR is closed, targeting `master`, and merged * `pyproject.toml` has been detected as modified * The PR had a `release` label The workflow will then proceed to build the artifacts, create a GitHub release with release notes and uploaded artifacts, and publish to PyPI. Example Workflow run: https://github.com/shoelsch/langchain/actions/runs/3711037455/jobs/6291076898 Example Releases: https://github.com/shoelsch/langchain/releases -- Note, this workflow is looking for the `PYPI_API_TOKEN` secret, so that will need to be uploaded to the repository secrets. I tested uploading as far as hitting a permissions issue due to project ownership in Test PyPI.
65 lines
3.7 KiB
Markdown
65 lines
3.7 KiB
Markdown
# 🦜️🔗 LangChain
|
|
|
|
⚡ Building applications with LLMs through composability ⚡
|
|
|
|
[](https://github.com/hwchase17/langchain/actions/workflows/lint.yml) [](https://github.com/hwchase17/langchain/actions/workflows/test.yml) [](https://github.com/hwchase17/langchain/actions/workflows/linkcheck.yml) [](https://opensource.org/licenses/MIT) [](https://twitter.com/langchainai) [](https://discord.gg/6adMQxSpJS)
|
|
|
|
## Quick Install
|
|
|
|
`pip install langchain`
|
|
|
|
## 🤔 What is this?
|
|
|
|
Large language models (LLMs) are emerging as a transformative technology, enabling
|
|
developers to build applications that they previously could not.
|
|
But using these LLMs in isolation is often not enough to
|
|
create a truly powerful app - the real power comes when you can combine them with other sources of computation or knowledge.
|
|
|
|
This library is aimed at assisting in the development of those types of applications.
|
|
|
|
## 📖 Documentation
|
|
|
|
Please see [here](https://langchain.readthedocs.io/en/latest/?) 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, generic interface for all LLMs, and common utilities for working with LLMs.
|
|
|
|
**🔗 Chains:**
|
|
|
|
Chains go beyond just a single LLM call, and are 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 datasource to fetch data to use in the generation step. Examples of this 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 is the concept of 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://langchain.readthedocs.io/en/latest/?).
|
|
|
|
## 💁 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 infra, or better documentation.
|
|
|
|
For detailed information on how to contribute, see [here](CONTRIBUTING.md).
|