ise.models.ISEFlow package

Submodules

class ise.models.ISEFlow.ISEFlow.ISEFlow(deep_ensemble, normalizing_flow)[source]

Bases: Module

The ISEFlow (Flow-based Ice Sheet Emulator) that combines a deep ensemble and a normalizing flow model.

fit(X, y, nf_epochs, de_epochs, batch_size=64, X_val=None, y_val=None, save_checkpoints=True, checkpoint_path='checkpoint_ensemble', early_stopping=True, sequence_length=5, patience=10, verbose=True)[source]: Fits the hybrid emulator to the training data.

forward(x, smooth_projection=False)[source]: Performs a forward pass through the hybrid emulator.

static load(model_dir=None, deep_ensemble_path=None, normalizing_flow_path=None)[source]: Loads a trained model from the specified paths.

save(save_dir, input_features=None, output_scaler_path=None)[source]: Saves the trained model to the specified directory.

class ise.models.ISEFlow.ISEFlow.ISEFlow_AIS[source]

static load(version='v1.0.0', model_dir=None, deep_ensemble_path=None, normalizing_flow_path=None)[source]: Loads a trained model from the specified paths.

predict(year: array, pr_anomaly: array, evspsbl_anomaly: array, mrro_anomaly: array, smb_anomaly: array, ts_anomaly: array, ocean_thermal_forcing: array, ocean_salinity: array, ocean_temperature: array, initial_year: int, numerics: str, stress_balance: str, resolution: int, init_method: str, melt_in_floating_cells: str, icefront_migration: str, ocean_forcing_type: str, ocean_sensitivity: str, ice_shelf_fracture: bool, open_melt_type: str | None = None, standard_melt_type: str | None = None)[source]

process(year: array, pr_anomaly: array, evspsbl_anomaly: array, mrro_anomaly: array, smb_anomaly: array, ts_anomaly: array, ocean_thermal_forcing: array, ocean_salinity: array, ocean_temperature: array, initial_year: int, numerics: str, stress_balance: str, resolution: int, init_method: str, melt_in_floating_cells: str, icefront_migration: str, ocean_forcing_type: str, ocean_sensitivity: str, ice_shelf_fracture: bool, open_melt_type: str | None = None, standard_melt_type: str | None = None)[source]

class ise.models.ISEFlow.ISEFlow.ISEFlow_GrIS[source]

static load(version='v1.0.0', model_dir=None, deep_ensemble_path=None, normalizing_flow_path=None)[source]: Loads a trained model from the specified paths.

class ise.models.ISEFlow.de.ISEFlow_AIS_DE[source]: Bases: DeepEnsemble

class ise.models.ISEFlow.de.ISEFlow_GrIS_DE[source]: Bases: DeepEnsemble

class ise.models.ISEFlow.nf.ISEFlow_AIS_NF[source]: Bases: NormalizingFlow

class ise.models.ISEFlow.nf.ISEFlow_GrIS_NF[source]: Bases: NormalizingFlow