Skip to content

Commit 3234e3e

Browse files
Jonathan D.A. Jewellclaude
andcommitted
chore: sync template files and configuration
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent d5f2952 commit 3234e3e

2 files changed

Lines changed: 1184 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
<!-- SPDX-FileCopyrightText: 2024 Joshua Jewell -->
2+
<!-- SPDX-License-Identifier: MIT -->
3+
4+
# Changelog
5+
6+
All notable changes to this project will be documented in this file.
7+
8+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
9+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
10+
11+
## [Unreleased]
12+
13+
### Added
14+
- RSR (Rhodium Standard Repository) compliance
15+
- Full documentation suite
16+
- **Diff-based compression**: Store VAE images as diffs to reduce dataset size by ~50%
17+
- New `compress` subcommand to convert VAE images to diffs
18+
- New `decompress` subcommand to reconstruct full VAE directory
19+
- New `reconstruct` subcommand to reconstruct single VAE image
20+
- Julia `CompressedVAEDataset` for on-the-fly VAE reconstruction
21+
- Diff encoding: `diff = VAE - Original + 128` (offset for signed values)
22+
- **Contrastive learning model** for VAE artifact detection (`contrastive_model.jl`)
23+
- CNN encoder with ResNet-style residual blocks (embed_dim=256)
24+
- Projection head for contrastive learning (proj_dim=128)
25+
- Multiple loss functions: NT-Xent, Supervised Contrastive, Triplet, Contrastive
26+
- Two-phase training: contrastive pre-training + classifier fine-tuning
27+
- Binary classifier for original vs VAE discrimination
28+
- Embedding extraction for visualization (t-SNE, UMAP compatible)
29+
- Evaluation metrics: accuracy, precision, recall, F1, confusion matrix
30+
- GPU support via CUDA.jl (optional)
31+
- Justfile recipes: `train`, `train-compressed`, `evaluate`, `embed`, `train-full`
32+
33+
## [1.0.0] - 2024-01-01
34+
35+
### Added
36+
37+
#### Core Features
38+
- SHAKE256 (d=256) cryptographic checksums for all image files
39+
- Train/test/validation/calibration splits (70/15/10/5 ratio)
40+
- Both random and stratified split generation
41+
- Size-based stratification with configurable bins
42+
43+
#### Metadata & Configuration
44+
- CUE metadata generation with Dublin Core compliance
45+
- Nickel configuration schema
46+
- SPDX headers on all source files
47+
48+
#### Formal Verification
49+
- Isabelle/HOL proofs for split properties
50+
- Disjointness (no overlap between splits)
51+
- Exhaustiveness (all images assigned)
52+
- Ratio correctness (within 1% tolerance)
53+
- Original-VAE bijection preservation
54+
55+
#### CLI
56+
- `normalize` subcommand for dataset processing
57+
- `verify` subcommand for output validation
58+
- `stats` subcommand for statistics display
59+
- `hash` subcommand for single-file checksums
60+
- Comprehensive help and examples
61+
62+
#### Infrastructure
63+
- Nix flake for reproducible builds
64+
- Podman container with Chainguard Wolfi base
65+
- Justfile task runner
66+
- Julia utilities for Flux.jl training
67+
68+
#### Documentation
69+
- README with usage examples
70+
- QUICKSTART guide
71+
- RSR compliance documentation
72+
- Security policy
73+
- Contributing guidelines (TPCF)
74+
- Governance model
75+
76+
### Security
77+
- Memory-safe Rust implementation
78+
- No unsafe code blocks
79+
- FIPS 202 compliant cryptography
80+
- Non-root container execution
81+
- Supply chain security (SPDX, pinned deps)
82+
83+
## Migration Guide
84+
85+
### From v0.x to v1.0.0
86+
87+
This is the initial release. No migration needed.
88+
89+
## Version History
90+
91+
| Version | Release Date | Status |
92+
|---------|--------------|--------|
93+
| 1.0.0 | 2024-01-01 | Current |
94+
95+
## Deprecation Policy
96+
97+
- Deprecated features announced one minor version before removal
98+
- Migration guides provided for breaking changes
99+
- LTS branches may be created for critical security fixes
100+
101+
[Unreleased]: https://huggingface.co/datasets/joshuajewell/VAEDecodedImages-SDXL/compare/v1.0.0...HEAD
102+
[1.0.0]: https://huggingface.co/datasets/joshuajewell/VAEDecodedImages-SDXL/releases/tag/v1.0.0

0 commit comments

Comments
 (0)