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
240 changes: 132 additions & 108 deletions ABI-FFI-README.md → ABI-FFI-README.adoc

Large diffs are not rendered by default.

48 changes: 48 additions & 0 deletions ARCHITECTURE.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
== Architecture

=== Overview

This repository follows a modular, maintainable architecture designed
for clarity, scalability, and long-term sustainability.

=== Directory Structure

....
.
├── src/ # Source code
├── tests/ # Test suites
├── docs/ # Documentation
├── scripts/ # Utility scripts
├── config/ # Configuration files
├── LICENSE # License file
├── LICENSES/ # Full license texts
└── README.adoc # Project documentation
....

=== Design Principles

* *Separation of Concerns*: Each module has a single responsibility
* *Testability*: Code is written to be easily testable
* *Documentation*: All public APIs are documented
* *Configuration*: Environment-specific settings are externalized

=== Dependencies

* External dependencies are minimized and clearly declared
* Version pinning is used for reproducibility

=== Security Considerations

* Sensitive data is never committed to the repository
* Secrets are managed through environment variables or secure vaults
* Regular dependency audits are performed

=== Maintainability

* Code follows consistent style guidelines
* Pull requests require review and CI checks
* Issues and discussions are tracked transparently

'''''

_Last updated: 2026-07-18_
47 changes: 0 additions & 47 deletions ARCHITECTURE.md

This file was deleted.

160 changes: 66 additions & 94 deletions CHANGELOG.adoc
Original file line number Diff line number Diff line change
@@ -1,102 +1,74 @@
<!-- SPDX-FileCopyrightText: 2024 Joshua Jewell -->
<!-- SPDX-License-Identifier: CC-BY-SA-4.0 -->

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

== [Unreleased]

=== Added
- RSR (Rhodium Standard Repository) compliance
- Full documentation suite
- **Diff-based compression**: Store VAE images as diffs to reduce dataset size by ~50%
- New `compress` subcommand to convert VAE images to diffs
- New `decompress` subcommand to reconstruct full VAE directory
- New `reconstruct` subcommand to reconstruct single VAE image
- Julia `CompressedVAEDataset` for on-the-fly VAE reconstruction
- Diff encoding: `diff = VAE - Original + 128` (offset for signed values)
- **Contrastive learning model** for VAE artifact detection (`contrastive_model.jl`)
- CNN encoder with ResNet-style residual blocks (embed_dim=256)
- Projection head for contrastive learning (proj_dim=128)
- Multiple loss functions: NT-Xent, Supervised Contrastive, Triplet, Contrastive
- Two-phase training: contrastive pre-training + classifier fine-tuning
- Binary classifier for original vs VAE discrimination
- Embedding extraction for visualization (t-SNE, UMAP compatible)
- Evaluation metrics: accuracy, precision, recall, F1, confusion matrix
- GPU support via CUDA.jl (optional)
- Justfile recipes: `train`, `train-compressed`, `evaluate`, `embed`, `train-full`

== [1.0.0] - 2024-01-01

=== Added

==== Core Features
- SHAKE256 (d=256) cryptographic checksums for all image files
- Train/test/validation/calibration splits (70/15/10/5 ratio)
- Both random and stratified split generation
- Size-based stratification with configurable bins

==== Metadata & Configuration
- CUE metadata generation with Dublin Core compliance
- Nickel configuration schema
- SPDX headers on all source files

==== Formal Verification
- Isabelle/HOL proofs for split properties
- Disjointness (no overlap between splits)
- Exhaustiveness (all images assigned)
- Ratio correctness (within 1% tolerance)
- Original-VAE bijection preservation

==== CLI
- `normalize` subcommand for dataset processing
- `verify` subcommand for output validation
- `stats` subcommand for statistics display
- `hash` subcommand for single-file checksums
- Comprehensive help and examples

==== Infrastructure
- Nix flake for reproducible builds
- Podman container with Chainguard Wolfi base
- Justfile task runner
- Julia utilities for Flux.jl training
== Changelog

All notable changes to `+zerostep+` will be documented in this file.

This file is generated from conventional commits by the
https://github.com/hyperpolymath/standards/blob/main/.github/workflows/changelog-reusable.yml[`+changelog-reusable.yml+`]
workflow (`+hyperpolymath/standards#206+`). Adopt the workflow in this
repo’s CI to keep this file in sync automatically — see
https://github.com/hyperpolymath/standards/blob/main/templates/cliff.toml[`+templates/cliff.toml+`]
for the canonical config.

The format follows https://keepachangelog.com/en/1.1.0/[Keep a
Changelog]; this project aims to follow
https://semver.org/spec/v2.0.0.html[Semantic Versioning].

=== [Unreleased]

==== Added

* feat(crg): add crg-grade and crg-badge justfile recipes
* feat: add stapeln.toml layer-based container definitionfrom existing
Containerfile to stapeln format.Chainguard base, security hardening,
SBOM generation.-Authored-By: Claude Opus 4.6 (1M context)
noreply@anthropic.com
* feat: deploy UX Manifesto infrastructure
* feat: add CLADE.a2ml — clade taxonomy declaration
* feat(ci): enable Hypatia scanning

==== Fixed

* fix(ci): bump a2ml/k9-validate-action pins to canonical (#32)
* fix(ci): sync hypatia-scan.yml to canonical (#31)
* fix(ci): build Hypatia escript from repo root (estate dogfood drift)
* fix(ci): hypatia-scan workdir ($\{\{ env.HOME }} resolves empty) (#30)
* fix(ci): bump erlef/setup-beam SHA for ubuntu24 runner support (#23)
* fix(ci): repair YAML block-scalar in workflow-linter Check Permissions
step (#26)
* fix(ci): move secret-scanner Cargo.toml gate from job-level if: to
step-level (#28)
* fix(src/metadata.rs): remove unused std::fs::File import (#25)
* fix(codeql): switch language matrix to '`actions`' (no JS/TS in repo)
(#24)
* fix(ci): Resolve workflow-linter self-matching and metadata issues

==== Changed

* refactor: migrate 6SCM → 6A2 (.scm → .a2ml format)

==== Documentation
- README with usage examples
- QUICKSTART guide
- RSR compliance documentation
- Security policy
- Contributing guidelines (TPCF)
- Governance model

=== Security
- Memory-safe Rust implementation
- No unsafe code blocks
- FIPS 202 compliant cryptography
- Non-root container execution
- Supply chain security (SPDX, pinned deps)
* docs: record tech-debt audit findings (2026-05-26) (#43)
* docs: substantive CRG C annotation (EXPLAINME.adoc)
* docs: add EXPLAINME.adoc — prove-it file backing README claims
* docs: add checkpoint files for state tracking

== Migration Guide
==== CI

=== From v0.x to v1.0.0
* ci(rust): convert rust-ci.yml to thin wrapper (standards#174) (#40)
* ci: redistribute concurrency-cancel guard to read-only check workflows
(#34)
* ci(dependabot): restore cargo PR limit so security PRs flow (#16)
* ci(secret-scanner): drop duplicate –fail from trufflehog extra_args
(#15)
* ci: bump actions/upload-artifact SHA to current v4 (#14)

This is the initial release. No migration needed.
=== Pre-history

== Version History
Prior commits to this file’s introduction are recorded in git history
but not formally classified into Keep-a-Changelog sections. To backfill,
run `+git cliff -o CHANGELOG.md+` locally using the canonical
https://github.com/hyperpolymath/standards/blob/main/templates/cliff.toml[`+cliff.toml+`]
— this is one-shot mechanical work.

| Version | Release Date | Status |
|---------|--------------|--------|
| 1.0.0 | 2024-01-01 | Current |

== Deprecation Policy

- Deprecated features announced one minor version before removal
- Migration guides provided for breaking changes
- LTS branches may be created for critical security fixes

[Unreleased]: https://huggingface.co/datasets/joshuajewell/VAEDecodedImages-SDXL/compare/v1.0.0...HEAD
[1.0.0]: https://huggingface.co/datasets/joshuajewell/VAEDecodedImages-SDXL/releases/tag/v1.0.0
'''''
67 changes: 0 additions & 67 deletions CHANGELOG.md

This file was deleted.

Loading
Loading