# Changelog

All **notable** changes to ARTwarp-py will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.1/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

*Note: These messages are auto-generated by an LLM because I can't be bothered to edit
the CHANGELOG every time*

## [1.0.1_3] - 2026-03

### Added

- CHANGELOG entries for 1.0.1 and version set to 1.0.1 in setup.
- Humanised inline comments and `@author` in module docstrings.
- Visualization guide (plotting documentation).
- README banner and documentation links.

### Changed

- Linter and formatting polish (Black, isort, Flake8, Mypy).
- README layout and formatting.

## [1.0.1_2] - 2026-02-11

### Added

- GitHub Actions CI: pytest matrix (Python 3.9–3.12), coverage gate (80%), Black, Flake8.
- Documentation: docs -> README, INSTALLATION, QUICK_REFERENCE; architecture overview and API reference; docs for environment setup and performance; project summary and test results; simple and visualization examples.

## [1.0.1_1] - 2026-02

### Added

- Unit tests for DTW, ART, network, and validation.
- Loader tests, MATLAB compatibility tests, and visualization tests.

## [1.0.1_0] - 2026-01

### Added

- Initial package layout, pyproject and dependencies for ARTwarp port.
- DTW: similarity matrix and warp with Itakura constraints (Python fallback).
- ART: activate/match/sort/resonance, weight init/update/get_contour.
- ARTwarp network class and fit loop with convergence and sample shuffle.
- Contour/parameter validation and `resample_contours` for temporal-resolution alignment.
- IO: `load_contours`, load .ctr/.csv/.txt, directory auto-detect.
- IO: export results to pkl, reference contours and category assignments to CSV.
- CLI: argparse for train, predict, export, plot with resample options.
- Plotting: training summary, reference contours, convergence and match plots, results report.

---

## Original MATLAB implementation

This is a complete rewrite of ARTwarp, originally developed in MATLAB.
For the original MATLAB implementation history, see:
https://github.com/dolphin-acoustics-vip/artwarp

---

@author: Pedro Gronda Garrigues  
@PedroGGBM (GitHub)
