Files
mlx-knife/docs/ADR
The BROKE Cluster Team 25609e4dcb Release 2.0.4-beta.5: Community repair tool + OS-agnostic benchmarking
Closes #49 (Mistral Tokenizer Bug)

Major features:
- Workspace Infrastructure (ADR-018 Phase 0a): Managed workspace detection,
  provenance metadata, backward compatible with unmanaged workspaces
- Convert Operation (ADR-018 Phase 1): `mlxk convert --repair-index` fixes
  mlx-vlm #624 affected models (7+ models including Qwen2.5-VL, gemma-3)
- Resumable Pull: Auto-detect partial downloads with `--force-resume`
- Wet Umbrella Test Integration: Single entry point for all real model tests

Fixes:
- #49: BPE space markers now correctly converted (Mistral-family models)
- Vision Portfolio Discovery: Filter by capabilities instead of model_type
- Memory Cleanup Hook: Triggers for both live_e2e and wet markers

Test suite: 528 passed, 60 skipped (Python 3.9-3.14)
2025-12-31 16:05:18 +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