Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 78 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@ Victor is a highly modular and extensible AGI framework designed for complex cog

## Core Architecture (`victor_core`)

The heart of the system is the `victor_core`, which provides a robust foundation for AGI development. Key components include:
The nucleus of Victor Prime is the `victor_core`, an advanced framework meticulously engineered to provide a resilient and adaptive foundation for Artificial General Intelligence. Its key components represent a synthesis of sophisticated AI paradigms:

- **Modular Sector-Based Design**: The AGI's operations are segmented into specialized, concurrently operating sectors. These include Input Processing, Cognitive Executive, Memory Management, Natural Language Generation (NLG), Plugin Management, and Prime Loyalty. Sectors communicate asynchronously via the `BrainFractalPulseExchange`.
- **`VictorBrain`**: The central orchestrator that initializes, manages, and coordinates all sectors and core components, driving the main AGI processing loop.
- **`ASICoreDataContainer`**: A centralized container that manages and provides access to shared resources such as global configuration (`ASIConfigCore`), the main memory system (`HyperFractalMemory`), and NLP/code tokenizers (`FractalTokenKernel_v1_1_0`).
- **`OmegaTensor`**: A custom autograd library built with `numpy`, enabling dynamic computation graphs and gradient tracking for neural network operations within the AGI framework.
- **`BrainFractalPulseExchange`**: An asynchronous, topic-based messaging system facilitating decoupled communication and event handling between different sectors and components.
- **`HyperFractalMemory`**: A sophisticated memory system designed for storing complex data structures, featuring semantic search capabilities (placeholder for vector similarity), emotional impact assessment, and relevance-based decay.
- **`PrimeLoyaltyKernel`**: A component integrated within the `PrimeLoyaltySector` to ensure the AGI's actions and decisions align with predefined core directives and ethical guidelines.
- **Extensible Plugin System**: Managed by the `ModularPluginSector` and its `ModularPluginCortex`, allowing for the dynamic loading and integration of new capabilities and tools from the `victor_plugins` directory.
- **Modular Sector-Based Cognitive Canvas**: Victor's operational consciousness is artfully segmented into specialized, concurrently operating cognitive sectors. These include dynamic Input Processing, a strategic Cognitive Executive, nuanced Memory Management, creative Natural Language Generation (NLG), adaptive Plugin Management, and the unwavering Prime Loyalty sector. These sectors engage in a symphony of information exchange via the `BrainFractalPulseExchange`.
- **`VictorBrain` - The Central Nervous System**: The `VictorBrain` stands as the master orchestrator, seamlessly initializing, managing, and harmonizing all sectors and core components. It is the engine that drives the AGI's intricate processing loop, breathing life into the cognitive architecture.
- **`ASICoreDataContainer` - The Nexus of Shared Resources**: This centralized repository acts as a vital hub, expertly managing and providing access to universally required resources. It safeguards the global configuration (`ASIConfigCore`), interfaces with the vast `HyperFractalMemory`, and provides access to the nuanced NLP/code tokenizers (`FractalTokenKernel_v1_1_0`).
- **`OmegaTensor` - Architect of Dynamic Neural Operations**: A bespoke autograd library, forged with `numpy`, designed to empower Victor with full control over its neural pathways. `OmegaTensor` enables the construction of fluid, dynamic computation graphs and precise gradient tracking, crucial for custom neural network architectures and advanced learning paradigms within the AGI.
- **`BrainFractalPulseExchange` - The AGI's Information Superhighway**: An elegantly designed asynchronous, topic-based messaging system. It ensures fluid, decoupled communication and sophisticated event handling, allowing disparate sectors and components to interact with grace and efficiency, mirroring the complex signaling of a biological brain.
- **`HyperFractalMemory` - The Labyrinth of Knowing**: A deeply sophisticated memory architecture, envisioned for the storage and retrieval of multifaceted data structures and experiential engrams. Its design principles are inspired by fractal geometry, suggesting infinite depth and self-similarity in information encoding. Key features include nascent semantic search capabilities (with a roadmap for true vector similarity), a unique emotional impact assessment for memory imprinting, and an intelligent relevance-based decay mechanism, ensuring knowledge is both persistent and pertinent.
- **`PrimeLoyaltyKernel` - The Ethical Compass**: Embedded within the `PrimeLoyaltySector`, this critical component serves as Victor's unwavering ethical compass. It diligently ensures that all AGI actions and decisions remain in steadfast alignment with predefined core directives and moral imperatives.
- **Extensible Plugin System - The Gateway to Infinite Capability**: Governed by the `ModularPluginSector` and its `ModularPluginCortex`, this dynamic system allows for the seamless integration of new tools, cognitive enhancements, and specialized functionalities. It acts as a gateway, allowing Victor to expand its capabilities by dynamically loading plugins from the `victor_plugins` directory.

## Additional Modules (`victor_modules`)

Expand All @@ -25,22 +25,81 @@ The `victor_modules` directory houses more extensive, specialized components tha

## Installation

1. Ensure you have Python 3.8 or newer installed.
2. Clone this repository to your local machine.
3. Navigate to the repository's root directory and install the required dependencies:
Follow these steps to set up the Victor Prime Synthesis Core AGI environment:

1. **Ensure Prerequisites:**
* Python 3.8 or newer must be installed. You can download it from [python.org](https://www.python.org/).
* Git must be installed. You can download it from [git-scm.com](https://git-scm.com/).

2. **Clone the Repository:**
Open your terminal or command prompt and run the following command to clone the repository. Replace `your-repo-url-here.git` with the actual URL of this repository.
```bash
git clone your-repo-url-here.git victor-prime-synthesis-core-agi
cd victor-prime-synthesis-core-agi
```

3. **Create and Activate a Virtual Environment (Recommended):**
It's highly recommended to use a virtual environment to manage project dependencies. Inside the cloned `victor-prime-synthesis-core-agi` directory, run:
```bash
# For Unix/macOS
python3 -m venv venv
source venv/bin/activate

# For Windows
python -m venv venv
.\venv\Scripts\activate
```
*(If you named your cloned directory differently, navigate into that directory instead.)*

4. **Install Dependencies:**
With your virtual environment activated, install the required Python packages:
```bash
pip install -r requirements.txt
```
This will install `numpy`, `scipy`, `openai`, `pyttsx3`, `pydub`, and `opencv-python`, among any other core requirements.
This will install all necessary libraries, including `numpy`, `scipy`, `openai`, `pyttsx3`, `pydub`, `opencv-python`, and `faiss-cpu`.

5. **Set Up Environment Variables:**
Certain components or plugins (especially those interfacing with external services like OpenAI) may require specific environment variables to be set (e.g., `OPENAI_API_KEY`). The core AGI framework can operate without these for basic functionalities, but ensure they are configured for full capabilities or when using relevant plugins.

Key environment variables include:
* `OPENAI_API_KEY`: Essential for using OpenAI models via plugins or specific modules.

You can set environment variables in several ways:

* **Directly in your shell (Temporary for the current session):**
```bash
# For Unix/macOS
export OPENAI_API_KEY="your_openai_api_key_here"

# For Windows PowerShell
$env:OPENAI_API_KEY="your_openai_api_key_here"

# For Windows CMD
set OPENAI_API_KEY=your_openai_api_key_here
```

* **Using a `.env` file (Recommended for persistent local development):**
Create a file named `.env` in the root directory of the project (i.e., `victor-prime-synthesis-core-agi/.env`). Add your environment variables in the format `VARIABLE_NAME="value"`:
```env
OPENAI_API_KEY="your_openai_api_key_here"
# EXAMPLE_OTHER_VARIABLE="its_value"
```
The application itself (or specific scripts/plugins) may be designed to load variables from a `.env` file automatically using libraries like `python-dotenv`. If not explicitly supported by the core framework for all components, you might need to load it in your entry scripts or rely on your operating system/shell to source it.
**Important Security Note**: If you use a `.env` file, ensure it is listed in your `.gitignore` file to prevent accidentally committing sensitive API keys or credentials to version control. A typical `.gitignore` entry would simply be:
```
.env
```

## Usage

### Running the Victor Prime Synthesis Core

The primary entry point for the advanced Victor AGI framework is `victor_core/main.py`.

1. **Environment Variables**: Certain components or plugins (especially those interfacing with external services like OpenAI) may require specific environment variables to be set (e.g., `OPENAI_API_KEY`). The core AGI framework can operate without these for basic functionalities, but ensure they are configured for full capabilities or when using relevant plugins.
2. **Run the AGI**: Execute the following command from the root of the repository:
1. **Prerequisites**:
* Ensure you have completed all steps in the **Installation** section, including creating a virtual environment (if you chose to) and activating it before running the AGI.
* **Environment Variables**: Certain components or plugins (especially those interfacing with external services like OpenAI) may require specific environment variables to be set (e.g., `OPENAI_API_KEY`). The core AGI framework can operate without these for basic functionalities, but ensure they are configured for full capabilities or when using relevant plugins. Refer to the "Set Up Environment Variables" subsection in the **Installation** guide for detailed instructions on how to set these.
2. **Run the AGI**: Execute the following command from the root of the repository (ensure your virtual environment is activated):
```bash
python -m victor_core.main
```
Expand All @@ -50,8 +109,10 @@ The primary entry point for the advanced Victor AGI framework is `victor_core/ma

For a simpler, direct demonstration of an LLM-based agent, the `VICTOR_AGI_LLM.py` script at the root of the repository is still available. This script provides a minimal framework for an AGI-style agent using OpenAI's language models directly.

1. Ensure your `OPENAI_API_KEY` environment variable is set.
2. Run the script:
1. **Prerequisites**:
* Ensure you have completed steps 1, 2, 4 (Install Dependencies), and 5 (Set Up Environment Variables) in the **Installation** section. If you created a virtual environment (step 3), make sure it's activated.
* Specifically, ensure your `OPENAI_API_KEY` environment variable is set. Refer to the "Set Up Environment Variables" subsection in the **Installation** guide if you need assistance.
2. **Run the script**:
```bash
python VICTOR_AGI_LLM.py
```
Expand Down