Merge branch 'main' of github.com:alex-is-busy-coding/rl-order-execution

Author: alex-is-busy-coding

CHANGELOG.md

@@ -0,0 +1,89 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [Unreleased]
+
+### Features
+
+- *(eval)* Overhaul evaluation with detailed IS metrics and plots
+- *(optimize)* Implement optuna hyperparameter tuning script
+- *(training)* Integrate optuna pruning and reporting into training loop
+- *(settings)* Add optimization schema and prioritize best_params.yaml
+- *(config)* Add hyperparameter optimization settings
+- *(training)* Implement DQN training loop with TensorBoard logging
+- *(evaluation)* Implement agent evaluation and visualization tools
+- *(environment)* Implement OrderExecutionEnv gymnasium environment
+- *(agent)* Implement DQN agent with experience replay
+- *(settings)* Implement typed configuration management with Pydantic
+- *(config)* Add initial configuration for simulation and RL parameters
+- *(main)* Implement training and evaluation entry point
+- *(core)* Add initial main.py entry point
+
+### Bug Fixes
+
+- *(agent)* Return training loss and resolve type errors
+
+### Refactor
+
+- *(settings)* Update config path and enrich logging schema
+
+### Documentation
+
+- *(readme)* Update file tree with changelog tooling
+- *(readme)* Update project structure tree
+- *(readme)* Reorganize structure and expand technical roadmap
+- *(readme)* Add install and hook setup instructions
+- *(README)* Update configuration table in README
+- *(readme)* Add definition table for key execution metrics
+- *(readme)* Add instructions for optuna hyperparameter tuning
+- *(readme)* Format make commands as code blocks in table
+- *(config)* Add custom settings template and organize config files
+- *(readme)* Overhaul documentation with setup, docker, and config guides
+
+### Styling
+
+- *(eval)* Auto-format code with black/linter
+- *(readme)* Align comments in project structure tree
+- *(training)* Auto-format code with ruff
+- *(settings)* Auto-format code with ruff
+
+### Testing
+
+- *(tests)* Add initial simulation test suite
+
+### Miscellaneous Tasks
+
+- *(changelog)* Bump git-cliff-action to v4
+- *(changelog)* Add workflow to auto-generate changelog
+- *(changelog)* Add git-cliff configuration
+- *(config)* Update RL best parameters for gamma and lr
+- *(gitignore)* Update project output ignore rules
+- *(config)* Add best_params.yaml to track optimized hyperparameters
+- *(deps)* Add optuna dependency for hyperparameter tuning
+- *(deps)* Add optuna dependency for hyperparameter tuning
+- *(makefile)* Add optimize target for hyperparameter tuning
+- *(gitignore)* Add database artifacts and mypy cache to ignored files
+- *(workflows)* Add documentation auto-update workflow
+- *(deps)* Add settings-doc to dev dependencies
+- *(workflows)* Add CI pipeline for quality checks
+- *(.gitattributes)* Treat uv.lock as binary
+- *(.gitignore)* Ignore TensorBoard runs directory
+- *(git)* Add .gitignore to exclude artifacts and venv
+
+### Build
+
+- *(pre-commit)* Add configuration for local hooks
+- *(deps)* Add pre-commit to dev dependencies
+- *(makefile)* Add setup-hooks target
+- *(deps)* Add seaborn dependency
+- *(makefile)* Add docker commands and docs automation
+- *(docker)* Add containerization support
+- *(package)* Initialize source package structure
+- *(uv.lock)* Add initial dependency lockfile
+- *(pyproject.toml)* Define dependencies and tool configuration
+- *(Makefile)* Add runs directory to clean target
+- *(Makefile)* Add Makefile for project automation and quality checks
+- *(uv)* Initialize project configuration and dependencies
+
+<!-- generated by git-cliff -->