jyapayne/langflow
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

README Improvements (#1597)

Browse source 
* Improve readme

* Fix buttons

* Improve discord link

* Improve image formatting

* additional getting started improvements

* Update README.md

* Update README.md

* Update README.md

* Update spaces link

* Update README.md

* Update LICENSE

* Update README.md

* Update README.md

* Update README.md

* Update README.md
This commit is contained in:
Alex Leventer 2024-04-03 20:39:13 -07:00 • committed by GitHub
commit 20f640c4ce
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 27 additions and 62 deletions
Download patch file Download diff file Expand all files Collapse all files

2
LICENSE
View file

@ -1,6 +1,6 @@
MIT License MIT License
Copyright (c) 2023 Logspace Copyright (c) 2024 Logspace
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal

87
README.md
View file

@ -2,66 +2,49 @@
# ⛓️ Langflow # ⛓️ Langflow
<h3>Discover a simpler & smarter way to build around Foundation Models</h3> ### Discover a simpler & smarter way to build around Foundation Models</h3>
# [![Langflow](https://github.com/logspace-ai/langflow/blob/dev/docs/static/img/new_langflow_demo.gif)](https://www.langflow.org)
[![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)
<a href="https://github.com/logspace-ai/langflow">
<img width="100%" src="https://github.com/logspace-ai/langflow/blob/dev/docs/static/img/new_langflow_demo.gif"></a>
# 📦 Installation # 📦 Installation
### <b>Locally</b> You can install Langflow with pip:
You can install Langflow from pip:
```shell ```shell
# This installs the package without dependencies for local models # Install the pre-release version
pip install langflow pip install langflow --pre --force-reinstall
# or stable version
pip install langflow -U
``` ```
To use local models (e.g llama-cpp-python) run: Then, run Langflow with:
```shell ```shell
pip install langflow[local] python -m langflow run
# or
langflow run
``` ```
This will install the following dependencies: You can also preview Langflow in [HuggingFace Spaces](https://huggingface.co/spaces/Logspace/Langflow-Preview). [Clone the space using this link](https://huggingface.co/spaces/Logspace/Langflow-Preview?duplicate=true), to create your own Langflow workspace in minutes.
- [CTransformers](https://github.com/marella/ctransformers) # 🎨 Creating Flows
- [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, Ollama, LM Studio, Jan and others. Creating flows with Langflow is easy. Simply drag components from the sidebar onto the canvas and connect them to start building your application.
Next, run: Explore by editing prompt parameters, grouping components into a single high-level component, and building your own Custom Components.
```shell Once you’re done, you can export your flow as a JSON file.
python -m langflow
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
flow("Hey, have you heard of Langflow?")
``` ```
or
```shell
langflow run # or langflow --help
```
### HuggingFace Spaces
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) # 🖥️ Command Line Interface (CLI)
Langflow provides a command-line interface (CLI) for easy management and configuration. Langflow provides a command-line interface (CLI) for easy management and configuration.
@ -124,24 +107,6 @@ Alternatively, click the **"Open in Cloud Shell"** button below to launch Google
<img src="https://render.com/images/deploy-to-render-button.svg" alt="Deploy to Render" /> <img src="https://render.com/images/deploy-to-render-button.svg" alt="Deploy to Render" />
</a> </a>
# 🎨 Creating Flows
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, 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.
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
flow("Hey, have you heard of Langflow?")
```
# 👋 Contributing # 👋 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. 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.