great-docs.yml

# Great Docs Configuration
# See https://posit-dev.github.io/great-docs/user-guide/configuration.html

# Module Name (optional)
# ----------------------
# Set this if your importable module name differs from the project name.
# Example: project 'py-yaml12' with module name 'yaml12'
# module: yaml12

# Docstring Parser
# ----------------
# The docstring format used in your package (numpy, google, or sphinx)
parser: numpy

# Dynamic Introspection
# ---------------------
# Use runtime introspection for more accurate documentation (default: true)
# Set to false if your package has cyclic alias issues (e.g., PyO3/Rust bindings)
dynamic: true

# API Discovery Settings
# ----------------------
# Exclude items from auto-documentation
exclude:
  - __version__

# Logo & Favicon
# ---------------
# Point to a single logo file (replaces the text title in the navbar):
# logo: assets/logo.svg
#
# For light/dark variants:
# logo:
#   light: assets/logo-light.svg
#   dark: assets/logo-dark.svg
#
# To show the text title alongside the logo, add: show_title: true

# Author Information
# ------------------
# Author metadata for display in the landing page sidebar
# You can add additional fields: github, orcid, affiliation, homepage
authors:
  - name: Juan Orduz
    role: Author
    # affiliation:
    email: juanitorduz@gmail.com
    # github:
    # orcid:
    # homepage:

# Funding / Copyright Holder
# --------------------------
# Credit the organization that funds or holds copyright for this package.
# Displays in sidebar and footer. Homepage and ROR provide links.
# funding:
#   name: "Posit Software, PBC"
#   roles:
#     - Copyright holder
#     - funder
#   homepage: https://posit.co
#   ror: https://ror.org/03wc8by49

# API Reference Structure
# -----------------------
# Customize the sections below to organize your API documentation.
# - Reorder items within a section to change their display order
# - Move items between sections or create new sections
# - Use 'members: false' to exclude methods from documentation
# - Add 'desc:' to sections for descriptions

reference:
  - title: Forecasters
    desc: High-level interfaces for fitting and forecasting.
    contents:
      - forecaster.Forecaster
      - forecaster.HMCForecaster
      - forecaster.PathfinderForecaster

  - title: Models
    desc: Building forecasting models (object-oriented and functional).
    contents:
      - forecaster.ForecastingModel
      - functional.models.forecasting_model

  - title: "Functional core: model primitives"
    desc: Pure functional primitives for the train/forecast split.
    contents:
      - functional.models.Horizon
      - functional.models.time_series
      - functional.models.markov_time_series
      - functional.models.predict
      - functional.models.predict_glm

  - title: "Functional core: fitting"
    desc: Optimizer/guide/kernel resolution and the SVI and MCMC fit entry points.
    contents:
      - functional.svi.resolve_optimizer
      - functional.svi.resolve_guide
      - functional.svi.fit_svi
      - functional.svi.SVIFit
      - functional.mcmc.resolve_kernel
      - functional.mcmc.fit_mcmc
      - functional.mcmc.MCMCFit

  - title: "Functional core: posterior and prediction"
    desc: Drawing posterior samples and generating forecasts and in-sample predictions.
    contents:
      - functional.posterior.draw_posterior
      - functional.prediction.forecast
      - functional.prediction.predict_in_sample

  - title: Backtesting & evaluation
    desc: Rolling-window backtesting and forecast metrics.
    contents:
      - evaluate.backtest
      - evaluate.backtest_vectorized
      - evaluate.BacktestResult
      - evaluate.VectorizedBacktestResult
      - evaluate.evaluate_forecast
      - evaluate.results_to_dataframe
      - evaluate.eval_crps
      - evaluate.eval_mae
      - evaluate.eval_rmse
      - evaluate.eval_coverage
      - metrics.crps_empirical
      - metrics.eval_pinball
      - metrics.eval_interval_score
      - metrics.make_mase

  - title: Seasonal features
    desc: Fourier design matrices and seasonal tiling.
    contents:
      - features.fourier_features
      - features.periodic_repeat

  - title: Array helpers
    desc: Time-axis array shaping for the train/forecast split.
    contents:
      - arrays.zero_data_like
      - arrays.concat_future

  - title: Distribution surgery
    desc: Time-axis operations on observation distributions, extensible via singledispatch.
    contents:
      - surgery.shift_loc
      - surgery.slice_time
      - surgery.prefix_condition
      - surgery.register_elementwise

  - title: Optional dependencies
    desc: Lazy imports behind pyproject extras.
    contents:
      - optional.require

  - title: Exceptions
    desc: Package exception hierarchy raised at resolution and validation boundaries.
    contents:
      - exceptions.NumpyroForecastError
      - exceptions.BacktestWindowError
      - exceptions.VectorizedGuideError
      - exceptions.VectorizedMetricError
      - exceptions.OptimizerResolutionError
      - exceptions.GuideResolutionError
      - exceptions.GuideSampleArgsError
      - exceptions.KernelResolutionError
      - exceptions.KernelConfigError
      - exceptions.CovariateDimsError
      - exceptions.MVNLayoutError
      - exceptions.DeviceMemoryError

  - title: ArviZ export
    desc: Convert fits into ArviZ-schema xarray DataTrees for diagnostics and plotting.
    contents:
      - convert.to_datatree
      - convert.add_forecast_groups
      - convert.predictions_to_datatree

  - title: Extensions (contrib)
    desc: Optional backends behind pyproject extras (never imported by default).
    contents:
      - contrib.blackjax.BlackjaxNUTSKernel
      - contrib.blackjax.BlackjaxMCLMCKernel
      - contrib.blackjax.BlackjaxCustomKernel
      - contrib.blackjax.PathfinderFit
      - contrib.blackjax.fit_pathfinder

  - title: Datasets
    desc: Example datasets used in the tutorials.
    contents:
      - datasets.load_bart_weekly
      - datasets.load_bart_hierarchical
      - datasets.load_victoria_electricity
      - datasets.bart_available

# Example notebooks live in docs/examples/. The .qmd wrapper pages that embed
# their stored outputs are generated at build time by scripts/build_docs.py
# (no re-execution), so only the notebooks themselves are committed.
sections:
  - title: Examples
    dir: docs/examples
    index: true
    index_columns: 2

# Versioned Documentation
# ------------------------
# The `versions:` block is injected at build time by scripts/build_docs.py (and
# removed again afterwards), so it is deliberately absent here: the newest
# semver git tag becomes the stable site root and this checkout becomes
# /v/dev/, with the release's API snapshot generated on demand into the
# gitignored .great-docs-cache/. Releases therefore need no docs steps; see the
# Documentation section of AGENTS.md.

# GitHub Integration
# ------------------
# Repository URL is auto-detected from the git remote / pyproject URLs.
github_style: widget

# Site URL
# --------
# Canonical address of the deployed documentation site.
# Required for subdirectory deployments, skills page install commands,
# .well-known/ discovery, and sitemaps.
site_url: "https://juanitorduz.github.io/numpyro_forecast/"

# Make embedded notebook output images responsive so wide matplotlib figures
# fit the content column instead of overflowing (they carry explicit
# width/height attributes and lack Bootstrap's .img-fluid class).
include_in_header:
  - text: |
      <style>
      .cell-output-display img { max-width: 100%; height: auto; }
      </style>

# Site Settings
# -------------
# site:
#   theme: flatly              # Quarto theme (default: flatly)
#   toc: true                  # Show table of contents (default: true)
#   toc-depth: 2               # TOC heading depth (default: 2)
#   toc-title: On this page    # TOC title (default: "On this page")

# Jupyter Kernel
# --------------
# Jupyter kernel to use for executing code cells in .qmd files.
# This is set at the project level so it applies to all pages, including
# auto-generated API reference pages. Can be overridden in individual .qmd
# file frontmatter if needed for special cases.
jupyter: python3

# CLI Documentation
# -----------------
# cli:
#   enabled: true              # Enable CLI documentation
#   module: my_package.cli     # Module containing Click commands
#   name: cli                  # Name of the Click command object