macroforecast
  • Installation
  • For researchers
  • For recipe authors
  • For contributors
  • Architecture
  • Navigator Docs
    • Tree Navigator
    • Path Resolver
    • Compatibility Engine
    • Replication Library
    • YAML And Execution
  • Replications
  • Encyclopedia
  • Troubleshooting & FAQ
  • Docs Conventions
macroforecast
  • Navigator Docs
  • Edit on GitHub

Navigator Docs

The Navigator is the visual front door for the canonical macroforecast layer system:

L0 -> L1 -> L2 -> L3(DAG) -> L4(DAG) -> L5 -> L6 -> L7(DAG) -> L8
        |      |      |       |
       L1.5   L2.5   L3.5    L4.5 diagnostics

What The App Shows First

The Navigator contract starts with the registered layer topology:

  • main layer flow from setup through output;

  • diagnostic hooks L1.5-L4.5 as default-off side branches;

  • list versus graph UI mode per layer;

  • upstream sink inputs and produced sinks;

  • sub-layer and axis counts from the runtime registry;

  • runtime support labels for selected options.

Compatibility checks and YAML previews should treat the layer map as the source of truth for package architecture.

Open the current MVP app:

Open Navigator App

Canonical Layer Roles

Layer

UI mode

Role

L0

list

Study setup, reproducibility, failure and compute policies.

L1

list

Data definition, target/predictor frame, regime metadata.

L2

list

Cleaning and preprocessing into the clean panel.

L3

graph

Feature engineering DAG, final features, feature metadata.

L4

graph

Forecast/model DAG, forecasts, model artifacts, training metadata.

L5

list

Evaluation metrics, aggregation, slicing, ranking.

L6

list

Statistical tests over L4/L5 artifacts.

L7

graph

Interpretation and importance DAG.

L8

list

Output, provenance, manifest, file artifacts.

L1.5-L4.5

list

Diagnostic hooks attached to construction sinks.

Pages

Page

Purpose

Tree Navigator

Explain the canonical layer map and the remaining compatibility axis explorer.

Path Resolver

Compile YAML and show execution status, warnings, blocked reasons, and capability matrix.

Compatibility Engine

Explain constraint rules such as model/feature compatibility, forecast-object metrics, and importance-method restrictions.

Replication Library

Start from known paper-style routes, inspect exact paths, generate YAML, and understand deviations.

YAML and Execution

Save a selected path as YAML, run it from CLI, and reproduce the same route in a notebook.

Recommended Flow

  1. Start with the layer map and select the layer you are designing.

  2. For L3/L4/L7, think in DAG nodes: sources, steps, combines, and sinks.

  3. For list layers, inspect sub-layers and axes in the layer detail panel.

  4. Use the compatibility axis explorer only when you need option-level disabled reasons.

  5. Download or write YAML and run macroforecast-navigate resolve before execution.

  6. Execute with macroforecast-navigate run or the core runtime API.

  • Tree Navigator
  • Path Resolver
  • Compatibility Engine
  • Replication Library
  • YAML And Execution
Previous Next

© Copyright 2026, NanyeonK.

Built with Sphinx using a theme provided by Read the Docs.