emulators.factory
emulators.factory
Emulator factory with strategy pattern for history matching.
Classes
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
available_emulators
emulators.factory.EmulatorFactory.available_emulators()
Get list of available emulator types.
Returns
|
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
| 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 |
{} |
create_emulator
emulators.factory.EmulatorFactory.create_emulator(
X,
y,
emulator_type=None,
**kwargs,
)
Create a single emulator instance.
Parameters
| 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 |
{} |
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
| 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 |
{} |
Raises
|
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
| emulator_type |
str |
Name of the emulator type |
required |
register_emulator
emulators.factory.EmulatorFactory.register_emulator(name, emulator_class)
Register a custom emulator type.
Parameters
| name |
str |
Name to register the emulator under |
required |
| emulator_class |
Type[BaseEmulator] |
BaseEmulator subclass to register |
required |
Raises
|
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
| emulator_type |
str |
New default emulator type |
required |
with_defaults
emulators.factory.EmulatorFactory.with_defaults(**kwargs)
Create new factory with updated default parameters.
Parameters
| **kwargs |
|
Parameters to update in 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
| default_type |
str |
Default emulator type |
'bayes_linear' |
| **default_kwargs |
|
Default parameters |
{} |
Functions
create_bayes_linear_emulator
emulators.factory.create_bayes_linear_emulator(X, y, **kwargs)
Create a Bayes Linear emulator.
Parameters
| X |
pd.DataFrame |
Input data |
required |
| y |
pd.DataFrame |
Output data |
required |
| **kwargs |
|
Additional parameters (e.g. nugget) |
{} |
create_glm_emulator
emulators.factory.create_glm_emulator(X, y, **kwargs)
Create a GLM emulator.
create_gpr_emulator
emulators.factory.create_gpr_emulator(X, y, **kwargs)
Create a GPR emulator.
create_linear_emulator
emulators.factory.create_linear_emulator(X, y, **kwargs)
Create a linear emulator.