Skip to content

API Reference

This section documents Falcon's Python API.

Package Structure

falcon/
├── core/           # Core framework
│   ├── graph       # Graph and Node definitions
│   ├── deployed_graph  # Runtime execution
│   └── base_estimator  # Estimator interface
└── contrib/        # Built-in implementations
    ├── SNPE_A      # Neural posterior estimation
    ├── hypercubemappingprior  # Prior distributions
    └── flow        # Normalizing flows

Core Classes

Class Description
Graph Container for computational graph nodes
Node Single random variable in the graph
DeployedGraph Runtime orchestration with Ray
BaseEstimator Abstract interface for estimators

Contrib Classes

Class Description
SNPE_A Sequential Neural Posterior Estimation
HypercubeMappingPrior Flexible prior distributions
Flow Normalizing flow networks

Quick Import

import falcon

# Core
from falcon import Graph, Node, CompositeNode, DeployedGraph

# Contrib
from falcon.contrib import SNPE_A, HypercubeMappingPrior, Flow

# Utilities
from falcon import read_run, load_run, read_samples