From bdc41d2856442ef714b9cab49df6cbb60ab5b5f1 Mon Sep 17 00:00:00 2001 From: Carlos Coelho <80289056+carlosrcoelho@users.noreply.github.com> Date: Wed, 21 Feb 2024 10:49:57 -0300 Subject: [PATCH] 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 --- README.md | 80 +++++++++++++++++++++---------------------------------- 1 file changed, 31 insertions(+), 49 deletions(-) diff --git a/README.md b/README.md index 53ce90086..5547694a0 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,27 @@ - + # ⛓️ Langflow -~ An effortless way to experiment and prototype [LangChain](https://github.com/hwchase17/langchain) pipelines ~ +

Discover a simpler & smarter way to build around Foundation Models

-

-GitHub Contributors -GitHub Last Commit - -GitHub Issues -GitHub Pull Requests -Github License -

+[![Release Notes](https://img.shields.io/github/release/logspace-ai/langflow)](https://github.com/logspace-ai/langflow/releases) +[![Contributors](https://img.shields.io/github/contributors/logspace-ai/langflow)](https://github.com/logspace-ai/langflow/contributors) +[![Last Commit](https://img.shields.io/github/last-commit/logspace-ai/langflow)](https://github.com/logspace-ai/langflow/last-commit) +[![Open Issues](https://img.shields.io/github/issues-raw/logspace-ai/langflow)](https://github.com/logspace-ai/langflow/issues) +[![LRepo-size](https://img.shields.io/github/repo-size/logspace-ai/langflow)](https://github.com/logspace-ai/langflow/repo-size) +[![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/logspace-ai/langflow) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) +[![GitHub star chart](https://img.shields.io/github/stars/logspace-ai/langflow?style=social)](https://star-history.com/#logspace-ai/langflow) +[![GitHub fork](https://img.shields.io/github/forks/logspace-ai/langflow?style=social)](https://github.com/logspace-ai/langflow/fork) +[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/langflow_ai.svg?style=social&label=Follow%20%40langflow_ai)](https://twitter.com/langflow_ai) +[![](https://dcbadge.vercel.app/api/server/EqksyE2EX9?compact=true&style=flat)](https://discord.com/invite/EqksyE2EX9) +[![HuggingFace Spaces](https://huggingface.co/datasets/huggingface/badges/raw/main/open-in-hf-spaces-sm.svg)](https://huggingface.co/spaces/Logspace/Langflow) +[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/logspace-ai/langflow) -

-Discord Server -HuggingFace Spaces -

+The easiest way to create and customize your flow - - -

-

- -# 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 @@ -65,7 +46,7 @@ This will install the following dependencies: - [llama-cpp-python](https://github.com/abetlen/llama-cpp-python) - [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: @@ -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. - `--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 @@ -147,19 +128,19 @@ Alternatively, click the **"Open in Cloud Shell"** button below to launch Google # 🎨 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. -To do so, click the "Export" button in the top right corner of the canvas, then -in Python, you can load the flow with: +Once you’re done, you can export your flow as a JSON file. + +Load the flow with: ```python from langflow import load_flow_from_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?") ``` @@ -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. +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! 🦾 - -

-

- [![Star History Chart](https://api.star-history.com/svg?repos=logspace-ai/langflow&type=Timeline)](https://star-history.com/#logspace-ai/langflow&Date) +# 🌟 Contributors + +[![langflow contributors](https://contrib.rocks/image?repo=logspace-ai/langflow)](https://github.com/logspace-ai/langflow/graphs/contributors) + # 📄 License Langflow is released under the MIT License. See the LICENSE file for details.