Update 0.11 release with front-page README changes (#98)

* Readme updates
* Fixed typo
* Updated banner image
* Updated readme table
---------
Authored-by: JackColquitt <daniel@kalntera.ai>
This commit is contained in:
cybermaggedon 2024-10-03 09:58:29 +01:00 committed by GitHub
parent adba99f270
commit 44a6088465
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 44 additions and 40 deletions

View file

@ -1,7 +1,7 @@
# TrustGraph # TrustGraph
![TrustGraph banner](TG_Banner_readme.png) ![TrustGraph banner](TG_readme.png)
🚀 [Full Documentation](https://trustgraph.ai/docs/getstarted) 🚀 [Full Documentation](https://trustgraph.ai/docs/getstarted)
💬 [Join the Discord](https://discord.gg/AXpxVjwzAw) 💬 [Join the Discord](https://discord.gg/AXpxVjwzAw)
@ -16,54 +16,58 @@ The pipeline processing components are interconnected with a pub/sub engine to m
The processing showcases the reliability and efficiences of GraphRAG algorithms which can capture contextual language flags that are missed in conventional RAG approaches. Graph querying algorithms enable retrieving not just relevant knowledge but language cues essential to understanding semantic uses unique to a text corpus. The processing showcases the reliability and efficiences of GraphRAG algorithms which can capture contextual language flags that are missed in conventional RAG approaches. Graph querying algorithms enable retrieving not just relevant knowledge but language cues essential to understanding semantic uses unique to a text corpus.
## Deploy in Minutes ## Install the TrustGraph CLI
TrustGraph is designed to deploy all the services and stores needed for a scalable GraphRAG infrastructure as quickly and simply as possible.
### Install Requirements
``` ```
python3 -m venv env pip3 install trustgraph-cli
. env/bin/activate
pip3 install pulsar-client
pip3 install cassandra-driver
export PYTHON_PATH=.
``` ```
### Download TrustGraph ## Download TrustGraph
``` TrustGraph releases are available [here](https://github.com/trustgraph-ai/trustgraph/releases). Download `deploy.zip` for the desired release version.
git clone https://github.com/trustgraph-ai/trustgraph trustgraph
cd trustgraph
```
TrustGraph is fully containerized and is launched with a Docker Compose `YAML` file. These files are prebuilt and included in the download main directory. Simply select the file that matches your desired model deployment and graph store configuration. | Release Type | Release Version |
| ------------ | --------------- |
| Latest | [0.11.19](https://github.com/trustgraph-ai/trustgraph/releases/download/v0.11.19/deploy.zip) |
| Stable | [0.11.19](https://github.com/trustgraph-ai/trustgraph/releases/download/v0.11.19/deploy.zip) |
TrustGraph is fully containerized and is launched with a `YAML` configuration file. Unzipping the `deploy.zip` will add the `deploy` directory with the following subdirectories:
- `docker-compose`
- `minikube-k8s`
- `gcp-k8s`
Each directory contains the pre-built `YAML` configuration files needed to launch TrustGraph:
| Model Deployment | Graph Store | Launch File | | Model Deployment | Graph Store | Launch File |
| ---------------- | ------------ | ----------- | | ---------------- | ------------ | ----------- |
| AWS Bedrock | Cassandra | `tg-launch-bedrock-cassandra.yaml` | | AWS Bedrock API | Cassandra | `tg-bedrock-cassandra.yaml` |
| AWS Bedrock | Neo4j | `tg-launch-bedrock-neo4j.yaml` | | AWS Bedrock API | Neo4j | `tg-bedrock-neo4j.yaml` |
| AzureAI Serverless Endpoint | Cassandra | `tg-launch-azure-cassandra.yaml` | | AzureAI Serverless API | Cassandra | `tg-azure-cassandra.yaml` |
| AzureAI Serverless Endpoint | Neo4j | `tg-launch-azure-neo4j.yaml` | | AzureAI Serverless API | Neo4j | `tg-azure-neo4j.yaml` |
| Anthropic API | Cassandra | `tg-launch-claude-cassandra.yaml` | | Anthropic API | Cassandra | `tg-claude-cassandra.yaml` |
| Anthropic API | Neo4j | `tg-launch-claude-neo4j.yaml` | | Anthropic API | Neo4j | `tg-claude-neo4j.yaml` |
| Cohere API | Cassandra | `tg-launch-cohere-cassandra.yaml` | | Cohere API | Cassandra | `tg-cohere-cassandra.yaml` |
| Cohere API | Neo4j | `tg-launch-cohere-neo4j.yaml` | | Cohere API | Neo4j | `tg-cohere-neo4j.yaml` |
| Llamafile | Cassandra | `tg-launch-llamafile-cassandra.yaml` | | Llamafile API | Cassandra | `tg-llamafile-cassandra.yaml` |
| Llamafile | Neo4j | `tg-launch-llamafile-neo4j.yaml` | | Llamafile API | Neo4j | `tg-llamafile-neo4j.yaml` |
| Mixed Depoloyment | Cassandra | `tg-launch-mix-cassandra.yaml` | | Ollama API | Cassandra | `tg-ollama-cassandra.yaml` |
| Mixed Depoloyment | Neo4j | `tg-launch-mix-neo4j.yaml` | | Ollama API | Neo4j | `tg-ollama-neo4j.yaml` |
| Ollama | Cassandra | `tg-launch-ollama-cassandra.yaml` | | OpenAI API | Cassandra | `tg-openai-cassandra.yaml` |
| Ollama | Neo4j | `tg-launch-ollama-neo4j.yaml` | | OpenAI API | Neo4j | `tg-openai-neo4j.yaml` |
| OpenAI | Cassandra | `tg-launch-openai-cassandra.yaml` | | VertexAI API | Cassandra | `tg-vertexai-cassandra.yaml` |
| OpenAI | Neo4j | `tg-launch-openai-neo4j.yaml` | | VertexAI API | Neo4j | `tg-vertexai-neo4j.yaml` |
| VertexAI | Cassandra | `tg-launch-vertexai-cassandra.yaml` |
| VertexAI | Neo4j | `tg-launch-vertexai-neo4j.yaml` |
Launching TrustGraph is as simple as running one line: Launching TrustGraph is as simple as running one line:
**Docker**:
``` ```
docker compose -f <launch-file> up -d docker compose -f <launch-file.yaml> up -d
```
**Kubernetes**:
```
kubectl apply -f <launch-file.yaml>
``` ```
## Core TrustGraph Features ## Core TrustGraph Features
@ -80,7 +84,7 @@ docker compose -f <launch-file> up -d
- GraphRAG query service - GraphRAG query service
- [Grafana](https://github.com/grafana/) telemetry dashboard - [Grafana](https://github.com/grafana/) telemetry dashboard
- Module integration with [Apache Pulsar](https://github.com/apache/pulsar/) - Module integration with [Apache Pulsar](https://github.com/apache/pulsar/)
- Container orchestration with `Docker` or [Podman](http://podman.io/) - Container orchestration with `Docker`, `Podman`, or `Minikube`
## Architecture ## Architecture
@ -105,12 +109,12 @@ The agent prompts are built through templates, enabling customized extraction ag
PDF file: PDF file:
``` ```
scripts/load-pdf -f sample-text-corpus.pdf tg-load-pdf sample-text-corpus.pdf
``` ```
Text file: Text file:
``` ```
scripts/load-text -f sample-text-corpus.txt tg-load-text sample-text-corpus.txt
``` ```
## GraphRAG Queries ## GraphRAG Queries
@ -118,7 +122,7 @@ scripts/load-text -f sample-text-corpus.txt
Once the knowledge graph has been built or a knowledge core has been loaded, GraphRAG queries are launched with a single line: Once the knowledge graph has been built or a knowledge core has been loaded, GraphRAG queries are launched with a single line:
``` ```
scripts/query-graph-rag -q "Write a blog post about the 5 key takeaways from SB1047 and how they will impact AI development." tg-query-graph-rag -q "Write a blog post about the 5 key takeaways from SB1047 and how they will impact AI development."
``` ```
## Deploy and Manage TrustGraph ## Deploy and Manage TrustGraph

Binary file not shown.

Before

Width:  |  Height:  |  Size: 159 KiB

After

Width:  |  Height:  |  Size: 158 KiB

Before After
Before After