Merge branch 'main' of https://github.com/weaviate/elysia

Author: dannyjameswilliams

README.md

@@ -1,4 +1,9 @@
-# Elysia: Agentic Framework Powered by Decision Trees
+
+
+<p align="center">
+  <img src="./img/banner.gif" alt="Elysia: Decision Tree Agentic Framework">
+</p>
+
 
 > **⚠️ Elysia is in beta!**
 >
@@ -10,11 +15,38 @@ Elysia is an agentic platform designed to use tools in a decision tree. A decisi
 
 [Read the docs!](https://weaviate.github.io/elysia/)
 
+> 💡 Don't forget to check out [the Github Repository for the Frontend](https://github.com/weaviate/elysia-frontend)!
+
 Installation is as simple as:
 ```bash
 pip install elysia-ai
 ```
 
+<p align="center">
+  <img src="./img/elysia.gif" alt="Demo of Elysia" width="85%">
+</p>
+
+### Watch our newest Elysia video here:
+
+<p align="center">
+  <a href="https://youtu.be/PhCrlpUwEhU?si=rnJVBziKTEdPJiKz">
+    <img src="./img/thumbnail.png" alt="https://youtu.be/PhCrlpUwEhU?si=rnJVBziKTEdPJiKz" width="70%">
+  </a>
+</p>
+
+## Table of Contents
+
+- [Get started (App)](#get-started-app)
+- [Get Started (Python)](#get-started-python)
+- [Installation](#installation-bash-linuxmacos)
+  - [PyPi (Recommended)](#pypi-recommended)
+  - [GitHub](#github)
+  - [Configuring Settings](#configuring-settings)
+- [Architecture](#architecture)
+- [Open Source Spirit](#open-source-spirit-)
+- [FAQ](#faq)
+
+
 ## Get started (App)
 
 Run the app via
@@ -24,8 +56,6 @@ elysia start
 ```
 Then navigate to the settings page, add your required API keys, Weaviate cloud cluster details and specify your models.
 
-Don't forget to check out [the Github Repository for the Frontend](https://github.com/weaviate/elysia-frontend)!
-
 Alternatively, we have created a demo version of Elysia (rate-limited, fixed datasets) to experiment with. Find it at: https://elysia.weaviate.io/
 
 ## Get Started (Python)
@@ -98,10 +128,13 @@ pip install -e .
 ```
 Done! You can now use the Elysia python package
 
-
 ### Configuring Settings
 
-To use Elysia with Weaviate, i.e. for agentic searching and retrieval, you need to either have a *locally running* instance of Weaviate, or access to a *Weaviate cloud cluster* via an api key and URL. This can be specific in the app directly, or by creating a `.env` file with
+<p align="center">
+  <img src="./img/config.png" alt="Settings page"/>
+</p>
+
+To use Elysia with Weaviate, i.e. for agentic searching and retrieval, you need to either have a *locally running* instance of Weaviate, or access to a *Weaviate cloud cluster* via an api key and URL. This can be specific in the app directly (see above image), or by creating a `.env` file with
 ```
 WCD_URL=...
 WCD_API_KEY=...
@@ -122,6 +155,26 @@ Elysia's recommended config is to use [OpenRouter](https://openrouter.ai/) to gi
 OPENROUTER_API_KEY=...
 ```
 
+## Architecture
+
+Elysia is architectured as a modern web application with a full-featured frontend for a responsive, real-time interface and a FastAPI backend serving both the web interface and API. The core logic is written in pure Python – what we call "blood, sweat, and tears" custom logic – with DSPy handling LLM interactions. 
+
+Unlike simple agentic platforms which have access to all possible tools at runtime, Elysia has a pre-defined web of possible nodes, each with a corresponding action. Each node in the tree is orchestrated by a decision agent with global context awareness about its environment and its available options. The decision agent evaluates its environment, available actions, past actions and future actions to strategize the best tool to use.
+
+Read more about how we built Elysia in [this blog](https://weaviate.io/blog/elysia-agentic-rag).
+
+<p align="center">
+  <img src="./img/architecture.png" alt="Architecture Diagram"/>
+</p>
+
+
+## Open Source Spirit ✨
+
+**Weaviate** is proud to offer this open source project for the community. While we strive to address issues as fast as we can, please understand that it may not be maintained with the same rigor as production software. We welcome and encourage community contributions to help keep it running smoothly. Your support in fixing open issues quickly is greatly appreciated.
+
+
+See the full [contributor guidelines](CONTRIBUTING.md) to see how you can get started contributing to Elysia!
+
 ## FAQ
 
 <details>