README WIP

This commit is contained in:
Jack Colquitt 2025-04-07 14:02:23 -07:00 committed by GitHub
parent 48d7be331b
commit b110e44aea
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -22,11 +22,8 @@ It provides a robust, scalable, and reliable infrastructure designed for complex
- ✨ [Key Features](#-key-features) - ✨ [Key Features](#-key-features)
- 🎯 [Why TrustGraph?](#-why-trustgraph) - 🎯 [Why TrustGraph?](#-why-trustgraph)
- 🚀 [Getting Started](#-getting-started) - 🚀 [Getting Started](#-getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Quick Start](#quick-start)
- 🔧 [Configuration Builder](#-configuration-builder) - 🔧 [Configuration Builder](#-configuration-builder)
- [Core Concepts](#-core-concepts) - 📐 [Architecture](#-architecture)
- 🧩 [Integrations](#-integrations) - 🧩 [Integrations](#-integrations)
- 📊 [Observability & Telemetry](#-observability--telemetry) - 📊 [Observability & Telemetry](#-observability--telemetry)
- 🤝 [Contributing](#-contributing) - 🤝 [Contributing](#-contributing)
@ -35,12 +32,6 @@ It provides a robust, scalable, and reliable infrastructure designed for complex
--- ---
## What is TrustGraph?
**TrustGraph removes the biggest headache of building an AI app: connecting and managing all the data, deployments, and models.** As a full-stack platform, TrustGraph simplifies the development and deployment of data-driven AI applications. TrustGraph is a complete solution, handling everything from data ingestion to deployment, so you can focus on building innovative AI experiences.
![architecture](TG-layer-diagram.svg)
## ✨ Key Features ## ✨ Key Features
- 📄 **Data Ingest**: Bulk ingest documents such as `.pdf`,`.txt`, and `.md` - 📄 **Data Ingest**: Bulk ingest documents such as `.pdf`,`.txt`, and `.md`
@ -189,6 +180,12 @@ kubectl apply -f <launch-file.yaml>
TrustGraph is designed to be modular to support as many LLMs and environments as possible. A natural fit for a modular architecture is to decompose functions into a set of modules connected through a pub/sub backbone. [Apache Pulsar](https://github.com/apache/pulsar/) serves as this pub/sub backbone. Pulsar acts as the data broker managing data processing queues connected to procesing modules. TrustGraph is designed to be modular to support as many LLMs and environments as possible. A natural fit for a modular architecture is to decompose functions into a set of modules connected through a pub/sub backbone. [Apache Pulsar](https://github.com/apache/pulsar/) serves as this pub/sub backbone. Pulsar acts as the data broker managing data processing queues connected to procesing modules.
## 📐 Architecture
**TrustGraph removes the biggest headache of building an AI app: connecting and managing all the data, deployments, and models.** As a full-stack platform, TrustGraph simplifies the development and deployment of data-driven AI applications. TrustGraph is a complete solution, handling everything from data ingestion to deployment, so you can focus on building innovative AI experiences.
![architecture](TG-layer-diagram.svg)
### Pulsar Workflows ### Pulsar Workflows
- For processing flows, Pulsar accepts the output of a processing module and queues it for input to the next subscribed module. - For processing flows, Pulsar accepts the output of a processing module and queues it for input to the next subscribed module.