# Module: tfl.configs

<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/lattice/blob/v2.1.1/tensorflow_lattice/python/configs.py) |

TFL model configuration library for canned estimators.

To construct a TFL canned estimator, construct a model configuration and pass
it to the canned estimator constructor:

    feature_columns = ...
    model_config = tfl.configs.CalibratedLatticeConfig(...)
    feature_analysis_input_fn = create_input_fn(num_epochs=1, ...)
    train_input_fn = create_input_fn(num_epochs=100, ...)
    estimator = tfl.estimators.CannedClassifier(
        feature_columns=feature_columns,
        model_config=model_config,
        feature_analysis_input_fn=feature_analysis_input_fn)
    estimator.train(input_fn=train_input_fn)

#### Supported models are:

- **Calibrated linear model** : Constructed using
  [`tfl.configs.CalibratedLinearConfig`](https://www.tensorflow.org/lattice/api_docs/python/tfl/configs/CalibratedLinearConfig).
  A calibrated linear model that applies piecewise-linear and categorical
  calibration on the input feature, followed by a linear combination and an
  optional output piecewise-linear calibration. When using output calibration
  or when output bounds are specified, the linear layer will apply weighted
  averaging on calibrated inputs.

- **Calibrated lattice model** : Constructed using
  [`tfl.configs.CalibratedLatticeConfig`](https://www.tensorflow.org/lattice/api_docs/python/tfl/configs/CalibratedLatticeConfig).
  A calibrated lattice model applies piecewise-linear and categorical
  calibration on the input feature, followed by a lattice model and an
  optional output piecewise-linear calibration.

- **Calibrated lattice ensemble model** : Constructed using
  [`tfl.configs.CalibratedLatticeEnsembleConfig`](https://www.tensorflow.org/lattice/api_docs/python/tfl/configs/CalibratedLatticeEnsembleConfig).
  A calibrated lattice ensemble model applies piecewise-linear and categorical
  calibration on the input feature, followed by an ensemble of lattice models
  and an optional output piecewise-linear calibration.

Feature calibration and per-feature configurations are set using
[`tfl.configs.FeatureConfig`](https://www.tensorflow.org/lattice/api_docs/python/tfl/configs/FeatureConfig). Feature configurations include monotonicity
constraints, per-feature regularization (see [`tfl.configs.RegularizerConfig`](https://www.tensorflow.org/lattice/api_docs/python/tfl/configs/RegularizerConfig)),
and lattice sizes for lattice models.

## Classes

[`class AggregateFunctionConfig`](https://www.tensorflow.org/lattice/api_docs/python/tfl/configs/AggregateFunctionConfig): Config for aggregate function learning model.

[`class CalibratedLatticeConfig`](https://www.tensorflow.org/lattice/api_docs/python/tfl/configs/CalibratedLatticeConfig): Config for calibrated lattice model.

[`class CalibratedLatticeEnsembleConfig`](https://www.tensorflow.org/lattice/api_docs/python/tfl/configs/CalibratedLatticeEnsembleConfig): Config for calibrated lattice model.

[`class CalibratedLinearConfig`](https://www.tensorflow.org/lattice/api_docs/python/tfl/configs/CalibratedLinearConfig): Config for calibrated lattice model.

[`class DominanceConfig`](https://www.tensorflow.org/lattice/api_docs/python/tfl/configs/DominanceConfig): Configuration for dominance constraints in TFL canned estimators.

[`class FeatureConfig`](https://www.tensorflow.org/lattice/api_docs/python/tfl/configs/FeatureConfig): Per-feature configuration for TFL canned estimators.

[`class RegularizerConfig`](https://www.tensorflow.org/lattice/api_docs/python/tfl/configs/RegularizerConfig): Regularizer configuration for TFL canned estimators.

[`class TrustConfig`](https://www.tensorflow.org/lattice/api_docs/python/tfl/configs/TrustConfig): Configuration for feature trusts in TFL canned estimators.

## Functions

[`apply_updates(...)`](https://www.tensorflow.org/lattice/api_docs/python/tfl/configs/apply_updates): Updates a model config with the given set of (key, values) updates.

<br />

<br />

<br />

| ## Other Members ||
|---|---|
| absolute_import | Instance of `__future__._Feature` |
| division | Instance of `__future__._Feature` |
| print_function | Instance of `__future__._Feature` |

<br />