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
A class for exporting a model.
Attributes:
Name | Type | Description |
---|---|---|
args |
SimpleNamespace
|
Configuration for the exporter. |
callbacks |
list
|
List of callback functions. Defaults to None. |
Parameters:
Name | Type | Description | Default |
---|---|---|---|
cfg
|
str
|
Path to a configuration file. Defaults to DEFAULT_CFG. |
DEFAULT_CFG
|
overrides
|
dict
|
Configuration overrides. Defaults to None. |
None
|
_callbacks
|
dict
|
Dictionary of callback functions. Defaults to None. |
None
|
Source code in ultralytics/engine/exporter.py
__call__
Returns list of exported files/dirs after running callbacks.
Source code in ultralytics/engine/exporter.py
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 |
|
add_callback
export_coreml
YOLO CoreML export.
Source code in ultralytics/engine/exporter.py
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 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 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_edgetpu
YOLO Edge TPU export https://coral.ai/docs/edgetpu/models-intro/.
Source code in ultralytics/engine/exporter.py
export_engine
YOLO TensorRT export https://developer.nvidia.com/tensorrt.
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 860 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_imx
YOLO IMX export.
Source code in ultralytics/engine/exporter.py
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 1165 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 1192 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 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 |
|
export_mnn
YOLOv8 MNN export using MNN https://github.com/alibaba/MNN.
Source code in ultralytics/engine/exporter.py
export_ncnn
YOLO NCNN export using PNNX https://github.com/pnnx/pnnx.
Source code in ultralytics/engine/exporter.py
export_onnx
YOLO ONNX export.
Source code in ultralytics/engine/exporter.py
export_openvino
YOLO OpenVINO export.
Source code in ultralytics/engine/exporter.py
export_paddle
YOLO Paddle export.
Source code in ultralytics/engine/exporter.py
export_pb
YOLO TensorFlow GraphDef *.pb export https://github.com/leimao/Frozen_Graph_TensorFlow.
Source code in ultralytics/engine/exporter.py
export_saved_model
YOLO TensorFlow SavedModel export.
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 977 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 |
|
export_tfjs
YOLO TensorFlow.js export.
Source code in ultralytics/engine/exporter.py
export_tflite
YOLO TensorFlow Lite export.
Source code in ultralytics/engine/exporter.py
export_torchscript
YOLO TorchScript model export.
Source code in ultralytics/engine/exporter.py
get_int8_calibration_dataloader
Build and return a dataloader suitable for calibration of INT8 models.
Source code in ultralytics/engine/exporter.py
ultralytics.engine.exporter.IOSDetectModel
Bases: Module
Wrap an Ultralytics YOLO model for Apple iOS CoreML export.
Source code in ultralytics/engine/exporter.py
forward
Normalize predictions of object detection model with input size-dependent factors.
Source code in ultralytics/engine/exporter.py
ultralytics.engine.exporter.export_formats
Ultralytics YOLO export formats.
Source code in ultralytics/engine/exporter.py
ultralytics.engine.exporter.validate_args
Validates arguments based on format.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
format
|
str
|
The export format. |
required |
passed_args
|
Namespace
|
The arguments used during export. |
required |
valid_args
|
dict
|
List of valid arguments for the format. |
required |
Raises:
Type | Description |
---|---|
AssertionError
|
If an argument that's not supported by the export format is used, or if format doesn't have the supported arguments listed. |
Source code in ultralytics/engine/exporter.py
ultralytics.engine.exporter.gd_outputs
TensorFlow GraphDef model output node names.
Source code in ultralytics/engine/exporter.py
ultralytics.engine.exporter.try_export
YOLO export decorator, i.e. @try_export.