Skip to content

feature_config

pytorch_lattice.feature_config

Configuration objects for the PyTorch Lattice library.

FeatureConfig

A configuration object for a feature in a calibrated model.

This configuration object handles both numerical and categorical features. If the categeories attribute is None, then this feature will be handled as numerical. Otherwise, it will be handled as categorical.

Example: 

fc = FeatureConfig(name="feature_name").num_keypoints(10).monotonicity("increasing")

Attributes:

Name Type Description
name

The name of the feature.
Source code in pytorch_lattice/feature_config.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
class FeatureConfig:
    """A configuration object for a feature in a calibrated model.

    This configuration object handles both numerical and categorical features. If the
    `categeories` attribute is `None`, then this feature will be handled as numerical.
    Otherwise, it will be handled as categorical.

    Example:
    ```python
    fc = FeatureConfig(name="feature_name").num_keypoints(10).monotonicity("increasing")
    ```

    Attributes:
        name: The name of the feature.
    """

    def __init__(self, name: str):
        """Initializes an instance of `FeatureConfig` with default values."""
        self.name = name
        self._categories: Optional[list[str]] = None
        self._num_keypoints: int = 5
        self._input_keypoints_init: InputKeypointsInit = InputKeypointsInit.QUANTILES
        self._input_keypoints_type: InputKeypointsType = InputKeypointsType.FIXED
        self._monotonicity: Optional[Union[Monotonicity, list[tuple[str, str]]]] = None
        self._projection_iterations: int = 8
        self._lattice_size: int = 2  # only used in lattice models

    def categories(self, categories: list[str]) -> FeatureConfig:
        """Sets the categories for a categorical feature."""
        self._categories = categories
        return self

    def num_keypoints(self, num_keypoints: int) -> FeatureConfig:
        """Sets the categories for a categorical feature."""
        self._num_keypoints = num_keypoints
        return self

    def input_keypoints_init(
        self, input_keypoints_init: InputKeypointsInit
    ) -> FeatureConfig:
        """Sets the input keypoints initialization method for a numerical calibrator."""
        self._input_keypoints_init = input_keypoints_init
        return self

    def input_keypoints_type(
        self, input_keypoints_type: InputKeypointsType
    ) -> FeatureConfig:
        """Sets the input keypoints type for a numerical calibrator."""
        self._input_keypoints_type = input_keypoints_type
        return self

    def monotonicity(
        self, monotonicity: Optional[Union[Monotonicity, list[tuple[str, str]]]]
    ) -> FeatureConfig:
        """Sets the monotonicity constraint for a feature."""
        self._monotonicity = monotonicity
        return self

    def projection_iterations(self, projection_iterations: int) -> FeatureConfig:
        """Sets the number of projection iterations for a numerical calibrator."""
        self._projection_iterations = projection_iterations
        return self

    def lattice_size(self, lattice_size: int) -> FeatureConfig:
        """Sets the lattice size for a feature."""
        self._lattice_size = lattice_size
        return self

__init__(name)

Initializes an instance of FeatureConfig with default values.

Source code in pytorch_lattice/feature_config.py 
25
26
27
28
29
30
31
32
33
34
def __init__(self, name: str):
    """Initializes an instance of `FeatureConfig` with default values."""
    self.name = name
    self._categories: Optional[list[str]] = None
    self._num_keypoints: int = 5
    self._input_keypoints_init: InputKeypointsInit = InputKeypointsInit.QUANTILES
    self._input_keypoints_type: InputKeypointsType = InputKeypointsType.FIXED
    self._monotonicity: Optional[Union[Monotonicity, list[tuple[str, str]]]] = None
    self._projection_iterations: int = 8
    self._lattice_size: int = 2  # only used in lattice models

categories(categories)

Sets the categories for a categorical feature.

Source code in pytorch_lattice/feature_config.py 
36
37
38
39
def categories(self, categories: list[str]) -> FeatureConfig:
    """Sets the categories for a categorical feature."""
    self._categories = categories
    return self

input_keypoints_init(input_keypoints_init)

Sets the input keypoints initialization method for a numerical calibrator.

Source code in pytorch_lattice/feature_config.py 
46
47
48
49
50
51
def input_keypoints_init(
    self, input_keypoints_init: InputKeypointsInit
) -> FeatureConfig:
    """Sets the input keypoints initialization method for a numerical calibrator."""
    self._input_keypoints_init = input_keypoints_init
    return self

input_keypoints_type(input_keypoints_type)

Sets the input keypoints type for a numerical calibrator.

Source code in pytorch_lattice/feature_config.py 
53
54
55
56
57
58
def input_keypoints_type(
    self, input_keypoints_type: InputKeypointsType
) -> FeatureConfig:
    """Sets the input keypoints type for a numerical calibrator."""
    self._input_keypoints_type = input_keypoints_type
    return self

lattice_size(lattice_size)

Sets the lattice size for a feature.

Source code in pytorch_lattice/feature_config.py 
72
73
74
75
def lattice_size(self, lattice_size: int) -> FeatureConfig:
    """Sets the lattice size for a feature."""
    self._lattice_size = lattice_size
    return self

monotonicity(monotonicity)

Sets the monotonicity constraint for a feature.

Source code in pytorch_lattice/feature_config.py 
60
61
62
63
64
65
def monotonicity(
    self, monotonicity: Optional[Union[Monotonicity, list[tuple[str, str]]]]
) -> FeatureConfig:
    """Sets the monotonicity constraint for a feature."""
    self._monotonicity = monotonicity
    return self

num_keypoints(num_keypoints)

Sets the categories for a categorical feature.

Source code in pytorch_lattice/feature_config.py 
41
42
43
44
def num_keypoints(self, num_keypoints: int) -> FeatureConfig:
    """Sets the categories for a categorical feature."""
    self._num_keypoints = num_keypoints
    return self

projection_iterations(projection_iterations)

Sets the number of projection iterations for a numerical calibrator.

Source code in pytorch_lattice/feature_config.py 
67
68
69
70
def projection_iterations(self, projection_iterations: int) -> FeatureConfig:
    """Sets the number of projection iterations for a numerical calibrator."""
    self._projection_iterations = projection_iterations
    return self