v1.0.1
Python Libraryv1.0.1
Python API Reference
Complete public Python API reference for behaviorsim==1.0.1.
Reference documentation for public classes and functions exported by behaviorsim.
Simulator
behaviorsim.Simulator(states, profile=None, transition_matrix=None, initial_state=None, *, profiles=None, profile_distribution=None)
Domain-neutral simulation engine for generating synthetic behavioral traces.
Simulator.from_preset()
classmethod Simulator.from_preset(name: str, **kwargs: Any) -> Simulator
Construct a Simulator from a registered preset name (e.g. 'finance', 'healthcare', 'education', 'mobile_app').
Simulator.generate()
Simulator.generate(num_interactions: int = 100, num_sequences: int = 1, seed: Optional[int] = None) -> pandas.DataFrame
| Parameter | Type | Default | Description |
|---|---|---|---|
| num_interactions | int | 100 | Number of interaction steps per sequence |
| num_sequences | int | 1 | Number of independent sequence cohorts |
| seed | Optional[int] | None | RNG integer seed for reproducible generation |
Core Classes
State(name, description=None): Discrete state representation.Profile(name, transition_matrix=None, ...): Agent persona specifying custom priors and parameter sets.FeatureDistribution(state, feature, distribution, params): Parametric emission specification.
Preset Discovery
discovery.py
import behaviorsim.presets
presets_list = behaviorsim.presets.list_presets()
print(presets_list)
# Output: ['education', 'finance', 'healthcare', 'mobile_app']