Ekkono
edgemark.models.platforms.Ekkono.model_generator
main
main(cfg_path=config_file_path, **kwargs)
Generate, train, evaluate, and save models based on the given configuration file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cfg_path
|
str
|
The path to the configuration file containing the model generation parameters. The configuration file that this path points to should contain the following keys: - time_tag (str): A placeholder for the time tag. This will be populated by the current time. - linkers_dir (str): Path to the directory where the generated models list will be saved. - target_models_dir (str): Path to the directory containing the target models configurations. - datasets_dir (str): Path to the directory containing the datasets. - model_save_dir (str): Path to the directory where the generated model will be saved. - crystal_templates_dir (str): Path to the directory containing the crystal templates. - wandb_online (bool): Flag to enable or disable the W&B online mode. - wandb_project_name (str): Name of the W&B project. - train_models (bool): Flag to enable or disable model training. - evaluate_models (bool): Flag to enable or disable model evaluation. - measure_execution_time (bool): Flag to enable or disable the measurement of execution time. - n_eqcheck_data (int): Number of samples to be saved for equivalence check of the model on PC and MCU. |
config_file_path
|
**kwargs
|
dict
|
Keyword arguments to be passed to the configuration file. |
{}
|
Returns:
| Type | Description |
|---|---|
list
|
A list of dictionaries containing the following keys for each target model: - name (str): Name of the target model configuration file. - result (str): Result of the model generation. It can be either "success" or "failed". - error (str): Error message in case of failure. - traceback (str): Traceback in case of failure. |
Source code in edgemark/models/platforms/Ekkono/model_generator.py
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 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 | |
edgemark.models.platforms.Ekkono.model
ModelSupervisor
Source code in edgemark/models/platforms/Ekkono/model.py
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 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 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 | |
__init__
__init__(cfg=None)
Initializes the class. The following attributes should be set in the init function: self.model (ekkono.primer.Model): The model. self.dataset (DatasetSupervisorTemplate): The dataset.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cfg
|
dict
|
The configuration of the model. Defaults to None. |
None
|
Source code in edgemark/models/platforms/Ekkono/model.py
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 | |
create_incremental_model
staticmethod
create_incremental_model(denses_params, activation, epochs, batch_size, learning_rate, trainset, target_name)
Creates the Ekkono incremental model. The model is able to be trained on the end device.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
denses_params
|
list
|
Each element is the number of neurons of a dense layer (excluding the output layer which has one neuron). |
required |
activation
|
str
|
The activation function of the hidden layers. Can be one of "sigmoid", "tanh", "relu" (which actually is leaky relu). |
required |
epochs
|
int
|
The number of epochs for training. |
required |
batch_size
|
int
|
The batch size for training. |
required |
learning_rate
|
float
|
The learning rate for training. |
required |
trainset
|
DatasetSupervisorTemplate
|
The training dataset. |
required |
target_name
|
str
|
The name of the target attribute. |
required |
Source code in edgemark/models/platforms/Ekkono/model.py
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 | |
create_pretrained_model
staticmethod
create_pretrained_model(denses_params, activation, learning_rate, pipeline_template, target_name)
Creates the Ekkono pretrained model. The model is not able to be trained on the end device.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
denses_params
|
list
|
Each element is the number of neurons of a dense layer (excluding the output layer which has one neuron). |
required |
activation
|
str
|
The activation function of the hidden layers. Can be one of "sigmoid", "tanh", "relu" (which actually is leaky relu). |
required |
pipeline_template
|
PipelineTemplate
|
The pipeline template (usually taken from dataset). |
required |
target_name
|
str
|
The name of the target attribute. |
required |
Source code in edgemark/models/platforms/Ekkono/model.py
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 | |
evaluate_model
evaluate_model()
Evaluates the model.
Returns:
| Type | Description |
|---|---|
dict
|
The evaluation metrics. |
Source code in edgemark/models/platforms/Ekkono/model.py
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 | |
fill_crystal_templates
fill_crystal_templates(save_dir, eqcheck_data_dir, templates_dir)
Taken from the main.h/c and data.h/c available in the templates_dir, fills their placeholders with the appropriate data and saves them to the save_dir.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
save_dir
|
str
|
The directory where the filled files should be saved. |
required |
eqcheck_data_dir
|
str
|
The directory where the eqcheck data is stored. |
required |
templates_dir
|
str
|
The directory where the templates are stored. |
required |
Source code in edgemark/models/platforms/Ekkono/model.py
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 | |
get_model_info
get_model_info()
Returns the model info.
Returns:
| Type | Description |
|---|---|
dict
|
The model info. |
Source code in edgemark/models/platforms/Ekkono/model.py
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 | |
load_eqcheck_data
staticmethod
load_eqcheck_data(load_dir)
Loads the eqcheck data.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
load_dir
|
str
|
The directory where the eqcheck data is stored. |
required |
Returns:
| Type | Description |
|---|---|
tuple
|
(data_x, data_y_pred) |
Source code in edgemark/models/platforms/Ekkono/model.py
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 | |
load_model
load_model(load_dir)
Loads the model.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
load_dir
|
str
|
The parent directory where the SavedModel format is stored in. |
required |
Source code in edgemark/models/platforms/Ekkono/model.py
403 404 405 406 407 408 409 410 411 412 413 | |
log_model_to_wandb
staticmethod
log_model_to_wandb(model_dir, model_save_name)
Logs the model to wandb.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
model_dir
|
str
|
The directory where the model is stored. |
required |
model_save_name
|
str
|
The name that will be assigned to the model artifact. |
required |
Source code in edgemark/models/platforms/Ekkono/model.py
416 417 418 419 420 421 422 423 424 425 426 427 428 | |
measure_execution_time
measure_execution_time()
Measures the execution time of the model.
Returns:
| Type | Description |
|---|---|
float
|
The execution time in ms. |
Source code in edgemark/models/platforms/Ekkono/model.py
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 | |
save_eqcheck_data
save_eqcheck_data(n_samples, save_dir)
Saves the eqcheck data as {"data_x", "data_y_pred"}.
The data_x has shape (samples, input_shape) and data_y_pred has shape (samples, output_shape).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
n_samples
|
int
|
The number of samples to be saved |
required |
save_dir
|
str
|
The directory where the data should be saved |
required |
Source code in edgemark/models/platforms/Ekkono/model.py
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 | |
save_model
save_model(save_dir)
Saves the model.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
save_dir
|
str
|
The directory where the model should be saved in. |
required |
Source code in edgemark/models/platforms/Ekkono/model.py
392 393 394 395 396 397 398 399 400 | |
save_model_info
staticmethod
save_model_info(model_info, save_dir)
Saves the model info.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
model_info
|
dict
|
The model info. |
required |
save_dir
|
str
|
The directory where the model info should be saved. |
required |
Source code in edgemark/models/platforms/Ekkono/model.py
431 432 433 434 435 436 437 438 439 440 441 442 443 | |
set_configs
set_configs(cfg)
Sets the configurations of the model.
Note: The changed configs won't affect the data, model, or any other loaded attributes. In case you want to change them, you should call the corresponding functions.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cfg
|
dict
|
The configuration. |
required |
Source code in edgemark/models/platforms/Ekkono/model.py
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 | |
train_model
train_model()
Trains the model.
Source code in edgemark/models/platforms/Ekkono/model.py
247 248 249 250 251 | |