TabNetHyperparameters
VariantTabNet neural network. See `setup_TabNet`.
Properties
batch_sizetunableintegerdefault1048576≥ 1Batch size.
penaltytunablenumberdefault0.001≥ 0Sparsity regularization penalty.
clip_valuenumber | number[] | nulldefaultnull≥ 1 itemsGradient clip value.
losstunablestringdefault"auto"Loss function. auto = set from outcome type.
epochstunableintegerdefault50≥ 1Number of training epochs.
drop_lasttunablebooleandefaultfalseDrop the last incomplete batch.
decision_widthinteger | integer[] | nulldefaultnull≥ 1≥ 1 itemsDecision prediction layer width.
attention_widthinteger | integer[] | nulldefaultnull≥ 1≥ 1 itemsAttention embedding width.
num_stepstunableintegerdefault3≥ 1Number of decision steps.
feature_reusagetunablenumberdefault1.3≥ 0Feature reusage coefficient.
mask_typetunablestringdefault"sparsemax"Masking function.
one of
"sparsemax""entmax"virtual_batch_sizetunableintegerdefault65536≥ 1Virtual batch size (ghost batch normalization).
valid_splittunablenumberdefault0≥ 0< 1Fraction of data used for (tabnet-internal) validation.
learn_ratetunablenumberdefault0.02> 0Learning rate.
lr_decaytunablenumberdefault0.1≥ 0≤ 1Learning rate decay.
step_sizetunableintegerdefault30≥ 1Learning rate scheduler step size.
checkpoint_epochstunableintegerdefault10≥ 1Checkpoint interval in epochs.
cat_emb_dimtunableintegerdefault1≥ 1Categorical embedding dimension.
num_independenttunableintegerdefault2≥ 1Number of independent GLU layers at each encoder step.
num_sharedtunableintegerdefault2≥ 1Number of shared GLU layers at each encoder step.
num_independent_decodertunableintegerdefault1≥ 1Number of independent GLU layers for pretraining.
num_shared_decodertunableintegerdefault1≥ 1Number of shared GLU layers for pretraining.
momentumtunablenumberdefault0.02≥ 0Momentum for batch normalization.
pretraining_ratiotunablenumberdefault0.5≥ 0≤ 1Ratio of features to mask during pretraining.
devicestringdefault"auto"Compute device.
one of
"auto""cpu""cuda"importance_sample_sizeinteger | integer[] | nulldefaultnull≥ 1≥ 1 itemsSample size for importance calculation.
early_stopping_monitortunablestringdefault"auto"Metric monitored for early stopping.
one of
"auto""valid_loss""train_loss"early_stopping_tolerancetunablenumberdefault0≥ 0Minimum relative improvement to reset the patience counter.
early_stopping_patiencetunableintegerdefault0≥ 0Number of epochs without improvement before stopping.
num_workersintegerdefault0≥ 0Number of subprocesses for data loading.
skip_importancebooleandefaultfalseSkip importance calculation.
ifwtunablebooleandefaultfalseInverse Frequency Weighting in classification.
optimizerstringdefault"adam"Optimizer name (e.g. "adam").
lr_schedulerstring | nullLearning-rate scheduler: "step" or "reduce_on_plateau". null = none.
one of
"step""reduce_on_plateau"
Relationships
Used by