From 260e8c7f0298d69a9c5b132c66489f4d7451ebc7 Mon Sep 17 00:00:00 2001 From: Gabriel Luiz Freitas Almeida Date: Wed, 26 Jul 2023 08:08:50 -0300 Subject: [PATCH] =?UTF-8?q?=F0=9F=94=A7=20chore(README.md):=20remove=20unn?= =?UTF-8?q?ecessary=20hyphen=20in=20Table=20of=20Contents=20=F0=9F=94=A7?= =?UTF-8?q?=20chore(README.md):=20remove=20empty=20line=20=F0=9F=94=A7=20c?= =?UTF-8?q?hore(README.md):=20remove=20unnecessary=20hyphen=20in=20Install?= =?UTF-8?q?ation=20section=20=F0=9F=94=A7=20chore(README.md):=20remove=20e?= =?UTF-8?q?mpty=20line=20=F0=9F=94=A7=20chore(README.md):=20remove=20unnec?= =?UTF-8?q?essary=20hyphen=20in=20Command=20Line=20Interface=20(CLI)=20sec?= =?UTF-8?q?tion=20=F0=9F=94=A7=20chore(README.md):=20remove=20empty=20line?= =?UTF-8?q?=20=F0=9F=94=A7=20chore(README.md):=20remove=20unnecessary=20hy?= =?UTF-8?q?phen=20in=20Usage=20section=20=F0=9F=94=A7=20chore(README.md):?= =?UTF-8?q?=20remove=20empty=20line=20=F0=9F=94=A7=20chore(README.md):=20r?= =?UTF-8?q?emove=20unnecessary=20hyphen=20in=20Deploy=20Langflow=20on=20Ji?= =?UTF-8?q?na=20AI=20Cloud=20section=20=F0=9F=94=A7=20chore(README.md):=20?= =?UTF-8?q?remove=20empty=20line=20=F0=9F=94=A7=20chore(README.md):=20remo?= =?UTF-8?q?ve=20unnecessary=20hyphen=20in=20Deploy=20on=20Railway=20sectio?= =?UTF-8?q?n=20=F0=9F=94=A7=20chore(README.md):=20remove=20empty=20line=20?= =?UTF-8?q?=F0=9F=94=A7=20chore(README.md):=20remove=20unnecessary=20hyphe?= =?UTF-8?q?n=20in=20Deploy=20on=20Render=20section=20=F0=9F=94=A7=20chore(?= =?UTF-8?q?README.md):=20remove=20empty=20line=20=F0=9F=94=A7=20chore(READ?= =?UTF-8?q?ME.md):=20remove=20unnecessary=20hyphen=20in=20Contributing=20s?= =?UTF-8?q?ection=20=F0=9F=94=A7=20chore(README.md):=20remove=20empty=20li?= =?UTF-8?q?ne=20=F0=9F=94=A7=20chore(README.md):=20remove=20unnecessary=20?= =?UTF-8?q?hyphen=20in=20License=20section?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 49 ++++++++++++++++++++++++++++++++----------------- 1 file changed, 32 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index ad212c0ee..a51416e4f 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,6 @@ Github License

-

Discord Server HuggingFace Spaces @@ -22,58 +21,74 @@ -

# Table of Contents + - [⛓️ Langflow](#️-langflow) - [Table of Contents](#table-of-contents) - [📦 Installation](#-installation) - - [Locally](#locally) - - [HuggingFace Spaces](#huggingface-spaces) + - [Locally](#locally) + - [HuggingFace](#huggingface) - [🖥️ Command Line Interface (CLI)](#️-command-line-interface-cli) - - [Usage](#usage) + - [Usage](#usage) - [Environment Variables](#environment-variables) - [Deployment](#deployment) - [Deploy Langflow on Google Cloud Platform](#deploy-langflow-on-google-cloud-platform) - [Deploy Langflow on Jina AI Cloud](#deploy-langflow-on-jina-ai-cloud) - [API Usage](#api-usage) + - [Deploy on Railway](#deploy-on-railway) + - [Deploy on Render](#deploy-on-render) - [🎨 Creating Flows](#-creating-flows) - [👋 Contributing](#-contributing) - [📄 License](#-license) - # 📦 Installation -### Locally + +## Locally + You can install Langflow from pip: ```shell +# This installs the package without dependencies for local models pip install langflow -# to install with dependencies for local models use: -pip install langflow[local] -# to install with all dependencies use: -pip install langflow[all] ``` +To use local models (e.g llama-cpp-python) run: + +```shell +pip install langflow[local] +``` + +This will install the following dependencies: + +- [CTransformers](https://github.com/marella/ctransformers) +- [llama-cpp-python](https://github.com/abetlen/llama-cpp-python) +- [huggingface-hub](https://github.com/huggingface/huggingface_hub) +- [sentence-transformers](https://github.com/UKPLab/sentence-transformers) + Next, run: ```shell python -m langflow ``` + or + ```shell langflow # or langflow --help ``` -### HuggingFace Spaces +## HuggingFace + You can also check it out on [HuggingFace Spaces](https://huggingface.co/spaces/Logspace/Langflow) and run it in your browser! You can even clone it and have your own copy of Langflow to play with. # 🖥️ Command Line Interface (CLI) Langflow provides a command-line interface (CLI) for easy management and configuration. -### Usage +## Usage You can run the Langflow using the following command: @@ -118,7 +133,6 @@ Alternatively, click the **"Open in Cloud Shell"** button below to launch Google [![Open in Cloud Shell](https://gstatic.com/cloudssh/images/open-btn.svg)](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/logspace-ai/langflow&working_dir=scripts&shellonly=true&tutorial=walkthroughtutorial_spot.md) - ## Deploy Langflow on [Jina AI Cloud](https://github.com/jina-ai/langchain-serve) Langflow integrates with langchain-serve to provide a one-command deployment to Jina AI Cloud. @@ -126,6 +140,8 @@ Langflow integrates with langchain-serve to provide a one-command deployment to Start by installing `langchain-serve` with ```bash +pip install langflow[deploy] +# or pip install -U langchain-serve ``` @@ -227,9 +243,11 @@ print(run_flow("Your message", flow_id=FLOW_ID, tweaks=TWEAKS)) > Read more about resource customization, cost, and management of Langflow apps on Jina AI Cloud in the **[langchain-serve](https://github.com/jina-ai/langchain-serve)** repository. ## Deploy on Railway + [![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/Emy2sU?referralCode=MnPSdg) ## Deploy on Render + Deploy to Render @@ -252,12 +270,10 @@ flow = load_flow_from_json("path/to/flow.json") flow("Hey, have you heard of Langflow?") ``` - # 👋 Contributing 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! 🦾

@@ -265,7 +281,6 @@ Join our [Discord](https://discord.com/invite/EqksyE2EX9) server to ask question [![Star History Chart](https://api.star-history.com/svg?repos=logspace-ai/langflow&type=Timeline)](https://star-history.com/#logspace-ai/langflow&Date) - # 📄 License Langflow is released under the MIT License. See the LICENSE file for details.