Skip to main content

emulators.factory

emulators.factory

Emulator factory with strategy pattern for history matching.

Classes

Name Description
EmulatorFactory Factory for creating and managing emulator instances.

EmulatorFactory

emulators.factory.EmulatorFactory(default_type='bayes_linear', **default_kwargs)

Factory for creating and managing emulator instances.

Provides a registry-based approach for creating emulators by type, with support for custom emulator registration and default parameters.

Methods

Name Description
available_emulators Get list of available emulator types.
create_and_train_emulator Create and immediately train an emulator.
create_emulator Create a single emulator instance.
create_emulators_for_features Create emulators for multiple features.
get_default_kwargs Get the default parameters.
get_default_type Get the default emulator type.
get_emulator_info Get information about an emulator type.
register_emulator Register a custom emulator type.
set_default_type Create new factory with different default emulator type.
with_defaults Create new factory with updated default parameters.
with_defaults_class Class method to create factory with specific defaults.
available_emulators
emulators.factory.EmulatorFactory.available_emulators()

Get list of available emulator types.

Returns
Name Type Description
List[str] List of registered emulator type names
create_and_train_emulator
emulators.factory.EmulatorFactory.create_and_train_emulator(
    X,
    y,
    emulator_type=None,
    **kwargs,
)

Create and immediately train an emulator.

Convenience method that combines create_emulator() and train().

Parameters
Name Type Description Default
X pd.DataFrame Input data (parameter samples) required
y pd.DataFrame Output data (single feature/column) required
emulator_type Optional[str] Type of emulator to create None
**kwargs Additional parameters for emulator constructor {}
Returns
Name Type Description
BaseEmulator Trained emulator instance
create_emulator
emulators.factory.EmulatorFactory.create_emulator(
    X,
    y,
    emulator_type=None,
    **kwargs,
)

Create a single emulator instance.

Parameters
Name Type Description Default
X pd.DataFrame Input data (parameter samples) required
y pd.DataFrame Output data (single feature/column) required
emulator_type Optional[str] Type of emulator to create (uses default if None) None
**kwargs Additional parameters for emulator constructor {}
Returns
Name Type Description
BaseEmulator Configured emulator instance (not yet trained)
Raises
Name Type Description
ValueError If emulator type is unknown
TypeError If y has multiple columns
create_emulators_for_features
emulators.factory.EmulatorFactory.create_emulators_for_features(
    samples,
    simulation_results,
    features,
    emulator_type=None,
    **kwargs,
)

Create emulators for multiple features.

Parameters
Name Type Description Default
samples pd.DataFrame Parameter samples DataFrame required
simulation_results pd.DataFrame Simulation results DataFrame required
features List[str] List of feature names to create emulators for required
emulator_type Optional[str] Type of emulator to create (uses default if None) None
**kwargs Additional parameters for emulator constructors {}
Returns
Name Type Description
Dict[str, BaseEmulator] Dict mapping feature names to trained emulator instances
Raises
Name Type Description
ValueError If any feature is not found in simulation_results
get_default_kwargs
emulators.factory.EmulatorFactory.get_default_kwargs()

Get the default parameters.

get_default_type
emulators.factory.EmulatorFactory.get_default_type()

Get the default emulator type.

get_emulator_info
emulators.factory.EmulatorFactory.get_emulator_info(emulator_type)

Get information about an emulator type.

Parameters
Name Type Description Default
emulator_type str Name of the emulator type required
Returns
Name Type Description
Dict[str, Any] Dict with emulator information
Raises
Name Type Description
ValueError If emulator type is unknown
register_emulator
emulators.factory.EmulatorFactory.register_emulator(name, emulator_class)

Register a custom emulator type.

Parameters
Name Type Description Default
name str Name to register the emulator under required
emulator_class Type[BaseEmulator] BaseEmulator subclass to register required
Raises
Name Type Description
TypeError If emulator_class is not a BaseEmulator subclass
set_default_type
emulators.factory.EmulatorFactory.set_default_type(emulator_type)

Create new factory with different default emulator type.

Parameters
Name Type Description Default
emulator_type str New default emulator type required
Returns
Name Type Description
EmulatorFactory New EmulatorFactory instance with updated default type
with_defaults
emulators.factory.EmulatorFactory.with_defaults(**kwargs)

Create new factory with updated default parameters.

Parameters
Name Type Description Default
**kwargs Parameters to update in defaults {}
Returns
Name Type Description
EmulatorFactory New EmulatorFactory instance with updated defaults
with_defaults_class
emulators.factory.EmulatorFactory.with_defaults_class(
    default_type='bayes_linear',
    **default_kwargs,
)

Class method to create factory with specific defaults.

Parameters
Name Type Description Default
default_type str Default emulator type 'bayes_linear'
**default_kwargs Default parameters {}
Returns
Name Type Description
EmulatorFactory EmulatorFactory instance with specified defaults

Functions

Name Description
create_bayes_linear_emulator Create a Bayes Linear emulator.
create_glm_emulator Create a GLM emulator.
create_gpr_emulator Create a GPR emulator.
create_linear_emulator Create a linear emulator.

create_bayes_linear_emulator

emulators.factory.create_bayes_linear_emulator(X, y, **kwargs)

Create a Bayes Linear emulator.

Parameters

Name Type Description Default
X pd.DataFrame Input data required
y pd.DataFrame Output data required
**kwargs Additional parameters (e.g. nugget) {}

Returns

Name Type Description
BaseEmulator BayesLinear emulator instance

create_glm_emulator

emulators.factory.create_glm_emulator(X, y, **kwargs)

Create a GLM emulator.

Parameters

Name Type Description Default
X pd.DataFrame Input data required
y pd.DataFrame Output data required
**kwargs Additional parameters {}

Returns

Name Type Description
BaseEmulator GLM emulator instance

create_gpr_emulator

emulators.factory.create_gpr_emulator(X, y, **kwargs)

Create a GPR emulator.

Parameters

Name Type Description Default
X pd.DataFrame Input data required
y pd.DataFrame Output data required
**kwargs Additional parameters {}

Returns

Name Type Description
BaseEmulator GPR emulator instance

create_linear_emulator

emulators.factory.create_linear_emulator(X, y, **kwargs)

Create a linear emulator.

Parameters

Name Type Description Default
X pd.DataFrame Input data required
y pd.DataFrame Output data required
**kwargs Additional parameters {}

Returns

Name Type Description
BaseEmulator Linear emulator instance