mirror of
https://github.com/trustgraph-ai/trustgraph.git
synced 2026-04-29 02:23:44 +02:00
Update README.md
Instructions for config UI in readme
This commit is contained in:
parent
d55613a258
commit
248e23fe91
1 changed files with 26 additions and 2 deletions
28
README.md
28
README.md
|
|
@ -22,7 +22,31 @@ The processing showcases the reliability and efficiences of GraphRAG algorithms
|
|||
pip3 install trustgraph-cli
|
||||
```
|
||||
|
||||
## Download TrustGraph
|
||||
## Quickstart UI
|
||||
|
||||
While TrustGraph is endlessly customizable, the quickstart configuration editor can build a custom configuration in seconds with Docker.
|
||||
|
||||
[Launch the Quickstart UI 🚀](https://config-ui.demo.trustgraph.ai/)
|
||||
|
||||
Launch Steps:
|
||||
|
||||
- For the selected `Model Deployment`, follow the instructions in `Model credentials` section to configure any required environment variables or paths
|
||||
- Fill in the desired LLM name in the `Model Name` field that corresponds to your selected `Model Deployment`
|
||||
- Set all desired `Model Parameters`
|
||||
- Click `GENERATE` under the `Deployment configuration` section
|
||||
- Follow the instructions under `Launch`
|
||||
|
||||
Once `deploy.zip` has been unzipped, launching TrustGraph is as simple as navigating to the `deploy` directory and running:
|
||||
```
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
When finished, shutting down TrustGraph is as simple as:
|
||||
```
|
||||
docker compose down -v
|
||||
```
|
||||
|
||||
## TrustGraph Releases
|
||||
|
||||
TrustGraph releases are available [here](https://github.com/trustgraph-ai/trustgraph/releases). Download `deploy.zip` for the desired release version.
|
||||
|
||||
|
|
@ -112,7 +136,7 @@ PDF file:
|
|||
tg-load-pdf <document.pdf>
|
||||
```
|
||||
|
||||
Text file:
|
||||
Text or Markdown file:
|
||||
```
|
||||
tg-load-text <document.txt>
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue