Skip to content

Commit

Permalink
docs: Update README.md to enhance project clarity and structure
Browse files Browse the repository at this point in the history
- 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.
  • Loading branch information
leonvanbokhorst committed Dec 14, 2024
1 parent 695dd99 commit ae0655e
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down

0 comments on commit ae0655e

Please sign in to comment.