@File : autoencoders.py @Time : 2024/05/28 10:06:48 @Author : Alejandro Marrero @Version : 1.0 @Contact : amarrerd@ull.edu.es @License : (C)Copyright 2024, Alejandro Marrero @Desc : None

KPDecoder

Bases: Transformer

Source code in digneapy/transformers/autoencoders.py
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
class KPDecoder(Transformer):
    def __init__(self, scale_method: str = "learnt"):
        super().__init__("KPDecoder")
        if scale_method not in ("learnt", "sample"):
            raise ValueError(
                "KPDecoder expects the scale method to be either learnt or sample"
            )
        self._scale_method = scale_method
        self.__scales_fname = "scales_knapsack_N_50.h5"
        self._expected_latent_dim = 2
        self._decoder = torch.load(
            MODELS_PATH / AUTOENCODER_NAME,
            map_location=torch.device(DEVICE),
            weights_only=False,
        )
        with h5py.File(MODELS_PATH / self.__scales_fname, "r") as file:
            self._max_weights = file["scales"]["max_weights"][:].astype(np.int32)
            self._max_profits = file["scales"]["max_profits"][:].astype(np.int32)
            self._sum_of_weights = file["scales"]["sum_of_weights"][:].astype(np.int32)
        if self._scale_method == "sample":
            self._weights_fitted_dist = lognorm.fit(self._max_weights, floc=0)
            self._profits_fitted_dist = lognorm.fit(self._max_profits, floc=0)
            self._capacity_fitted_dist = lognorm.fit(self._sum_of_weights, floc=0)

    @property
    def output_dimension(self) -> int:
        return 101

    def __sample_scaling_factors(self, size: int) -> Tuple[Any, Any, Any]:
        return (
            lognorm.rvs(
                self._weights_fitted_dist[0],
                loc=self._weights_fitted_dist[1],
                scale=self._weights_fitted_dist[2],
                size=size,
            )[:, None],
            lognorm.rvs(
                self._profits_fitted_dist[0],
                loc=self._profits_fitted_dist[1],
                scale=self._profits_fitted_dist[2],
                size=size,
            )[:, None],
            lognorm.rvs(
                self._capacity_fitted_dist[0],
                loc=self._capacity_fitted_dist[1],
                scale=self._capacity_fitted_dist[2],
                size=size,
            )[:, None],
        )

    def __scaling_from_training(
        self, size: int
    ) -> Tuple[np.ndarray, np.ndarray, np.ndarray]:
        indexes = np.random.randint(low=0, high=len(self._max_weights), size=size)
        return (
            self._max_weights[indexes],
            self._max_profits[indexes],
            self._sum_of_weights[indexes],
        )

    def __denormalise_instances(self, decode_X: np.ndarray) -> np.ndarray:
        n_instances = decode_X.shape[0]
        if self._scale_method == "sample":
            max_w, max_p, scale_Q = self.__sample_scaling_factors(size=n_instances)
        else:
            max_w, max_p, scale_Q = self.__scaling_from_training(size=n_instances)

        rescaled_instances = np.zeros_like(decode_X, dtype=np.int32)
        rescaled_instances[:, 0] = decode_X[:, 0] * scale_Q[:, 0]  # * 1_000_000
        rescaled_instances[:, 1::2] = decode_X[:, 1::2] * max_w  # * 100_000
        rescaled_instances[:, 2::2] = decode_X[:, 2::2] * max_p  # * 100_000
        return rescaled_instances

    def __call__(self, X: npt.NDArray) -> np.ndarray:
        """Decodes an np.ndarray of shape (M, 2) into KP instances of N = 50.
        It does not return Knapsack objects but a np.ndarray of shape (M, 101)
        where 101 corresponds to the capacity (Q) and 50 pairs of weights and profits(w_i, p_i)

        Args:
            X (npt.NDArray): an np.ndarray of shape (M, 2)

        Raises:
            ValueError: If X has a difference shape than (M, 2)

        Returns:
            np.ndarray: numpy array with |M| KP definitions
        """
        if not isinstance(X, np.ndarray):
            X = np.asarray(X)
        if X.shape[1] != self._expected_latent_dim:
            raise ValueError(
                f"Expected a np.ndarray with shape (M, {self._expected_latent_dim}). Instead got: {X.shape}"
            )
        y = (
            self._decoder
            .decode(torch.tensor(X, device=DEVICE, dtype=torch.float32))
            .cpu()
            .detach()
            .numpy()
        )
        return self.__denormalise_instances(y)

__call__(X)

Decodes an np.ndarray of shape (M, 2) into KP instances of N = 50. It does not return Knapsack objects but a np.ndarray of shape (M, 101) where 101 corresponds to the capacity (Q) and 50 pairs of weights and profits(w_i, p_i)

Parameters:
  • X (NDArray) –

    an np.ndarray of shape (M, 2)

Raises:
  • ValueError

    If X has a difference shape than (M, 2)

Returns:
  • ndarray

    np.ndarray: numpy array with |M| KP definitions

Source code in digneapy/transformers/autoencoders.py
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
def __call__(self, X: npt.NDArray) -> np.ndarray:
    """Decodes an np.ndarray of shape (M, 2) into KP instances of N = 50.
    It does not return Knapsack objects but a np.ndarray of shape (M, 101)
    where 101 corresponds to the capacity (Q) and 50 pairs of weights and profits(w_i, p_i)

    Args:
        X (npt.NDArray): an np.ndarray of shape (M, 2)

    Raises:
        ValueError: If X has a difference shape than (M, 2)

    Returns:
        np.ndarray: numpy array with |M| KP definitions
    """
    if not isinstance(X, np.ndarray):
        X = np.asarray(X)
    if X.shape[1] != self._expected_latent_dim:
        raise ValueError(
            f"Expected a np.ndarray with shape (M, {self._expected_latent_dim}). Instead got: {X.shape}"
        )
    y = (
        self._decoder
        .decode(torch.tensor(X, device=DEVICE, dtype=torch.float32))
        .cpu()
        .detach()
        .numpy()
    )
    return self.__denormalise_instances(y)

KPEncoder

Bases: Transformer

Source code in digneapy/transformers/autoencoders.py
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
class KPEncoder(Transformer):
    def __init__(self):
        super().__init__("KPEncoder")

        self._expected_input_dim = 101
        self._encoder = torch.load(
            MODELS_PATH / AUTOENCODER_NAME,
            map_location=torch.device(DEVICE),
            weights_only=False,
        )

    @property
    def latent_dimension(self) -> int:
        return 2

    @property
    def expected_input_dim(self) -> int:
        return self._expected_input_dim

    def train(self, x: np.ndarray | list[IndType]):
        raise NotImplementedError("train method not implemented in KPEncoder")

    def predict(self, x: np.ndarray | list[IndType]) -> np.ndarray:
        return self.__call__(x)

    def save(self):
        raise NotImplementedError("save method not implemented in KPEncoder")

    def __call__(self, x: np.ndarray | list[IndType]) -> np.ndarray:
        """Encodes a numpy array of 50d-KP instances into 2D encodings.

        Args:
            X (npt.NDArray): A numpy array with the definitions of the KP instances. Expected to be of shape (M, 101).

        Raises:
            ValueError: If the shape of X does not match (M, 101)

        Returns:
            np.ndarray: _description_
        """
        if not isinstance(x, np.ndarray):
            x = np.asarray(x)
        if x.shape[1] != self._expected_input_dim:
            raise ValueError(
                f"Expected a np.ndarray with shape (M, {self._expected_input_dim}). Instead got: {x.shape}"
            )
        codings_means, codings_log_var = self._encoder.encode(
            torch.tensor(x, device=DEVICE, dtype=torch.float32)
        )
        codings = self._encoder.sample_codings(codings_means, codings_log_var)
        # Mean and Logarithm of the variance
        return codings.cpu().detach().numpy()

__call__(x)

Encodes a numpy array of 50d-KP instances into 2D encodings.

Parameters:
  • X (NDArray) –

    A numpy array with the definitions of the KP instances. Expected to be of shape (M, 101).

Raises:
  • ValueError

    If the shape of X does not match (M, 101)

Returns:
  • ndarray

    np.ndarray: description

Source code in digneapy/transformers/autoencoders.py
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
def __call__(self, x: np.ndarray | list[IndType]) -> np.ndarray:
    """Encodes a numpy array of 50d-KP instances into 2D encodings.

    Args:
        X (npt.NDArray): A numpy array with the definitions of the KP instances. Expected to be of shape (M, 101).

    Raises:
        ValueError: If the shape of X does not match (M, 101)

    Returns:
        np.ndarray: _description_
    """
    if not isinstance(x, np.ndarray):
        x = np.asarray(x)
    if x.shape[1] != self._expected_input_dim:
        raise ValueError(
            f"Expected a np.ndarray with shape (M, {self._expected_input_dim}). Instead got: {x.shape}"
        )
    codings_means, codings_log_var = self._encoder.encode(
        torch.tensor(x, device=DEVICE, dtype=torch.float32)
    )
    codings = self._encoder.sample_codings(codings_means, codings_log_var)
    # Mean and Logarithm of the variance
    return codings.cpu().detach().numpy()