Skip to content

README.md

Latest commit

 

History

History
72 lines (56 loc) · 4.33 KB

README.md

File metadata and controls

72 lines (56 loc) · 4.33 KB
Raw

Documentation

Documentation for the SceneWorks inference workspace.

Start here

  • Getting Started — depend on a runtime bundle, build its validated registries, and load/run media generators, LLMs, and snapshot preparers. The consumer how-to.
  • Model Catalog Reference — every shipped provider id, per platform, with the MLX/Candle deltas. Built from the committed exact-surface tests.
  • Mochi 1 tier strategy — the accepted quantization packaging decision for the native Mochi 1 port (pre-quantized per-tier artifacts, default q4).

Architecture

  • Inference Rearchitecture Rationale — why the repositories were consolidated, why provider discovery is explicit, the alternatives considered, the accepted tradeoffs, and the invariants future changes must preserve. The why behind everything above.
  • Audio Backend Strategy — why audio generation is Candle-native on every platform (no ONNX/third backend), and how the runtime catalog's dedicated audio section carries a candle audio lane inside the mlx macOS bundle.

Licensing

The licensing/ directory holds the primary-source evidence behind the model-weight licence surface — the canonical text URL, the verbatim upstream identifier, and a quoted operative clause for every term assigned to a licence family.

  • Licence family evidence pack (sc-16662) — the licence families, quote-checkable, with an explicit unresolved list. Draft, unsigned. It records facts, not legal conclusions.
  • Media checkpoint census (sc-16665) — which upstream checkpoints every registered media provider actually loads, read from the code. Records component identity only: it assigns no families and asserts no licences, and marks every component whose upstream the repository does not state as UNDETERMINED.
  • Checkpoint licence evidence (sc-16665) — the primary-source licence read for each of those checkpoints, and the sign-off document behind license::components. Draft, unsigned. Its known holes section is the authoritative list of checkpoints that were left without a row rather than given a guessed one.

Migration records

The migration/ directory records how this repository was assembled from the former core-llm, mlx-llm, candle-llm, mlx-gen, and candle-gen histories — source SHAs, filtered-history commit maps, tree-equivalence checks, and per-phase checkpoints. See migration/README.md for the index.

Crate-level docs

Each layer has a README next to its source:

Layer Crates
Contracts gen-core, gen-core-testkit, core-llm
Bundles runtime-catalog, runtime-macos, runtime-cuda, runtime-cpu
LLM engines mlx-llm, candle-llm
Media engines mlx-gen (+ mlx-gen-catalog), candle-gen (+ candle-gen-catalog)

For MLX media internals, see mlx-gen/ARCHITECTURE.md and mlx-gen/docs/MODEL_ARCHITECTURE.md.

Release

  • release/README.md — the immutable, calendar-versioned release train (runtime-YYYY.MM.patch tags), release gates, and bundle contents.
  • CONTRIBUTING.md and SECURITY.md — contribution boundaries and security reporting.