PropFlow

Contents:

  • Installation
    • From PyPI (Recommended)
    • From Source
    • Development Installation
    • Requirements
    • Verifying Installation
  • Quick Start Guide
    • Prepare the Environment
    • Step 1 — Build a Factor Graph (FGBuilder First)
    • Step 2 — Run Belief Propagation
    • Step 3 — Try Engine Variants and Policies
    • Step 4 — Scale Out with the Simulator
    • Optional — Build a Custom Graph Manually
    • Inspecting Runs with Analyzer Tooling
    • Where to Go Next
  • PropFlow User Guide
    • Top-Down Architecture
    • Agents Layer
      • Variable Agents
      • Factor Agents
      • Message Lifecycle
    • Factor Graph Layer
      • Using FGBuilder
      • Cost-Table Factories
      • Manual Graph Assembly
    • Engine Layer
      • Selecting a Computator
      • Engine Variants and Policies
      • Running a Single Engine
    • Simulation Layer
    • Analysis Layer
    • Chain of Creation
      • Custom Graph Checklist
    • Next Steps
  • Snapshot How-To (Updated)
    • 1. Capture Snapshots
    • 2. Inspect Data
    • 3. Persist Snapshots
    • 4. Analyse Snapshots
    • 5. Visualise
    • 6. BCT Data
  • PropFlow Handbook
    • Conceptual Overview
      • 1. What PropFlow Solves
      • 2. Core Runtime Concepts
      • 3. Creation Pipeline (Top-Down)
      • 4. Directory Layout
      • 5. Data Flow Through an Engine Step
      • 6. Extensibility Points
      • 7. Operational Roles
    • System Setup & Dependencies
      • 1. Supported Platforms
      • 2. Core Dependencies
      • 3. Environment Bootstrapping
        • Option A – Recommended: uv
        • Option B – Standard virtualenv + pip
        • Option C – Conda
      • 4. Verifying Installation
      • 5. External Services & Data
      • 6. File System Expectations
    • Running Simulations & Tools
      • 1. Quick Smoke Test (main.py)
      • 2. Using the Simulator API
      • 3. Command-Line Interface (bp-sim)
      • 4. Snapshot Capture & Analysis
      • 5. Examples Directory
      • 6. Testing & Validation
        • Unit Tests
        • Coverage
        • Static Analysis
      • 7. Logging & Artefacts
    • Deployment Playbooks
      • 1. Local Workstation or Lab Server
        • Steps
        • Tips
      • 2. Containerised Deployment (Docker)
        • Example Dockerfile
        • Build & Run
        • Notes
      • 3. HPC / Batch Scheduling
      • 4. Web Service / API Integration
      • 5. Packaging & Distribution
      • 6. Configuration Management
      • 7. Logging & Monitoring
    • Development Workflow
      • 1. Repository Hygiene
      • 2. Tooling
      • 3. Coding Guidelines
      • 4. Testing Strategy
      • 5. Adding New Features
      • 6. Release Process
      • 7. Documentation Maintenance
      • 8. Collaboration
    • Reference Tables
      • 1. Modules & Key Entrypoints
      • 2. Configuration Defaults (global_config_mapping.py)
      • 3. CLI & Scripts
      • 4. Environment Variables
      • 5. File & Directory Conventions
      • 6. Glossary
    • Troubleshooting & FAQ
      • 1. Installation Issues
        • ModuleNotFoundError: No module named 'propflow'
        • python: command not found
        • Dependency compilation failures
      • 2. Runtime Errors
        • RuntimeError: Invalid default configuration
        • ModuleNotFoundError: No module named 'networkx'
        • Multiprocessing permissions (macOS sandbox errors)
      • 3. Performance & Resource Usage
      • 4. Visualisation Problems
      • 5. Snapshot Recorder Questions
      • 6. Deployment Questions
      • 7. Getting Support
  • API Reference
    • Core Modules
      • Engines
        • BPEngine
        • Engine
        • SplitEngine
        • MidRunSplitEngine
        • CostReductionOnceEngine
        • DampingEngine
        • QRDampingEngine
        • RDampingEngine
        • DiffusionEngine
        • DampingSCFGEngine
        • DampingCROnceEngine
        • TRWEngine
        • DampingTRWEngine
        • MessagePruningEngine
      • Factor Graphs
        • FactorGraph
      • Computators
        • BPComputator
        • Computator
        • MinSumComputator
        • MaxSumComputator
        • MaxProductComputator
        • SumProductComputator
      • Agents
        • FGAgent
        • VariableAgent
        • FactorAgent
      • Components
        • Message
        • MailHandler
      • Policies
        • ConvergenceConfig
        • ConvergenceMonitor
        • MessagePruningPolicy
        • TD()
        • cost_reduction_all_factors_once()
        • damp()
        • damp_factor()
        • discount()
        • discount_attentive()
        • init_normalization()
        • normalize_cost_table_sum()
        • normalize_inbox()
        • normalize_soft_max()
        • reduce_R()
        • split_all_factors()
        • split_factors()
        • split_specific_factors()
      • Utilities
        • dummy_func()
        • FGBuilder
        • find_project_root()
        • CTFactories
      • Configuration
        • Logger
        • CTFactories
        • get_ct_factory()
        • create_poisson_table()
        • create_random_int_table()
        • create_uniform_float_table()
        • EngineDefaults
        • LoggingDefaults
        • PolicyDefaults
        • ConvergenceDefaults
        • SimulatorDefaults
        • validate_engine_config()
        • validate_policy_config()
        • validate_convergence_config()
        • get_validated_config()
      • Simulator
        • Simulator
      • Snapshots
        • EngineSnapshot
        • Jacobians
        • CycleMetrics
        • SnapshotManager
        • SnapshotAnalyzer
        • AnalysisReport
        • SnapshotVisualizer
        • StepByStepFormatter
  • Examples
    • Basic Cycle Graph
    • Comparing Engine Variants
    • Custom Cost Function
    • Large-Scale Problem
    • Analyzing Convergence
  • Contributing
    • Getting Started
    • Development Workflow
      • Running Tests
      • Code Quality
      • Documentation
    • Contribution Guidelines
      • Code Style
      • Commit Messages
      • Pull Requests
      • Testing
    • What to Contribute
      • Need Ideas?
    • Questions?
    • License
PropFlow
  • Search

© Copyright 2026, Or Muller.

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