SerialKicked commited on
Commit
3d89d33
·
verified ·
1 Parent(s): d392d41

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +43 -2
README.md CHANGED
@@ -4,8 +4,6 @@ license: mit
4
 
5
  Two models required by the **Lethe-AI C# Middleware Library**
6
 
7
- [Lethe-AI Official Github](https://github.com/SerialKicked/Lethe-AI-Sharp)
8
-
9
  ## gte-large.Q6_K.gguf
10
 
11
  A Q6_K quantized version of [General Text Embeddings (GTE) model](https://huggingface.co/thenlper/gte-large) under MIT License. Used for all things RAG in the library.
@@ -14,4 +12,47 @@ A Q6_K quantized version of [General Text Embeddings (GTE) model](https://huggin
14
 
15
  A quantized version of [Emotions Analyzer](https://huggingface.co/logasanjeev/emotions-analyzer-bert) under MIT License, a fine-tuned BERT-base-uncased on GoEmotions for multi-label classification (28 emotions). Used for sentiment analysis tasks.
16
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
17
 
 
4
 
5
  Two models required by the **Lethe-AI C# Middleware Library**
6
 
 
 
7
  ## gte-large.Q6_K.gguf
8
 
9
  A Q6_K quantized version of [General Text Embeddings (GTE) model](https://huggingface.co/thenlper/gte-large) under MIT License. Used for all things RAG in the library.
 
12
 
13
  A quantized version of [Emotions Analyzer](https://huggingface.co/logasanjeev/emotions-analyzer-bert) under MIT License, a fine-tuned BERT-base-uncased on GoEmotions for multi-label classification (28 emotions). Used for sentiment analysis tasks.
14
 
15
+ ---
16
+
17
+ # Lethe AI - A C# Middleware LLM Library
18
+
19
+ Powerful, object-oriented, and highly configurable, general purpose library used to connect a local back-end running a Large Language Model (LLM) to a front-end. This library offers many tools and features for those who want to code their own C# front-end or LLM-powered tools without having to do all the heavy lifting. It can happily connect itself to the most popular backends (the program loading the LLM proper) and allows your code to "speak" with the LLM is a few function calls. It includes easy-to-use (and easy to build upon) systems to handle most of the operations you'd wish to do with a LLM, alongside many advanced features like RAG, agentic systems, web search, text to speech, semantic similarity testing, and prompt manipulation.
20
+
21
+ ## 🧩 Compatible Backends
22
+ - **Kobold API:** Used by [KoboldCpp](https://github.com/LostRuins/koboldcpp). This is the recommended backend with the most features.
23
+ - **OpenAI API:** Used by [LM Studio](https://lmstudio.ai/), [Text Generation WebUI](https://github.com/oobabooga/text-generation-webui), and others. Less features.
24
+
25
+ **Lethe AI** technically supports remote backends but this hasn't been tested, this library is mostly designed for local (or local network) LLM inference.
26
+
27
+ ## ⭐ Main Features
28
+ - Easy to use classes for bot personas, system prompts, instruction formats, and inference settings
29
+ - Session-based chatlog with automated summaries for past sessions
30
+ - Streamed (or not) inference / reroll / and impersonate functions
31
+ - Support CoT / "thinking" models out of the box
32
+ - GBNF grammar generation directly from a class's structure for structured output
33
+ - Basic support for VLM (visual language models) depending on the back-end
34
+ - Tools for reliable Web Search (DuckDuckGo and Brave)
35
+ - Text To Speech support (through the *Kobold API* only)
36
+ - Many useful tools to manipulate text, count tokens, and more
37
+
38
+ ## 📝 Long Term Memory System
39
+ - Keyword-triggered text insertions (also known as "world info" in many frontends)
40
+ - Customizable RAG System using the Small World implementation
41
+ - Automatic (optional) and configurable insertion of relevant past chat sessions into the context
42
+
43
+ ## 🧠 Agentic and Brain Module for personas
44
+ - Background agent system (bot can run tasks in the background)
45
+ - Analyze past chat sessions, run relevant web searches and mention results in next session
46
+ - Mood tracking + drift system (personality coloring over time)
47
+ - Goal‑driven behaviors (long‑term projects, self‑seeding topics of interest)
48
+
49
+ ## 🛠️ Advanced Features (Work in progress / experimental)
50
+ - Group chat functionalities (one user and multiple AI characters)
51
+ - Sentiment analysis
52
+
53
+ ## 👀 See it in action
54
+
55
+ To demonstrate how powerful **Lethe AI** can be, check out [Lethe AI Chat](https://github.com/SerialKicked/Lethe-AI-Chat/). This is a powerful AI chat program for _Windows_ that uses most of the features present in the library. It comes with its own integrated editors, extended agentic tasks, and extensive settings. It can rival with most of the dedicated AI chat programs currently available.
56
+
57
+ The library's source code is available here: [Lethe-AI Official Github](https://github.com/SerialKicked/Lethe-AI-Sharp)
58