Engine result shape and the Kiploks UI

Source path in repo: docs/examples/08-result-shape-and-kiploks-ui.md. [View on GitHub]

Mirrored from the engine repository. Prefer reading here for a consistent experience; use GitHub for file history and blame.

The Open Core engine does not ship a web UI. It returns JSON (AnalyzeOutput or WFAAnalysisOutput). The hosted Kiploks product maps those fields into analysis pages (cards, tables, verdict blocks, and optional SSR slots).

Minimal vs WFA

Entry pointContractTypical use
analyze()AnalyzeOutputQuick trade statistics + reproducibility metadata
analyzeFromTrades() / analyzeFromWindows()WFAAnalysisOutputWFE, consistency, robustness score, optional blocks, warnings

Field to UI (conceptual)

flowchart LR
  subgraph Engine JSON
    S[summary]
    M[metadata]
    W[wfe + consistency]
    R[robustnessScore]
    B[parameterStability / benchmark / dqg / ...]
    Warn[warnings]
  end
  subgraph Product UI
    T[Trade / summary strip]
    V[Versions and hashes footer]
    WF[Walk-Forward / WFE section]
    RB[Robustness block]
    OB[Optional analytics blocks]
    AL[Alerts / warnings]
  end
  S --> T
  M --> V
  W --> WF
  R --> RB
  B --> OB
  Warn --> AL
  • A hosting application may attach additional server-side blocks (benchmark comparison, final verdict payload, DQG details, etc.). Public WFA often exposes available: false with a reason for blocks that need a richer payload.
  • Single source of truth for displayed verdicts and heavy analytics in a hosted deployment is the server-assembled analysis object; the OSS engine focuses on deterministic math and stable contracts.

Static demo

Open [result-layout-demo.html] in a browser for a side-by-side schematic (conceptual blocks vs raw JSON).

Example files [sample-output/].

For benchmark, risk, kill switch, and other full-report blocks vs public WFA placeholders, see [09-full-report-vs-public-wfa.md].

[Back to documentation index]