Skip to content

CHANGELOG.md

Latest commit

 

History

History
46 lines (32 loc) · 2.63 KB

CHANGELOG.md

File metadata and controls

46 lines (32 loc) · 2.63 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

While on 0.x, minor releases may include breaking changes. The public API is the set of symbols exported from devol.__all__; anything else is internal.

[Unreleased]

Added

  • README badges: PyPI version, supported Python versions, CI status, license.

[0.1.0] - 2026-05-03

First published release to PyPI.

Added

  • Project metadata for PyPI publication (license, authors, classifiers, URLs).
  • LICENSE file (MIT).
  • py.typed marker so downstream type checkers pick up devol's inline hints.
  • CONTRIBUTING.md with minimum expectations for patches.
  • This changelog.
  • CI matrix covering Python 3.11, 3.12, and 3.13 with separate lint, typecheck, test, and build jobs.
  • examples, benchmark, dev, and all optional dependency groups.
  • src/devol is now strictly typed end-to-end (mypy --strict clean).
  • Installation section in the README explaining the new extras.
  • README hero visual: 4-panel static figure and animated GIF showing diffusion evolution collapsing noise onto the Rastrigin fitness landscape. Reproducible via scripts/generate_readme_figure.py.
  • Automated release pipeline (.github/workflows/release.yml): tag-driven publishing via PyPI Trusted Publishers (OIDC), no stored credentials. Prerelease tags (rc, a, b) publish to TestPyPI; final tags publish to PyPI. Both paths require manual approval via GitHub Environments, build a GitHub Release with artifacts attached, and validate that the tag matches pyproject.toml.
  • CONTRIBUTING.md now documents the release flow.

Changed

  • Moved pytest from required dependencies to the dev extra.
  • Moved torch, torchvision, gymnasium, and matplotlib out of required dependencies. Installing devol now pulls only numpy, pydantic, and pydantic-yaml; the heavy deps live under the examples extra.
  • Dropped unused pydantic-settings from dependencies.
  • Wheel contents narrowed to src/devol only — examples/ and benchmark/ stay in the repo but are no longer shipped.
  • devol.__version__ is now read dynamically from the installed package metadata (importlib.metadata.version), making pyproject.toml the single source of truth for the version string.

Fixed

  • DiffusionEvolution.run() no longer requires initial_population; calling algo.run() now initializes a population automatically, matching the documented Quick Start usage and unblocking the devol CLI entry point.