data_config_parser ¶
Module for parsing data configs.
Functions:
-
create_encoders
–Factory for creating encoders from config.
-
create_splitter
–Factory for creating splitters from config.
-
create_transforms
–Factory for creating transforms from config.
-
expand_transform_list_combinations
–Expands a list of transforms into all possible parameter combinations.
-
expand_transform_parameter_combinations
–Get all possible transforms by extracting parameters at each valid index.
-
extract_transform_parameters_at_index
–Get a transform with parameters at the specified index.
-
generate_encoding_config
–Generate encoding-only configuration from a master config.
-
generate_individual_split_configs
–Generate individual split configurations from a master config.
-
generate_individual_transform_configs
–Generate individual transform configurations from a master config.
-
parse_encoding_config
–Parse encoding-only configuration.
-
parse_individual_split_config
–Parse individual split configuration.
-
parse_individual_transform_config
–Parse individual transform configuration.
-
parse_split_transform_config
–Parse the configuration and return a dictionary of the parsed configuration.
-
split_config_into_components
–Split a master config into separate component configs and save them.
create_encoders ¶
create_encoders(
column_config: list[Columns],
) -> dict[str, AbstractEncoder]
Factory for creating encoders from config.
Source code in src/stimulus/data/interface/data_config_parser.py
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 |
|
create_splitter ¶
create_splitter(split_config: Split) -> AbstractSplitter
Factory for creating splitters from config.
Source code in src/stimulus/data/interface/data_config_parser.py
180 181 182 183 184 185 186 |
|
create_transforms ¶
Factory for creating transforms from config.
Parameters:
Returns:
Source code in src/stimulus/data/interface/data_config_parser.py
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 |
|
expand_transform_list_combinations ¶
Expands a list of transforms into all possible parameter combinations.
Takes a list of transforms where each transform may contain parameter lists, and expands them into separate transforms with single parameter values. For example, if a transform has parameters [0.1, 0.2] and [1, 2], this will create two transforms: one with 0.1/1 and another with 0.2/2.
Parameters:
-
transform_list
(list[Transform]
) –A list of YamlTransform objects containing parameter lists that need to be expanded into individual transforms.
Returns:
-
list[Transform]
–list[YamlTransform]: A flattened list of transforms where each transform has single parameter values instead of parameter lists. The length of the returned list will be the sum of the number of parameter combinations for each input transform.
Source code in src/stimulus/data/interface/data_config_parser.py
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 |
|
expand_transform_parameter_combinations ¶
Get all possible transforms by extracting parameters at each valid index.
For a transform with parameter lists, creates multiple new transforms, each containing single parameter values from the corresponding indices of the parameter lists.
Parameters:
-
transform
(Transform
) –The original transform containing parameter lists
Returns:
Source code in src/stimulus/data/interface/data_config_parser.py
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 |
|
extract_transform_parameters_at_index ¶
Get a transform with parameters at the specified index.
Parameters:
-
transform
(Transform
) –The original transform containing parameter lists
-
index
(int
, default:0
) –Index to extract parameters from (default 0)
Returns:
-
Transform
–A new transform with single parameter values at the specified index
Source code in src/stimulus/data/interface/data_config_parser.py
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 |
|
generate_encoding_config ¶
generate_encoding_config(
config: ConfigDict,
) -> EncodingConfigDict
Generate encoding-only configuration from a master config.
Parameters:
-
config
(ConfigDict
) –The master configuration containing all components.
Returns:
-
EncodingConfigDict
–EncodingConfigDict containing only global_params and columns.
Source code in src/stimulus/data/interface/data_config_parser.py
371 372 373 374 375 376 377 378 379 380 381 382 383 |
|
generate_individual_split_configs ¶
generate_individual_split_configs(
config: ConfigDict,
) -> list[IndividualSplitConfigDict]
Generate individual split configurations from a master config.
Parameters:
-
config
(ConfigDict
) –The master configuration containing multiple splits.
Returns:
-
list[IndividualSplitConfigDict]
–List of IndividualSplitConfigDict, one for each split in the master config.
Source code in src/stimulus/data/interface/data_config_parser.py
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 |
|
generate_individual_transform_configs ¶
generate_individual_transform_configs(
config: ConfigDict,
) -> list[IndividualTransformConfigDict]
Generate individual transform configurations from a master config.
Expands parameter lists within transforms to create separate configs for each parameter combination.
Parameters:
-
config
(ConfigDict
) –The master configuration containing transforms with parameter lists.
Returns:
-
list[IndividualTransformConfigDict]
–List of IndividualTransformConfigDict, one for each expanded transform.
Source code in src/stimulus/data/interface/data_config_parser.py
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 |
|
parse_encoding_config ¶
parse_encoding_config(
config: EncodingConfigDict,
) -> tuple[
dict[str, AbstractEncoder],
list[str],
list[str],
list[str],
]
Parse encoding-only configuration.
Parameters:
-
config
(EncodingConfigDict
) –The encoding configuration to parse.
Returns:
-
tuple[dict[str, AbstractEncoder], list[str], list[str], list[str]]
–A tuple of encoders and column lists.
Source code in src/stimulus/data/interface/data_config_parser.py
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
parse_individual_split_config ¶
parse_individual_split_config(
config: IndividualSplitConfigDict,
) -> tuple[AbstractSplitter, list[str]]
Parse individual split configuration.
Parameters:
-
config
(IndividualSplitConfigDict
) –The individual split configuration to parse.
Returns:
-
tuple[AbstractSplitter, list[str]]
–A tuple containing the splitter instance and split input columns.
Source code in src/stimulus/data/interface/data_config_parser.py
249 250 251 252 253 254 255 256 257 258 259 260 |
|
parse_individual_transform_config ¶
parse_individual_transform_config(
config: IndividualTransformConfigDict,
) -> dict[str, list[Any]]
Parse individual transform configuration.
Parameters:
-
config
(IndividualTransformConfigDict
) –The individual transform configuration to parse.
Returns:
Source code in src/stimulus/data/interface/data_config_parser.py
237 238 239 240 241 242 243 244 245 246 |
|
parse_split_transform_config ¶
parse_split_transform_config(
config: SplitTransformDict,
) -> tuple[
dict[str, AbstractEncoder],
list[str],
list[str],
list[str],
]
Parse the configuration and return a dictionary of the parsed configuration.
Parameters:
-
config
(SplitTransformDict
) –The configuration to parse.
Returns:
-
tuple[dict[str, AbstractEncoder], list[str], list[str], list[str]]
–A tuple of the parsed configuration.
Source code in src/stimulus/data/interface/data_config_parser.py
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 |
|
split_config_into_components ¶
split_config_into_components(
config: ConfigDict,
output_dir: str,
base_name: str = "config",
) -> None
Split a master config into separate component configs and save them.
Parameters:
-
config
(ConfigDict
) –The master configuration to split.
-
output_dir
(str
) –Directory to save the component configs.
-
base_name
(str
, default:'config'
) –Base name for generated files (default: "config").
Source code in src/stimulus/data/interface/data_config_parser.py
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 |
|