pycaret.time_series.TSForecastingExperiment

class pycaret.time_series.TSForecastingExperiment

__init__() → None

Methods

__init__()
add_metric(id, name, score_func[, ...])	Adds a custom metric to be used for CV.
automl([optimize, use_holdout, turbo, ...])	This function returns the best model out of all models created in current active environment based on metric defined in optimize parameter.
blend_models(estimator_list[, method, fold, ...])	This function trains a EnsembleForecaster for select models passed in the estimator_list param.
check_drift([reference_data, current_data, ...])	This function generates a drift report file using the evidently library.
check_fairness(estimator, sensitive_features)	There are many approaches to conceptualizing fairness.
check_stats([estimator, test, alpha, split, ...])	This function is used to get summary statistics and run statistical tests on the original data or model residuals.
compare_models([include, exclude, fold, ...])	This function trains and evaluates performance of all estimators available in the model library using cross validation.
convert_model(estimator[, language])	This function transpiles trained machine learning models into native inference script in different programming languages (Python, C, Java, Go, JavaScript, Visual Basic, C#, PowerShell, R, PHP, Dart, Haskell, Ruby, F#).
create_api(estimator, api_name[, host, port])	This function takes an input estimator and creates a POST API for inference.
create_app(estimator, app_kwargs)	This function creates a basic gradio app for inference.
create_docker(api_name[, base_image, ...])	This function creates a Dockerfile and requirements.txt for productionalizing API end-point.
create_model(estimator[, fold, round, ...])	This function trains and evaluates the performance of a given estimator using cross validation.
dashboard(estimator[, display_format, ...])	This function generates the interactive dashboard for a trained model.
deploy_model(model, model_name, authentication)	This function deploys the transformation pipeline and trained model on cloud.
ensemble_model(estimator[, method, fold, ...])	This function ensembles the trained base estimator using the method defined in 'method' parameter (default = 'Bagging').
evaluate_model(estimator[, fold, ...])	This function displays a user interface for all of the available plots for a given estimator.
finalize_model(estimator[, fit_kwargs, ...])	This function trains a given estimator on the entire dataset including the holdout set.
get_additional_scorer_kwargs()	Returns additional kwargs required by some scorers (such as MASE).
get_allowed_engines(estimator)	Get all the allowed engines for the specified estimator
get_config([variable])	This function is used to access global environment variables.
get_engine(estimator)	Gets the model engine currently set in the experiment for the specified model.
get_fold_generator([fold, fold_strategy])	Returns the cv object based on number of folds and fold_strategy
get_insample_predictions(estimator)	Returns the insample predictions for the estimator by appropriately taking the entire pipeline into consideration.
get_leaderboard([finalize_models, ...])	generates leaderboard for all models run in current run.
get_logs([experiment_name, save])	Returns a table of experiment logs.
get_metrics([reset, include_custom, ...])	Returns table of available metrics used for CV.
get_residuals(estimator)	_summary_
interpret_model(estimator[, plot, feature, ...])	This function takes a trained model object and returns an interpretation plot based on the test / hold-out set.
load_experiment(path_or_file[, data, ...])	Load an experiment saved with save_experiment from path or file.
load_model(model_name[, platform, ...])	This function loads a previously saved pipeline/model.
models([type, internal, raise_errors])	Returns table of models available in the model library.
plot_model([estimator, plot, return_fig, ...])	This function analyzes the performance of a trained model on holdout set.
plot_model_check_display_format_(display_format)	Checks if the display format is in the allowed list.
predict_model(estimator[, fh, X, ...])	This function forecast using a trained model.
pull([pop])	Returns the latest displayed table.
remove_metric(name_or_id)	Removes a metric from CV.
save_experiment(path_or_file, ...)	Saves the experiment to a pickle file.
save_model(model, model_name[, model_only, ...])	This function saves the transformation pipeline and trained model object into the current working directory as a pickle file for later use.
set_config([variable, value])	This function is used to reset global environment variables.
setup([data, data_func, target, index, ...])	This function initializes the training environment and creates the transformation pipeline.
stack_models(estimator_list[, meta_model, ...])	This function trains a meta model and scores it using Cross Validation.
tune_model(estimator[, fold, round, n_iter, ...])	This function tunes the hyperparameters of a given estimator.
update_fit_kwargs_with_fh_from_cv(fit_kwargs, cv)	Updated the fit_ kwargs to include the fh parameter from cv

Attributes

X	Feature set.
X_test	Feature set of the test set.
X_test_transformed	Transformed feature set of the test set.
X_train	Feature set of the training set.
X_train_transformed	Transformed feature set of the training set.
X_transformed	Transformed feature set.
dataset	Complete dataset without ignored columns.
dataset_transformed	Transformed dataset.
gpu_n_jobs_param
is_multiclass	Method to check if the problem is multiclass.
test	Test set.
test_transformed	Transformed test set.
train	Training set.
train_transformed	Transformed training set.
variable_and_property_keys
variables
y	Target column.
y_test	Target column of the test set.
y_test_transformed	Transformed target column of the test set.
y_train	Target column of the training set.
y_train_transformed	Transformed target column of the training set.
y_transformed	Transformed target column.