Reference for ultralytics/engine/exporter.py
Note
This file is available at https://github.com/ultralytics/ultralytics/blob/main/ultralytics/engine/exporter.py. If you spot a problem please help fix it by contributing a Pull Request 🛠️. Thank you 🙏!
ultralytics.engine.exporter.Exporter
Exporter(cfg=DEFAULT_CFG, overrides=None, _callbacks=None)
A class for exporting YOLO models to various formats.
This class provides functionality to export YOLO models to different formats including ONNX, TensorRT, CoreML, TensorFlow, and others. It handles format validation, device selection, model preparation, and the actual export process for each supported format.
Attributes:
Name | Type | Description |
---|---|---|
args |
SimpleNamespace
|
Configuration arguments for the exporter. |
callbacks |
dict
|
Dictionary of callback functions for different export events. |
im |
Tensor
|
Input tensor for model inference during export. |
model |
Module
|
The YOLO model to be exported. |
file |
Path
|
Path to the model file being exported. |
output_shape |
tuple
|
Shape of the model output tensor(s). |
pretty_name |
str
|
Formatted model name for display purposes. |
metadata |
dict
|
Model metadata including description, author, version, etc. |
device |
device
|
Device on which the model is loaded. |
imgsz |
tuple
|
Input image size for the model. |
Methods:
Name | Description |
---|---|
__call__ |
Main export method that handles the export process. |
get_int8_calibration_dataloader |
Build dataloader for INT8 calibration. |
export_torchscript |
Export model to TorchScript format. |
export_onnx |
Export model to ONNX format. |
export_openvino |
Export model to OpenVINO format. |
export_paddle |
Export model to PaddlePaddle format. |
export_mnn |
Export model to MNN format. |
export_ncnn |
Export model to NCNN format. |
export_coreml |
Export model to CoreML format. |
export_engine |
Export model to TensorRT format. |
export_saved_model |
Export model to TensorFlow SavedModel format. |
export_pb |
Export model to TensorFlow GraphDef format. |
export_tflite |
Export model to TensorFlow Lite format. |
export_edgetpu |
Export model to Edge TPU format. |
export_tfjs |
Export model to TensorFlow.js format. |
export_rknn |
Export model to RKNN format. |
export_imx |
Export model to IMX format. |
Examples:
Export a YOLOv8 model to ONNX format
>>> from ultralytics.engine.exporter import Exporter
>>> exporter = Exporter()
>>> exporter(model="yolov8n.pt") # exports to yolov8n.onnx
Export with specific arguments
>>> args = {"format": "onnx", "dynamic": True, "half": True}
>>> exporter = Exporter(overrides=args)
>>> exporter(model="yolov8n.pt")
Parameters:
Name | Type | Description | Default |
---|---|---|---|
cfg
|
str
|
Path to a configuration file. |
DEFAULT_CFG
|
overrides
|
dict
|
Configuration overrides. |
None
|
_callbacks
|
dict
|
Dictionary of callback functions. |
None
|
Source code in ultralytics/engine/exporter.py
286 287 288 289 290 291 292 293 294 295 296 297 |
|
__call__
__call__(model=None) -> str
Return list of exported files/dirs after running callbacks.
Source code in ultralytics/engine/exporter.py
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 |
|
add_callback
add_callback(event: str, callback)
Append the given callback to the specified event.
Source code in ultralytics/engine/exporter.py
1330 1331 1332 |
|
export_coreml
export_coreml(prefix=colorstr('CoreML:'))
Export YOLO model to CoreML format.
Source code in ultralytics/engine/exporter.py
861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 |
|
export_edgetpu
export_edgetpu(tflite_model='', prefix=colorstr('Edge TPU:'))
Export YOLO model to Edge TPU format https://coral.ai/docs/edgetpu/models-intro/.
Source code in ultralytics/engine/exporter.py
1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 |
|
export_engine
export_engine(dla=None, prefix=colorstr('TensorRT:'))
Export YOLO model to TensorRT format https://developer.nvidia.com/tensorrt.
Source code in ultralytics/engine/exporter.py
941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 |
|
export_imx
export_imx(prefix=colorstr('IMX:'))
Export YOLO model to IMX format.
Source code in ultralytics/engine/exporter.py
1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 |
|
export_mnn
export_mnn(prefix=colorstr('MNN:'))
Export YOLO model to MNN format using MNN https://github.com/alibaba/MNN.
Source code in ultralytics/engine/exporter.py
768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 |
|
export_ncnn
export_ncnn(prefix=colorstr('NCNN:'))
Export YOLO model to NCNN format using PNNX https://github.com/pnnx/pnnx.
Source code in ultralytics/engine/exporter.py
793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 |
|
export_onnx
export_onnx(prefix=colorstr('ONNX:'))
Export YOLO model to ONNX format.
Source code in ultralytics/engine/exporter.py
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 |
|
export_openvino
export_openvino(prefix=colorstr('OpenVINO:'))
Export YOLO model to OpenVINO format.
Source code in ultralytics/engine/exporter.py
669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 |
|
export_paddle
export_paddle(prefix=colorstr('PaddlePaddle:'))
Export YOLO model to PaddlePaddle format.
Source code in ultralytics/engine/exporter.py
744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 |
|
export_pb
export_pb(keras_model, prefix=colorstr('TensorFlow GraphDef:'))
Export YOLO model to TensorFlow GraphDef *.pb format https://github.com/leimao/Frozen-Graph-TensorFlow.
Source code in ultralytics/engine/exporter.py
1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 |
|
export_rknn
export_rknn(prefix=colorstr('RKNN:'))
Export YOLO model to RKNN format.
Source code in ultralytics/engine/exporter.py
1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 |
|
export_saved_model
export_saved_model(prefix=colorstr('TensorFlow SavedModel:'))
Export YOLO model to TensorFlow SavedModel format.
Source code in ultralytics/engine/exporter.py
978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 |
|
export_tfjs
export_tfjs(prefix=colorstr('TensorFlow.js:'))
Export YOLO model to TensorFlow.js format.
Source code in ultralytics/engine/exporter.py
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 |
|
export_tflite
export_tflite(prefix=colorstr('TensorFlow Lite:'))
Export YOLO model to TensorFlow Lite format.
Source code in ultralytics/engine/exporter.py
1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 |
|
export_torchscript
export_torchscript(prefix=colorstr('TorchScript:'))
Export YOLO model to TorchScript format.
Source code in ultralytics/engine/exporter.py
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 |
|
get_int8_calibration_dataloader
get_int8_calibration_dataloader(prefix='')
Build and return a dataloader for calibration of INT8 models.
Source code in ultralytics/engine/exporter.py
565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 |
|
run_callbacks
run_callbacks(event: str)
Execute all callbacks for a given event.
Source code in ultralytics/engine/exporter.py
1334 1335 1336 1337 |
|
ultralytics.engine.exporter.IOSDetectModel
IOSDetectModel(model, im)
Bases: Module
Wrap an Ultralytics YOLO model for Apple iOS CoreML export.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model
|
Module
|
The YOLO model to wrap. |
required |
im
|
Tensor
|
Example input tensor with shape (B, C, H, W). |
required |
Source code in ultralytics/engine/exporter.py
1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 |
|
forward
forward(x)
Normalize predictions of object detection model with input size-dependent factors.
Source code in ultralytics/engine/exporter.py
1363 1364 1365 1366 |
|
ultralytics.engine.exporter.NMSModel
NMSModel(model, args)
Bases: Module
Model wrapper with embedded NMS for Detect, Segment, Pose and OBB.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model
|
Module
|
The model to wrap with NMS postprocessing. |
required |
args
|
Namespace
|
The export arguments. |
required |
Source code in ultralytics/engine/exporter.py
1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 |
|
forward
forward(x)
Perform inference with NMS post-processing. Supports Detect, Segment, OBB and Pose.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
x
|
Tensor
|
The preprocessed tensor with shape (N, 3, H, W). |
required |
Returns:
Type | Description |
---|---|
Tensor
|
List of detections, each an (N, max_det, 4 + 2 + extra_shape) Tensor where N is the number of detections after NMS. |
Source code in ultralytics/engine/exporter.py
1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 |
|
ultralytics.engine.exporter.export_formats
export_formats()
Return a dictionary of Ultralytics YOLO export formats.
Source code in ultralytics/engine/exporter.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 |
|
ultralytics.engine.exporter.best_onnx_opset
best_onnx_opset(onnx) -> int
Return max ONNX opset for this torch version with ONNX fallback.
Source code in ultralytics/engine/exporter.py
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 |
|
ultralytics.engine.exporter.validate_args
validate_args(format, passed_args, valid_args)
Validate arguments based on the export format.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
format
|
str
|
The export format. |
required |
passed_args
|
Namespace
|
The arguments used during export. |
required |
valid_args
|
list
|
List of valid arguments for the format. |
required |
Raises:
Type | Description |
---|---|
AssertionError
|
If an unsupported argument is used, or if the format lacks supported argument listings. |
Source code in ultralytics/engine/exporter.py
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 |
|
ultralytics.engine.exporter.gd_outputs
gd_outputs(gd)
Return TensorFlow GraphDef model output node names.
Source code in ultralytics/engine/exporter.py
203 204 205 206 207 208 209 |
|
ultralytics.engine.exporter.try_export
try_export(inner_func)
YOLO export decorator, i.e. @try_export.
Source code in ultralytics/engine/exporter.py
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 |
|