Files
mlx-knife/docs/ADR
The BROKE Cluster Team d3f7d091bc Release 2.0.4-beta.3: Dependency compatibility + Documentation
Bugfixes and compatibility improvements. No new features.

Core fixes:
- Framework detection for web API models (Issue #48)
- Video-only model filtering from vision capability
- Page size detection for memory metrics (macOS)
- Model switch log timing (after load completion)

Compatibility:
- hub 1.x + transformers 5.0 support
- Python 3.9-3.14 verified (494 tests passing)

Testing infrastructure:
- Benchmark schema v0.2.0 (hardware profiling, system health)
- Benchmark template v1.0 (automated JSONL→Markdown reports)
- Memory timeline visualization (memplot.py)
- Unified model filter (build_model_object single source)

Documentation:
- Multi-Modal Support section in README (Vision subsection)
- JSON API 0.1.5-0.1.6 marked Stable
- Vision promoted from alpha to beta status
- Removed conceptual drift and outdated references

See CHANGELOG.md for complete details.
2025-12-23 12:19:04 +01:00
..

Architecture Decision Records (ADRs)

Overview

This directory contains Architecture Decision Records (ADRs) that document significant architectural and design decisions for the MLX-Knife project.

Active ADRs

ADR Title Status Date
ADR-001 JSON API Strategy & 2.0 Migration Path Accepted 2025-08-28
ADR-002 Edge Cases from 1.x Test Suite Accepted 2025-08-28
ADR-003 Server and Run Functionality Port from 1.x to 2.0 Accepted 2025-09-10
ADR-004 Enhanced Error Handling & Logging Accepted 2025-10-19
ADR-005 Clone Implementation Beta3 Superseded by ADR-007 2025-09-18
ADR-006 Clone Implementation Revised Superseded by ADR-007 2025-09-18
ADR-007 Clone Implementation Fixed Strategy Accepted 2025-09-18
ADR-008 MLXModel Package Format Proposed (not committed)
ADR-009 Stop Token Detection Fix Implemented 2025-10-21
ADR-010 Reasoning Content API Draft (not committed)
ADR-011 E2E Live Test Architecture Implemented 2025-10-21
ADR-012 Vision Support Roadmap Implemented (Phase 1-3) 2025-11-12
ADR-013 Community Model Quality Database Planned (not committed)
ADR-014 Unix Pipe Integration Implemented (Phase 1) 2025-11-16
ADR-015 Embeddings API Planned (not committed)
ADR-016 Memory-Aware Model Loading Implemented (Phase 1-2) 2025-12-05
ADR-017 Image Metadata Extraction (EXIF) Implemented (not committed)

ADR Format

Each ADR follows this structure:

  • Status: Proposed / Accepted / Rejected / Superseded
  • Context: Why this decision is needed
  • Decision: What we decided to do
  • Consequences: What happens as a result