continuous
ClusterContinuousTransformer
Bases: ColumnTransformer
A transformer to cluster continuous features via sklearn's BayesianGaussianMixture.
Essentially wraps the process of fitting the BGM model and generating cluster assignments and normalised values for the data to comply with the ColumnTransformer interface.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
n_components
|
int
|
The number of components to use in the BGM model. |
10
|
n_init
|
int
|
The number of initialisations to use in the BGM model. |
10
|
init_params
|
str
|
The initialisation method to use in the BGM model. |
'kmeans'
|
random_state
|
int
|
The random state to use in the BGM model. |
0
|
max_iter
|
int
|
The maximum number of iterations to use in the BGM model. |
1000
|
remove_unused_components
|
bool
|
Whether to remove components that have no data assigned EXPERIMENTAL. |
False
|
clip_output
|
bool
|
Whether to clip the output normalised values to the range [-1, 1]. |
False
|
After applying the transformer, the following attributes will be populated:
Attributes:
| Name | Type | Description |
|---|---|---|
means |
The means of the components in the BGM model. |
|
stds |
The standard deviations of the components in the BGM model. |
|
new_column_names |
The names of the columns generated by the transformer (one for the normalised values and one for each cluster component). |
Source code in src/nhssynth/modules/dataloader/transformers/continuous.py
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 76 77 78 79 80 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 133 134 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 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 | |
apply(data, constraint_adherence, missingness_column=None)
Apply the transformation to a given data column using the BayesianGaussianMixture model from scikit-learn.
This method transforms the input data (data) by fitting a BayesianGaussianMixture model to the data, and normalizes the values based on the
learned parameters. Additionally, it handles missing data by utilizing the provided missingness_column and constraint_adherence to determine
which rows should be included in the transformation. The resulting transformed data consists of the normalized values, along with component
probabilities, and a final adherence column indicating whether the data satisfies the constraints.
If the missingness_column is provided, missing values are handled by assigning them to a new pseudo-cluster with a mean of 0, ensuring that
missing data does not affect the transformation process. Missing values are filled with zeros, and the column names are updated accordingly.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data
|
Series
|
The input column of data to be transformed. This column is used to fit the |
required |
constraint_adherence
|
Optional[Series]
|
A series indicating whether each row satisfies the user-defined constraints. Only rows where
the value in |
required |
missingness_column
|
Optional[Series]
|
A series indicating missing values. If provided, missing values will be assigned to a pseudo-cluster with mean 0. The missing values are handled separately to ensure that they don't interfere with the transformation. |
None
|
Returns:
| Type | Description |
|---|---|
DataFrame
|
pd.DataFrame: A DataFrame containing the transformed data with the following columns:
- |
Notes
- The method uses the
fitandpredict_probamethods ofBayesianGaussianMixtureto fit the model and calculate component probabilities. - If the
missingness_columnis provided, rows with missing values will be handled separately by assigning them to a pseudo-cluster with mean 0. - The transformed data will only include rows where the corresponding value in
constraint_adherenceis 1. - If
self.remove_unused_componentsis set toTrue, any components that do not have any data assigned to them will be removed from the result. - The final output DataFrame will have integer types for the component columns and will fill missing values with 0 where necessary.
Source code in src/nhssynth/modules/dataloader/transformers/continuous.py
77 78 79 80 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 133 134 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 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 | |
revert(data)
Decode continuous feature from mixture-normalised form and return the full DataFrame (DataFrame in -> DataFrame out).
Source code in src/nhssynth/modules/dataloader/transformers/continuous.py
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 | |