Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -221,3 +221,6 @@ __marimo__/
data/
mnist_checkpoints/
benchmark_results/

# Local-only working notes (specs, brainstorming docs, etc.)
docs/superpowers/
27 changes: 27 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Changelog

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

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

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

- 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.

### Changed

- Moved `pytest` from required dependencies to the `dev` extra.

## [0.1.0]

Initial development version. Not yet released to PyPI.
37 changes: 37 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Contributing

Thanks for your interest in devol. This is a small project, so the process is light.

## Before you start

For anything non-trivial, open an issue first to discuss the change. Bug fixes, typo fixes, and small quality-of-life improvements can go straight to a PR.

## Development setup

```bash
git clone https://github.com/LabStrangeLoop/devol.git
cd devol
uv sync --extra dev
```

## Before you open a PR

Please make sure these all pass locally:

```bash
uv run pytest
uv run ruff check
uv run ruff format --check
uv run mypy src/
```

## Pull requests

- One logical change per PR.
- Include a short description of the "why" — what problem does this solve?
- If you add behavior, add tests.
- Add a line to `CHANGELOG.md` under `[Unreleased]` describing user-visible changes.

## Questions

Open an issue with the `question` label, or start a discussion. No wrong questions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2026 Dario Cazzani, Aleksandr Yeganov

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
35 changes: 33 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,55 @@
name = "devol"
version = "0.1.0"
description = "Diffusion Evolution Algorithm - Evolution through iterative denoising"
readme = "README.md"
license = "MIT"
license-files = ["LICENSE"]
requires-python = ">=3.11"
authors = [
{name = "Dario Cazzani", email = "dariocazzani@gmail.com"},
{name = "Aleksandr Yeganov", email = "ayeganov@gmail.com"},
]
keywords = [
"evolution",
"optimization",
"diffusion",
"evolutionary-algorithms",
"black-box-optimization",
]
classifiers = [
"Development Status :: 3 - Alpha",
"Intended Audience :: Science/Research",
"Intended Audience :: Developers",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
"Topic :: Scientific/Engineering :: Artificial Intelligence",
"Operating System :: OS Independent",
"Typing :: Typed",
]
dependencies = [
"gymnasium[classic-control]>=1.2.1",
"matplotlib>=3.10.7",
"numpy>=1.26.0",
"pydantic>=2.0.0",
"pydantic-settings>=2.0.0",
"pydantic-yaml>=1.6.0",
"pytest>=8.4.2",
"torch>=2.9.0",
"torchvision>=0.24.0",
]

[project.urls]
Homepage = "https://github.com/LabStrangeLoop/devol"
Repository = "https://github.com/LabStrangeLoop/devol"
Issues = "https://github.com/LabStrangeLoop/devol/issues"
Changelog = "https://github.com/LabStrangeLoop/devol/blob/main/CHANGELOG.md"

[project.optional-dependencies]
dev = [
"ruff>=0.1.0",
"mypy>=1.7.0",
"pytest>=7.0.0",
"pytest>=8.0.0",
]
examples = [
"matplotlib>=3.8.0",
Expand Down
Empty file added src/devol/py.typed
Empty file.
4 changes: 1 addition & 3 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading