Update Langflow README (#1456)
* Update Langflow README * Refactor flow creation process * Update README.md * Removed some phrases, changed Creating Flows section * Update README.md with additional project references --------- Co-authored-by: Gabriel Luiz Freitas Almeida <gabriel@logspace.ai>
This commit is contained in:
Carlos Coelho
GitHub
parent
e99ee9303f
commit
bdc41d2856
1 changed files with 31 additions and 49 deletions
80
README.md
80
README.md
|
|
@ -1,46 +1,27 @@
|
||||||
<!-- Title -->
|
<!-- markdownlint-disable MD030 -->
|
||||||
|
|
||||||
# ⛓️ Langflow
|
# ⛓️ Langflow
|
||||||
|
|
||||||
~ An effortless way to experiment and prototype [LangChain](https://github.com/hwchase17/langchain) pipelines ~
|
<h3>Discover a simpler & smarter way to build around Foundation Models</h3>
|
||||||
|
|
||||||
<p>
|
[](https://github.com/logspace-ai/langflow/releases)
|
||||||
<img alt="GitHub Contributors" src="https://img.shields.io/github/contributors/logspace-ai/langflow" />
|
[](https://github.com/logspace-ai/langflow/contributors)
|
||||||
<img alt="GitHub Last Commit" src="https://img.shields.io/github/last-commit/logspace-ai/langflow" />
|
[](https://github.com/logspace-ai/langflow/last-commit)
|
||||||
<img alt="" src="https://img.shields.io/github/repo-size/logspace-ai/langflow" />
|
[](https://github.com/logspace-ai/langflow/issues)
|
||||||
<img alt="GitHub Issues" src="https://img.shields.io/github/issues/logspace-ai/langflow" />
|
[](https://github.com/logspace-ai/langflow/repo-size)
|
||||||
<img alt="GitHub Pull Requests" src="https://img.shields.io/github/issues-pr/logspace-ai/langflow" />
|
[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/logspace-ai/langflow)
|
||||||
<img alt="Github License" src="https://img.shields.io/github/license/logspace-ai/langflow" />
|
[](https://opensource.org/licenses/MIT)
|
||||||
</p>
|
[](https://star-history.com/#logspace-ai/langflow)
|
||||||
|
[](https://github.com/logspace-ai/langflow/fork)
|
||||||
|
[](https://twitter.com/langflow_ai)
|
||||||
|
[](https://discord.com/invite/EqksyE2EX9)
|
||||||
|
[](https://huggingface.co/spaces/Logspace/Langflow)
|
||||||
|
[](https://codespaces.new/logspace-ai/langflow)
|
||||||
|
|
||||||
<p>
|
The easiest way to create and customize your flow
|
||||||
<a href="https://discord.gg/EqksyE2EX9"><img alt="Discord Server" src="https://dcbadge.vercel.app/api/server/EqksyE2EX9?compact=true&style=flat"/></a>
|
|
||||||
<a href="https://huggingface.co/spaces/Logspace/Langflow"><img src="https://huggingface.co/datasets/huggingface/badges/raw/main/open-in-hf-spaces-sm.svg" alt="HuggingFace Spaces"></a>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<a href="https://github.com/logspace-ai/langflow">
|
<a href="https://github.com/logspace-ai/langflow">
|
||||||
<img width="100%" src="https://github.com/logspace-ai/langflow/blob/dev/img/langflow-demo.gif?raw=true"></a>
|
<img width="100%" src="https://github.com/logspace-ai/langflow/blob/dev/img/new_langflow_demo.gif"></a>
|
||||||
|
|
||||||
<p>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
# Table of Contents
|
|
||||||
|
|
||||||
- [⛓️ Langflow](#️-langflow)
|
|
||||||
- [Table of Contents](#table-of-contents)
|
|
||||||
- [📦 Installation](#-installation)
|
|
||||||
- [Locally](#locally)
|
|
||||||
- [HuggingFace Spaces](#huggingface-spaces)
|
|
||||||
- [🖥️ Command Line Interface (CLI)](#️-command-line-interface-cli)
|
|
||||||
- [Usage](#usage)
|
|
||||||
- [Environment Variables](#environment-variables)
|
|
||||||
- [Deployment](#deployment)
|
|
||||||
- [Deploy Langflow on Google Cloud Platform](#deploy-langflow-on-google-cloud-platform)
|
|
||||||
- [Deploy on Railway](#deploy-on-railway)
|
|
||||||
- [Deploy on Render](#deploy-on-render)
|
|
||||||
- [🎨 Creating Flows](#-creating-flows)
|
|
||||||
- [👋 Contributing](#-contributing)
|
|
||||||
- [📄 License](#-license)
|
|
||||||
|
|
||||||
# 📦 Installation
|
# 📦 Installation
|
||||||
|
|
||||||
|
|
@ -65,7 +46,7 @@ This will install the following dependencies:
|
||||||
- [llama-cpp-python](https://github.com/abetlen/llama-cpp-python)
|
- [llama-cpp-python](https://github.com/abetlen/llama-cpp-python)
|
||||||
- [sentence-transformers](https://github.com/UKPLab/sentence-transformers)
|
- [sentence-transformers](https://github.com/UKPLab/sentence-transformers)
|
||||||
|
|
||||||
You can still use models from projects like LocalAI
|
You can still use models from projects like LocalAI, Ollama, LM Studio, Jan and others.
|
||||||
|
|
||||||
Next, run:
|
Next, run:
|
||||||
|
|
||||||
|
|
@ -117,7 +98,7 @@ Each option is detailed below:
|
||||||
- `--backend-only`: This parameter, with a default value of `False`, allows running only the backend server without the frontend. It can also be set using the `LANGFLOW_BACKEND_ONLY` environment variable.
|
- `--backend-only`: This parameter, with a default value of `False`, allows running only the backend server without the frontend. It can also be set using the `LANGFLOW_BACKEND_ONLY` environment variable.
|
||||||
- `--store`: This parameter, with a default value of `True`, enables the store features, use `--no-store` to deactivate it. It can be configured using the `LANGFLOW_STORE` environment variable.
|
- `--store`: This parameter, with a default value of `True`, enables the store features, use `--no-store` to deactivate it. It can be configured using the `LANGFLOW_STORE` environment variable.
|
||||||
|
|
||||||
These parameters are important for users who need to customize the behavior of Langflow, especially in development or specialized deployment scenarios. You may want to update the documentation to include these parameters for completeness and clarity.
|
These parameters are important for users who need to customize the behavior of Langflow, especially in development or specialized deployment scenarios.
|
||||||
|
|
||||||
### Environment Variables
|
### Environment Variables
|
||||||
|
|
||||||
|
|
@ -147,19 +128,19 @@ Alternatively, click the **"Open in Cloud Shell"** button below to launch Google
|
||||||
|
|
||||||
# 🎨 Creating Flows
|
# 🎨 Creating Flows
|
||||||
|
|
||||||
Creating flows with Langflow is easy. Simply drag sidebar components onto the canvas and connect them together to create your pipeline. Langflow provides a range of [LangChain components](https://python.langchain.com/docs/integrations/components) to choose from, including LLMs, prompt serializers, agents, and chains.
|
Creating flows with Langflow is easy. Simply drag components from the sidebar onto the canvas and connect them to start building your application.
|
||||||
|
|
||||||
Explore by editing prompt parameters, link chains and agents, track an agent's thought process, and export your flow.
|
Explore by editing prompt parameters, grouping components into a single high-level component, and building your own Custom Components.
|
||||||
|
|
||||||
Once you're done, you can export your flow as a JSON file to use with LangChain.
|
Once you’re done, you can export your flow as a JSON file.
|
||||||
To do so, click the "Export" button in the top right corner of the canvas, then
|
|
||||||
in Python, you can load the flow with:
|
Load the flow with:
|
||||||
|
|
||||||
```python
|
```python
|
||||||
from langflow import load_flow_from_json
|
from langflow import load_flow_from_json
|
||||||
|
|
||||||
flow = load_flow_from_json("path/to/flow.json")
|
flow = load_flow_from_json("path/to/flow.json")
|
||||||
# Now you can use it like any chain
|
# Now you can use it
|
||||||
flow("Hey, have you heard of Langflow?")
|
flow("Hey, have you heard of Langflow?")
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -167,15 +148,16 @@ flow("Hey, have you heard of Langflow?")
|
||||||
|
|
||||||
We welcome contributions from developers of all levels to our open-source project on GitHub. If you'd like to contribute, please check our [contributing guidelines](./CONTRIBUTING.md) and help make Langflow more accessible.
|
We welcome contributions from developers of all levels to our open-source project on GitHub. If you'd like to contribute, please check our [contributing guidelines](./CONTRIBUTING.md) and help make Langflow more accessible.
|
||||||
|
|
||||||
|
Join our [Discord](https://discord.com/invite/EqksyE2EX9) server to ask questions, make suggestions, and showcase your projects! 🦾
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
Join our [Discord](https://discord.com/invite/EqksyE2EX9) server to ask questions, make suggestions and showcase your projects! 🦾
|
|
||||||
|
|
||||||
<p>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
[](https://star-history.com/#logspace-ai/langflow&Date)
|
[](https://star-history.com/#logspace-ai/langflow&Date)
|
||||||
|
|
||||||
|
# 🌟 Contributors
|
||||||
|
|
||||||
|
[](https://github.com/logspace-ai/langflow/graphs/contributors)
|
||||||
|
|
||||||
# 📄 License
|
# 📄 License
|
||||||
|
|
||||||
Langflow is released under the MIT License. See the LICENSE file for details.
|
Langflow is released under the MIT License. See the LICENSE file for details.
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue