Skip to content

Latest commit

 

History

History
48 lines (37 loc) · 2.29 KB

README.md

File metadata and controls

48 lines (37 loc) · 2.29 KB

Documentation

Guides (start here)

  • three.js render targets in / out — the zero-copy integration path: device sharing, unwrapping render targets to GPUTexture, the full parameter reference, output-into-three, live-loop pacing, pitfalls.
  • Migrating from v1 (TFJS) — the 0.x → 2.x API mapping, requirement changes, weights hosting, and the breaking change that made AutoRuntime the default (ORT moved to denoiser/ort).
  • three.js & TSL — the denoise(), ffxShadows() and ffxReflections() nodes in denoiser/three.

The package README (packages/denoiser/README.md) covers install, quick start, the API sketch, and the device-lifetime rules.

Status / planning (status/)

  • STATUS.md — current state, next actions, known issues, and the org-migration checklist. The living doc.
  • ROADMAP.md — strategic view: v1/native-OIDN comparison, use-case coverage, and the phased plan to the public v2 launch.
  • phase-b-plan.md — Phase B execution plan: demo specs, docs-site page outline, deploy/launch steps, sequencing.
  • MIGRATION_PROGRESS.md — historical record of the TFJS → WebGPU/ONNX migration (architecture, gotchas, commit map).
  • perf-plan.md — the performance work: plan, executed phases, measured results (bench harness, fp16, whole-frame, zero-copy…).

Specs / references (specs/)

Research (research/)

  • nppd-fssa.md — NPPD and its follow-up FSSA (MPI Informatik): what's released, model sizes vs OIDN, training cost, where weights would live, OIDN lock-in and the alternatives, how NRD works and the papers behind it, and why we wait for OIDN 3.

Archive (archive/)

Superseded proposals and notes (implemented specs, NO-GO experiments) — see archive/README.md.