-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* add news about first release * Update README.md * fix some typos * opt the link words * change the docker compose link
- Loading branch information
Showing
1 changed file
with
8 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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? | ||
|
||
|
@@ -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: | ||
|
||
|
@@ -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 | ||
|
||
|
@@ -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. |