deeplabcut.generate_training_dataset.multiple_individuals_trainingsetmanipulation
Functions:
| Name | Description |
|---|---|
create_multianimaltraining_dataset |
Creates a training dataset for multi-animal datasets. Labels from all the |
create_multianimaltraining_dataset
create_multianimaltraining_dataset(
config,
num_shuffles=1,
Shuffles=None,
windows2linux=False,
net_type=None,
detector_type=None,
numdigits=2,
crop_size=(400, 400),
crop_sampling="hybrid",
paf_graph=None,
trainIndices=None,
testIndices=None,
n_edges_threshold=105,
paf_graph_degree=6,
userfeedback: bool = True,
weight_init: WeightInitialization | None = None,
engine: Engine | None = None,
ctd_conditions: int | str | Path | tuple[int, str] | tuple[int, int] | None = None,
)
Creates a training dataset for multi-animal datasets. Labels from all the extracted frames are merged into a single .h5 file. Only the videos included in the config file are used to create this dataset. [OPTIONAL] Use the function 'add_new_videos' at any stage of the project to add more videos to the project.
Important differences to standard: - stores coordinates with numdigits as many digits
Parameter
config : string Full path of the config.yaml file as a string.
num_shuffles : int, optional Number of shuffles of training dataset to create, i.e. [1,2,3] for num_shuffles=3. Default is set to 1.
Shuffles: list of shuffles. Alternatively the user can also give a list of shuffles (integers!).
net_type: string
Type of networks. The options available depend on which engine is used. See
Lauer et al. 2021 https://www.biorxiv.org/content/10.1101/2021.04.30.442096v1
Currently supported options are:
TensorFlow
* resnet_50
* resnet_101
* resnet_152
* efficientnet-b0
* efficientnet-b1
* efficientnet-b2
* efficientnet-b3
* efficientnet-b4
* efficientnet-b5
* efficientnet-b6
PyTorch (call deeplabcut.pose_estimation_pytorch.available_models() for
a complete list)
* animaltokenpose_base
* cspnext_m
* cspnext_s
* cspnext_x
* ctd_coam_w32
* ctd_coam_w48
* ctd_prenet_hrnet_w32
* ctd_prenet_hrnet_w48
* ctd_prenet_rtmpose_m
* ctd_prenet_rtmpose_x
* ctd_prenet_rtmpose_x_human
* dekr_w18
* dekr_w32
* dekr_w48
* dlcrnet_stride16_ms5
* dlcrnet_stride32_ms5
* hrnet_w18
* hrnet_w32
* hrnet_w48
* resnet_101
* resnet_50
* rtmpose_m
* rtmpose_s
* rtmpose_x
* top_down_cspnext_m
* top_down_cspnext_s
* top_down_cspnext_x
* top_down_hrnet_w18
* top_down_hrnet_w32
* top_down_hrnet_w48
* top_down_resnet_101
* top_down_resnet_50
detector_type: string, optional, default=None
Only for the PyTorch engine.
When passing creating shuffles for top-down models, you can specify which
detector you want. If the detector_type is None, the ssdlite will be used.
The list of all available detectors can be obtained by calling
deeplabcut.pose_estimation_pytorch.available_detectors(). Supported options:
* ssdlite
* fasterrcnn_mobilenet_v3_large_fpn
* fasterrcnn_resnet50_fpn_v2
numdigits: int, optional
crop_size: tuple of int, optional Only for the TensorFlow engine. Dimensions (width, height) of the crops for data augmentation. Default is 400x400.
crop_sampling: str, optional Only for the TensorFlow engine. Crop centers sampling method. Must be either: "uniform" (randomly over the image), "keypoints" (randomly over the annotated keypoints), "density" (weighing preferentially dense regions of keypoints), or "hybrid" (alternating randomly between "uniform" and "density"). Default is "hybrid".
paf_graph: list of lists, or "config" optional (default=None) Only for the TensorFlow engine. If not None, overwrite the default complete graph. This is useful for advanced users who already know a good graph, or simply want to use a specific one. Note that, in that case, the data-driven selection procedure upon model evaluation will be skipped.
"config" will use the skeleton defined in the config file.
trainIndices: list of lists, optional (default=None) List of one or multiple lists containing train indexes. A list containing two lists of training indexes will produce two splits.
testIndices: list of lists, optional (default=None) List of one or multiple lists containing test indexes.
n_edges_threshold: int, optional (default=105) Only for the TensorFlow engine. Number of edges above which the graph is automatically pruned.
paf_graph_degree: int, optional (default=6) Only for the TensorFlow engine. Degree of paf_graph when automatically pruning it (before training).
userfeedback: bool, optional, default=True
If False, all requested train/test splits are created (no matter if they
already exist). If you want to assure that previous splits etc. are not
overwritten, set this to True and you will be asked for each split.
weight_init: WeightInitialisation, optional, default=None PyTorch engine only. Specify how model weights should be initialized. The default mode uses transfer learning from ImageNet weights.
engine: Engine, optional
Whether to create a pose config for a Tensorflow or PyTorch model. Defaults to
the value specified in the project configuration file. If no engine is specified
for the project, defaults to deeplabcut.compat.DEFAULT_ENGINE.
ctd_conditions: int | str | Path | tuple[int, str] | tuple[int, int] , optional, default = None, If using a conditional-top-down (CTD) net_type, this argument needs to be specified. It defines the conditions that will be used with the CTD model. It can be either: * A shuffle number (ctd_conditions: int), which must correspond to a bottom-up (BU) network type. * A predictions file path (ctd_conditions: string | Path), which must correspond to a .json or .h5 predictions file. * A shuffle number and a particular snapshot (ctd_conditions: tuple[int, str] | tuple[int, int]), which respectively correspond to a bottom-up (BU) network type and a particular snapshot name or index.
Example
deeplabcut.create_multianimaltraining_dataset('/analysis/project/reaching-task/config.yaml',num_shuffles=1)
deeplabcut.create_multianimaltraining_dataset('/analysis/project/reaching-task/config.yaml', Shuffles=[0,1,2], trainIndices=[trainInd1, trainInd2, trainInd3], testIndices=[testInd1, testInd2, testInd3])
Windows:
deeplabcut.create_multianimaltraining_dataset(r'C:\Users\Ulf\looming-task\config.yaml',Shuffles=[3,17,5])
Source code in deeplabcut/generate_training_dataset/multiple_individuals_trainingsetmanipulation.py
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 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 | |