TabularPredictor.model_hyperparameters

TabularPredictor.model_hyperparameters(model: str, include_ag_args_ensemble: bool = True, output_format: Literal['user', 'all'] = 'user') dict[source]

Returns the hyperparameters of a given model.

Parameters:
  • model (str) – The name of the model to get hyperparameters for.

  • include_ag_args_ensemble (bool, default True) – If True, includes the ag_args_ensemble parameters if they exist (for example, when bagging is enabled).

  • output_format ({"user", "all"}, default "user") – If “user”, returns the same hyperparameters specified by the user (only non-defaults). If “all”, returns all hyperparameters used by the model (including default hyperparameters not specified by the user) Regardless of the output_format, they both are functionally equivalent if passed to AutoGluon.

Returns:

model_hyperparameters – Dictionary of model hyperparameters. Equivalent to the model_hyperparameters specified by the user for this model in:

predictor.fit(…, hyperparameters={…, model_key: […, model_hyperparameters]})

Return type:

dict