API Reference

This section provides detailed documentation for all AMBER classes, functions, and modules.

Core Components

• Model
  • Model
  • Basic Usage
  • Key Methods
• Agent
  • Agent
  • Basic Usage
  • Custom Agent Classes
  • Agent Properties
• Population Managers
  • Population
  • BatchUpdateContext
• Environments
  • Environment
  • GridEnvironment
  • NetworkEnvironment
  • Position
  • SpaceEnvironment
  • Grid Environment
  • Space Environment
  • Network Environment
• Sequences
  • AgentList
  • FilteredAgentList
  • ScatterAgentList
  • Features

Utilities

• Optimization
  • MultiObjectiveSMAC
  • ParameterSpace
  • SMACOptimizer
  • SMACParameterSpace
  • bayesian_optimization()
  • grid_search()
  • objective_function()
  • random_search()
  • Parameter Space
  • Optimization Functions
• Experiment
  • Experiment
  • IntRange
  • Sample
  • Experiment Class
  • Sample Class
  • IntRange Class
• Base Classes
  • AttrDict
  • BaseAgent
  • BaseModel
  • BaseModel
  • BaseAgent

Quick Reference

Core Classes:

• ambr.Model - Base class for all agent-based models

• ambr.Agent - Individual agent with behaviors and properties

• ambr.BaseAgent - Abstract base class for custom agents

• ambr.BaseModel - Abstract base class for custom models

• ambr.Population - SoA memory manager for high-performance state handling

Environments:

• ambr.GridEnvironment - 2D grid-based spatial environment

• ambr.SpaceEnvironment - Continuous 2D space environment

• ambr.NetworkEnvironment - Graph/network-based environment

Data Structures:

• ambr.AgentList - List-like container for agents with additional functionality

Optimization:

• ambr.grid_search() - Exhaustive parameter space search

• ambr.random_search() - Random parameter sampling

• ambr.bayesian_optimization() - Bayesian optimization of model parameters

Experiments:

• ambr.Experiment - Framework for running multiple model configurations

• ambr.Sample - Parameter sampling for experiments

• ambr.IntRange - Integer range specification for parameters