pycfast.datasets.load_sp_ast_diesel_1p1

pycfast.datasets.load_sp_ast_diesel_1p1(*, return_X_y=False, as_frame=True)

Load the SP_AST_Diesel_1p1 pre-computed dataset.

Returns 5000 CFAST simulation results based on the SP_AST_Diesel_1p1.in validation model, mapping fire parameters (heat of combustion, radiative fraction, soot yield, target height) to maximum target surface temperature (TRGSURT).

Parameters:

• return_X_y (bool, default=False) – If True, return (X, y) instead of a single DataFrame. X contains the 4 input features and y the target.

• as_frame (bool, default=True) – If True (default), return pandas objects. If False, return numpy arrays (only effective when return_X_y=True).

Returns:

data –

• If return_X_y=False: a DataFrame with all columns. Access data.attrs["DESCR"] for a human-readable description.

• If return_X_y=True and as_frame=True: (X, y) as (pd.DataFrame, pd.Series).

• If return_X_y=True and as_frame=False: (X, y) as (np.ndarray, np.ndarray).

Return type:

pd.DataFrame or tuple

Examples

>>> from pycfast.datasets import load_sp_ast_diesel_1p1
>>> df = load_sp_ast_diesel_1p1()
>>> df.shape
(5000, 5)

>>> X, y = load_sp_ast_diesel_1p1(return_X_y=True)
>>> X.shape
(5000, 4)