Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add news about first release #66

Merged
merged 5 commits into from
Mar 29, 2024
Merged

add news about first release #66

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
822fdd1
add news about first release
lilyjazz Mar 29, 2024
76e621d
Update README.md
lilyjazz Mar 29, 2024
2643db0
fix some typos
lilyjazz Mar 29, 2024
8e4a732
opt the link words
lilyjazz Mar 29, 2024
3be0c3c
change the docker compose link
lilyjazz Mar 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
:construction: This repository is currently under construction. Stay tuned – it's coming soon!

# LinguFlow

🎉🚀🌍 **LinguFlow** is now live for the world to see! `Hello, World!`

## What is LinguFlow

LinguFlow, a low-code tool designed for LLM application development, simplifies the building, debugging, and deployment process for developers. It utilizes a DAG-based message flow for business logic, requiring only minimal familiarity with LinguFlow blocks to effectively use.
LinguFlow, a low-code tool designed for LLM application development, simplifies the building, debugging, and deployment process for developers. It utilizes a [DAG (Directed Acyclic Graph)](https://en.wikipedia.org/wiki/Directed_acyclic_graph)-based message flow for business logic, requiring only minimal familiarity with LinguFlow blocks to effectively use.

### Why we need LinguFlow?

Expand All @@ -14,9 +14,9 @@ When attempting to apply LLM to real-world business scenarios, the limitations o
- The inability to restrict the conversation to business-relevant topics only.
- Challenges in handling complex business processes.

LinguFlow is needed precisely to overcome these challenges, offering a platform that enables the structured building of LLM applications tailored to specific business needs and enhancing their accuracy over time. The most classic approach to deploying applications with LLM (Large Language Models) is through the construction of a [DAG (Directed Acyclic Graph)](https://en.wikipedia.org/wiki/Directed_acyclic_graph).
LinguFlow is needed precisely to overcome these challenges, offering a platform that enables the structured building of LLM applications tailored to specific business needs and enhancing their accuracy over time. The most classic approach to deploying applications with LLM (Large Language Models) is through the construction of a DAG.

### the features with LinguFlow
### Features with LinguFlow

Thus, the features of applications developed with LinguFlow include:

Expand All @@ -33,11 +33,12 @@ In essence, LinguFlow's design and implementation method offer a structured and

### Localhost (docker)

You can run LinguFlow on your local machine using [docker](https://docs.docker.com/get-docker/) compose. This setup is perfect for developing, testing LinguFlow applications, and diagnosing integration issues.
You can run LinguFlow on your local machine using [docker compose](https://docs.docker.com/compose/install/). This setup is perfect for developing, testing LinguFlow applications, and diagnosing integration issues.

```sh
# Clone the LinguFlow repository
git clone [email protected]:pingcap/LinguFlow.git

# Navigate into the LinguFlow directory
cd LinguFlow

Expand All @@ -63,4 +64,4 @@ LinguFlow Server, which includes the API and Web UI, is open-source and can be s

## License

This repository is MIT licensed, except for the ee/ folder. See [LICENSE](LICENSE) for more details.
This repository is MIT licensed, except for the ee/ folder. See [LICENSE](LICENSE) for more details.