PyCaret Official
Searchโ€ฆ
Initialize
Functions that initialize experiment in PyCaret

setup

This function initializes the experiment in PyCaret and creates the transformation pipeline based on all the parameters passed in the function. Setup function must be called before executing any other function. It takes two mandatory parameters: data and target. All the other parameters are optional.

Example

1
# load dataset
2
from pycaret.datasets import get_data
3
diabetes = get_data('diabetes')
4
โ€‹
5
# init setup
6
from pycaret.classification import *
7
clf1 = setup(data = diabetes, target = 'Class variable')
Copied!
As soon as you run the setup function, PyCaret will automatically infer the data types of all the variables in the dataset. If these are correctly inferred, you can press enter to continue.
Once you press enter to continue, you will see the output like this:
Output truncated for display
All the preprocessing and data transformations are configured within the setup function. There are many options to choose from, from data cleaning to feature engineering. To learn more about all the available Preprocessing, see this page.
NOTE: If you do not want to see the data type confirmation, you can pass silent=True in the setup to run it without any interruption.

Required Parameters

There are many parameters in the setup function but only two are non-optional.
  • data: pandas.DataFrame Shape (n_samples, n_features), where n_samples is the number of samples and n_features is the number of features.
  • target: str Name of the target column to be passed in as a string.
NOTE: target parameter is not required for unsupervised modules such as clustering, anomaly detection or NLP.

Default Transformations

All the preprocessing steps in setup are simply a flag of True or False . For example, if you want to scale your features, you will have to pass normalize=True in the setup function. However, there are three things that will happen by default:

Experiment Logging

PyCaret uses MLflow for experiment tracking. A parameter in the setup can be enabled to automatically track all the metrics, hyperparameters, and other important information about your machine learning model.

Example

1
# load dataset
2
from pycaret.datasets import get_data
3
data = get_data('diabetes')
4
โ€‹
5
# init setup
6
from pycaret.classification import *
7
clf1 = setup(data, target = 'Class variable', log_experiment = True, experiment_name = 'diabetes1')
8
โ€‹
9
# model training
10
best_model = compare_models()
Copied!
To initialize the MLflow server you must run the following command from within the notebook or from the command line. Once the server is initialized, you can track your experiment on https://localhost:5000.
1
# init server
2
!mlflow ui
Copied!
To learn more about experiment tracking in PyCaret, see this page.

Model Validation

There are quite a few parameters in the setup function that are not directly related to preprocessing or data transformation but they are used as part of model validation and selection strategy such as train_size, fold_strategy, or number of fold for cross-validation. To learn more about all the model validation and selection settings in the setup, see this page.

GPU Support

With PyCaret, you can train models on GPU and speed up your workflow by 10x. To train models on GPU simply pass use_gpu = True in the setup function. There is no change in the use of the API, however, in some cases, additional libraries have to be installed as they are not installed with the default version or the full version. To learn more about GPU support, see this page.

Examples

To see the use of the setup in other modules of PyCaret, see below:
NOTE: setup function uses global environment variables in Python. Therefore, if you run the setup function twice in the same script, it will overwrite the previous experiment. PyCaret next major release will include a new object-oriented API that will make it possible to create multiple instances through class instances.