From ae0655efd4bf30e71e2f463b5b3bfc819e58a588 Mon Sep 17 00:00:00 2001 From: Leon van Bokhorst Date: Sat, 14 Dec 2024 10:29:38 +0100 Subject: [PATCH] docs: Update README.md to enhance project clarity and structure - Expanded project overview to include Kafka integration for real-time processing. - Improved project structure section with detailed descriptions of each implementation file. - Updated technical stack to include new dependencies for Kafka and environment management. - Added environment configuration instructions for local development with Kafka. - Enhanced clarity and usability of the documentation to better guide users in setting up and understanding the project. --- README.md | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0d02061..ed94b43 100644 --- a/README.md +++ b/README.md @@ -4,26 +4,31 @@ ## Overview -This project implements predictive coding models in Python, focusing on virtual human experiences. +This project implements predictive coding models in Python, focusing on virtual human experiences. It includes both standalone implementations and a Kafka-integrated version for real-time processing. ## Project Structure ``` . ├── predictive_coding/ -│ ├── 01_predcod.py -│ ├── 02_predcod_nova.py +│ ├── 01_predcod.py # Basic predictive coding implementation +│ ├── 02_predcod_nova.py # Enhanced Nova implementation +│ ├── 03_kafka_nova_poc.py # Kafka-integrated version │ └── utils/ ├── docs/ -└── requirements.txt +├── requirements.txt +├── pyproject.toml +└── setup.py ``` ## Technical Stack - Python-based implementation - Core dependencies: - - NumPy - - Matplotlib + - NumPy: Numerical computing + - Matplotlib: Data visualization + - confluent-kafka: Kafka client for real-time processing + - python-dotenv: Environment variable management ## Development Setup @@ -38,6 +43,10 @@ This project implements predictive coding models in Python, focusing on virtual pip install -r requirements.txt ``` +3. Environment Configuration: + - For Kafka integration, set up appropriate environment variables + - Use `.env` file for local development + ## Contributing 1. Fork the repository