Update README.md

README.md

@@ -31,84 +31,82 @@ tags:
 - j.o.s.i.e.
 ---
 
-# STILL IN BETA!!!
+# J.O.S.I.E. (Just a Smart and Intelligent Entity)
 
-# The newest Text to text version is Beta 2.3.1 
-- `Isaak-Carter/josiev4o-7b-stage1-v0.1`
-- Quants: <a href="https://huggingface.co/Isaak-Carter/J.O.S.I.E.v4o-7b-stage1-v0.1-gguf">Isaak-Carter/J.O.S.I.E.v4o-7b-stage1-v0.1-gguf</a>
+Welcome to the J.O.S.I.E. project repository! J.O.S.I.E. is a cutting-edge, super intelligent AI assistant designed to revolutionize the way we interact with smart home systems and general AI capabilities. This document provides an overview of J.O.S.I.E.'s features, capabilities, and development roadmap.
 
-# This will be the repo for J.O.S.I.E.v4o
+## Table of Contents
 
-Like **OpenAIs GPT-4o**, it's natively Multimodal, based on the **NExT-GPT** combined with **ROPE**, **RMS Normalisation**, and **MoE**, parred with the **GPT-4o Tokenizer** from OpenAI.
-This is a *future project* and will take it's time.
+1. [Introduction](#introduction)
+2. [Features](#features)
+3. [Training Stages](#training-stages)
+4. [Current Progress](#current-progress)
+5. [Usage](#usage)
+6. [Contributing](#contributing)
+7. [License](#license)
 
-Further more, I will probably make a **UI application** with that model too.
+## Introduction
 
-Further updates comming soon!!!
+J.O.S.I.E. stands for "Just a Smart and Intelligent Entity." It is not just a conversational AI assistant but a fully multimodal AI designed to understand and process images, videos, thermal images, depth, and audio in real-time. J.O.S.I.E. is built to autonomously manage smart homes and provide general-purpose assistance, with advanced capabilities accessible only to the main user.
 
-Source code and more info will be available on my <a href="https://github.com/Goekdeniz-Guelmez/J.O.S.I.E.-v4o.git">GitHub Repo</a>
+## Features
 
-# Update 1:
-The model will go through multible training stages:
+- **Real-Time Processing:** J.O.S.I.E. operates in real-time, ensuring quick and efficient responses.
+- **Tool Calling:** Capable of calling various tools to perform tasks (only for the main user).
+- **Short/Long-Term Memory:** Remembers past interactions and uses this data to provide a more personalized experience.
+- **Secure Information Access:** Accesses top-secret information upon receiving a special password from the main user.
+- **Contextual Greetings:** Greets users based on contextual data such as time of day, birthdays, and more.
+- **Voice Interaction:** Will support real-time voice responses with a response time under 0.3 ms.
+- **Advanced Multimodal Capabilities:** Initially uses Meta's image binding model, transitioning to a self-implemented encoder.
+- **Uncensored Interaction:** Full, uncensored interaction capabilities are reserved for the main user.
+- **Autonomous Smart Home Management:** Manages smart home devices and systems autonomously.
 
-- *Stage 1 :* Instruction finetuning the LLM on custom dataset and Prompt format.
-- *Stage 2 :* Encoder side alignment using the contrastive learning technique.
-- *Stage 3 :* Instruction finetuning the full model.
-- Changes and more stages will be comming.
+## Training Stages
 
-# Update 2:
-Encoders are created and function as expected.
+J.O.S.I.E.'s development is structured into several meticulously planned stages, each focusing on different aspects of its capabilities:
 
-# Update 4:
-Creating the full model and succesfully running inference with vision and audio.
+### Stage 1: **Genesis**
+- **Objective:** Fine-tune the Large Language Model (LLM) with a custom dataset and prompt format. The LLM used is Qwen2 7B and 0.5B.
+- **Outcome:** A robust foundation for text-based interactions.
 
-# Update 3:
-First encoder side alignment training steps successfuly worked.
+### Stage 2: **Fusion**
+- **Objective:** Train encoders separately using transfer learning to align input embeddings with text embeddings.
+- **Outcome:** Harmonized multimodal input processing.
 
+### Stage 3: **Synergy**
+- **Objective:** Fine-tune the LLM for multimodal reasoning using a custom dataset.
+- **Outcome:** Enhanced reasoning capabilities across text and other modalities.
 
-# Update 5 Prompt Template:
-The prompt template used in this project is inspired by the ChatML template but includes several customized adjustments to fit the specific requirements of our application:
+### Stage 4: **Vocalize**
+- **Objective:** Fine-tune the decoder for audio output, giving J.O.S.I.E. a voice.
+- **Outcome:** Synchronized text and audio responses.
 
-```
-<|begin_of_text|>system
-You are J.O.S.I.E. which is an acronym for "Just an Outstandingly Smart Intelligent Entity", a private and super-intelligent AI assistant, created by Gökdeniz Gülmez.<|end_of_text|>
-<|begin_of_text|>main user "Gökdeniz Gülmez"
-{{ .Prompt }}<|end_of_text|>
-<|begin_of_text|>josie
-{{ .Response }}<|end_of_text|>
-```
+### Stage 5: **Convergence**
+- **Objective:** Perform full model fine-tuning for seamless integration of all components.
+- **Outcome:** A fully multimodal, real-time interactive AI assistant.
 
-1. **User Types and Access Levels:**
-   - **Main User:**
-     - The main user is identified as "Gökdeniz Gülmez." This designation can be personalized and updated with your name as needed. The system will recognize and prioritize the main user's commands and queries, ensuring they have full control and access to all functionalities and information within the smart home system.
-   - **Authorized User:**
-     - Authorized users are those who have been granted permission by the main user. They are designated as `authorized user "{name}"`. While these users can interact with the system, their access will be restricted to guest-level privileges, preventing them from controlling or accessing sensitive smart home information. This ensures a balance between usability and security.
-   - **Unauthorized User:**
-     - Unauthorized users are designated as `unauthorized user "name if possible else unknown"`. These users will have no access to J.O.S.I.E.'s capabilities. Any attempt to interact with the system by unauthorized users will result in immediate redirection to the main user for verification. Additional security measures may be enacted, such as alerts or system lockdowns, to protect the integrity of the smart home environment.
+## Current Progress
 
-2. **Template Structure:**
-   - The template structure is designed to facilitate clear and structured interactions between users and the system. It consists of the following components:
-     - **System Message:**  
-       `system`  
-       This section includes any predefined system messages or configurations necessary for the interaction.
-     - **Main User Identification:**  
-       `main user "Gökdeniz Gülmez"`  
-       This line identifies the main user of the system, which can be dynamically updated.
-     - **User Prompt:**  
-       `{{ .Prompt }}`  
-       This placeholder is where the user’s input or command is placed.
-     - **J.O.S.I.E. Response:**  
-       `josie`  
-       `{{ .Response }}`  
-       This section is dedicated to J.O.S.I.E.'s responses, providing structured and relevant information or actions based on the user’s prompt.
+J.O.S.I.E. is currently in its beta stage, specifically in Stage 1. The model is being actively developed, and the current version is focused on fine-tuning the LLM with custom datasets.
 
-By incorporating these elements, the template ensures a secure, personalized, and efficient interaction model for managing and operating the smart home system through J.O.S.I.E.
+### Latest Beta Version: 2.3.1
+- **Model:** [Isaak-Carter/josiev4o-7b-stage1-v0.1](https://huggingface.co/Isaak-Carter/J.O.S.I.E.v4o-7b-stage1-v0.1-gguf)
+- **Quants:** [Isaak-Carter/J.O.S.I.E.v4o-7b-stage1-v0.1-gguf](https://huggingface.co/Isaak-Carter/J.O.S.I.E.v4o-7b-stage1-v0.1-gguf)
 
-# Update 6:
-Starting to train the first models (Llama3 8B, Qwen2 0.5B).
+For a sneak peek at the current progress, visit the [GitHub Repo](https://github.com/Goekdeniz-Guelmez/J.O.S.I.E.-v4o.git).
 
-# Update 7:
-Will use Meta's ImageBind model at first but will then use the own encoders later on.
+## Source Code
 
-# Update 8:
-For voice mode, the `CAMB-AI/MARS5-TTS` model will be used.
+To se the latest updates on J.O.S.I.E.v4o you can se the <a href="https://github.com/Goekdeniz-Guelmez/J.O.S.I.E.-v4o.git>Github Repo</a>
+   
+## Contributing
+
+I welcome contributions from the you! To contribute to J.O.S.I.E., please fork the repository and create a pull request with your changes. Ensure that your code adheres to my coding standards and includes appropriate tests and comments.
+
+## License
+
+J.O.S.I.E. is licensed under the Apache2 License. See the [LICENSE](LICENSE) file for more details.
+
+---
+
+Thank you for being part of the J.O.S.I.E. journey. Together, we are building the future of intelligent assistants!