Welcome to the future of document interaction! IncarnaMind allows you to converse with your personal documents (PDF, TXT) using advanced Large Language Models (LLMs) like GPT. This guide will walk you through the steps of setting up, using, and troubleshooting IncarnaMind, ensuring that you get the most out of this innovative tool.
What is IncarnaMind?
IncarnaMind is a tool that lets you engage in chat-like conversations with your documents. With the evolving landscape of AI, it adapts to your document’s content, allowing for efficient queries using mechanisms such as Sliding Window Chunking and Ensemble Retriever. So, let’s dive into how you can get started!
Getting Started with IncarnaMind
1. Installation
To use IncarnaMind, follow these simple steps to install the necessary components:
1.0. Prerequisites
- Ensure Python version is between 3.8 and 3.11 (with Conda).
- Obtain one or more of the following API keys:
- Your own documents are essential for creating a personal chat experience.
1.1. Clone the Repository
shell
git clone https://github.com/junruxiong/IncarnaMind
cd IncarnaMind
1.2. Setup
shell
conda create -n IncarnaMind python=3.10
conda activate IncarnaMind
pip install -r requirements.txt
# Install llama-cpp separately for quantized local LLMs
# NVIDIA GPUs
CMAKE_ARGS=-DLLAMA_CUBLAS=on FORCE_CMAKE=1 pip install llama-cpp-python==0.1.83 --no-cache-dir
# Apple Metal (M1/M2)
CMAKE_ARGS=-DLLAMA_METAL=on FORCE_CMAKE=1 pip install llama-cpp-python==0.1.83 --no-cache-dir
Setup your API keys in the configparser.ini file:
shell
[tokens]
OPENAI_API_KEY = (replace_me)
ANTHROPIC_API_KEY = (replace_me)
TOGETHER_API_KEY = (replace_me)
# if using full Meta-Llama models
HUGGINGFACE_TOKEN = (replace_me)
2. Usage
Once everything is set up, let’s jump into using IncarnaMind:
2.1. Upload and Process Your Files
Place all your document files in the data directory and run:
shell
python docs2db.py
2.2. Run IncarnaMind
Start the conversation by executing:
shell
python main.py
2.3. Chat and Ask Questions
Whenever prompted, you can start chatting with your documents. The system will be ready for your commands:
shell
Human:
2.4. Logging and Configuration
The system automatically generates a IncarnaMind.log file for tracking. You can modify logging settings in the configparser.ini file.
shell
[logging]
enabled = True
level = INFO
filename = IncarnaMind.log
format = %(asctime)s [%(levelname)s] %(name)s: %(message)s
Analogies to Understand Complex Concepts
Imagine trying to find a specific book (or piece of information) among a heap of books in a library. Traditional systems sort books by fixed categories leading to confusion, just like fixed chunking in traditional RAG tools limits adaptability. IncarnaMind acts like a skilled librarian who quickly assesses and retrieves the right book for your needs, using context to guide its search.
Troubleshooting Tips
- If you encounter issues during installation, ensure that all dependencies are met.
- For RAM limitations, consider using the Together.ai API.
- If you’re not receiving accurate responses, check the document formatting and data quality.
- Look into current limitations like citation support which is being rolled out soon.
- For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.
Conclusion
IncarnaMind is a powerful tool that is simple to set up and incredibly versatile in its use. The innovative technologies behind it enhance your experience of interacting with documents, making information retrieval more intuitive and efficient.
At fxis.ai, we believe that such advancements are crucial for the future of AI, as they enable more comprehensive and effective solutions. Our team is continually exploring new methodologies to push the envelope in artificial intelligence, ensuring that our clients benefit from the latest technological innovations.
