Skip to content

Commit

Permalink
Merge pull request #10 from leonvanbokhorst/nova_kafka_poc
Browse files Browse the repository at this point in the history
docs: Update README.md to enhance project clarity and structure
  • Loading branch information
leonvanbokhorst authored Dec 14, 2024
2 parents 3ac6c3b + ae0655e commit c7083d0
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 c7083d0

Please sign in to comment.