From fecb211130ec487c7c617d28419c6d0097f19783 Mon Sep 17 00:00:00 2001 From: Oxbian Date: Sat, 17 May 2025 23:30:07 -0400 Subject: feat: wikipedia module --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 96795fd..31f2181 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,11 @@ Néo AI, a personnal assistant using LLM. A TUI interface for local llama.cpp LLM, in the future more functionnality will be added to this AI. +> [!CAUTION] +> This project is designed to help me understand modern techniques around AI and +> LLM. Other projects like [txtchat](https://github.com/neuml/txtchat) and +> [LangRoid](https://langroid.github.io/langroid/) are more advanced and better for real use. + ## Usage ### Dependencies @@ -36,13 +41,12 @@ and there you go ! - Conversation are saved inside files in JSON in this folder `conv/`, and can be reused on others LLM. - In normal mode, conversation can be resumed by the LLM into bullet point list. - LLM can be configured thanks to configuration files in `config/` -- Requests are routed thanks to the LLM to other expert LLM. Code questions are send to a code expert, wikipedia questions are send to a system which provide better factual response. +- Requests are routed thanks to the LLM to other expert LLM. Code questions are send to a code expert, wikipedia questions are send to a module which use a kiwix API to provide data from Wikipedia. ## TODO -- Color change if it's an user or the LLM -- Async request to the LLM API -- Start the real fun +- Color change if it's an user or the LLM (dunno how to do it in this code base) +- Connect & try LLM / tools ## Inspiration and reason @@ -50,5 +54,4 @@ Why in Rust ? Because I wanted to learn Rust, and the language is fast and powerful. - - [WilmerAI](https://github.com/SomeOddCodeGuy/WilmerAI/) a system where all the inferences are routed to others expert LLM. -- cgit v1.2.3