Add NMS to CoreML model output, works with Vision #7263

mshamash · 2022-04-03T22:34:43Z

Reference issues: #5157 , #343 , #7011

The current version of the export.py script outputs a CoreML model without NMS. This means that certain Vision APIs cannot be used with the model directly, as the output during inference is VNCoreMLFeatureValueObservation. The changes implemented here add a NMS layer to the CoreML output, so the output from inference is VNRecognizedObjectObservation. By adding NMS to the model directly, as opposed to later in code, the performance of the overall image/video processing is improved. This also allows use of the "Preview" tab in Xcode for quickly testing the model.

Default IoU and confidence thresholds are taken from the --iou-thres and --conf-thres arguments during export.py script runtime. The user can also change these later by using a CoreML MLFeatureProvider in their application (see https://developer.apple.com/documentation/coreml/mlfeatureprovider).

This has no effect on training, as it only adds an additional layer during CoreML export for NMS.

Based on code by @pocketpixels, with permission to make this PR: https://github.com/pocketpixels/yolov5/blob/better_coreml_export/models/coreml_export.py

🛠️ PR Summary

_{Made with ❤️ by Ultralytics Actions}

🌟 Summary

Enhanced CoreML model export with NMS and metadata.

📊 Key Changes

Introduced CoreMLExportModel to convert outputs to a more CoreML-friendly format.
Added Non-Maximum Suppression (NMS) to the CoreML export pipeline.
The model outputs now include class confidence and normalized box coordinates.
Metadata, such as IOU and confidence thresholds as well as class labels, is now embedded in the exported model.
Improved export pipeline by accommodating dynamic ranges for confidence and coordinates.

🎯 Purpose & Impact

🎨 This update provides a more accurate and usable CoreML model by including pre-processing (like NMS) directly in the model, reducing the need for additional code post-export.
🚀 These changes could significantly streamline the process for iOS and macOS developers deploying YOLOv5 models in their applications, improving model performance and ease of use.
🏷 Embedding metadata allows for better model understanding and integration, potentially expanding the user base for CoreML exports.

Reference issues: #5157 , #343 , #7011 The current version of the export.py script outputs a CoreML model without NMS. This means that certain Vision APIs cannot be used with the model directly, as the output during inference is VNCoreMLFeatureValueObservation. The changes implemented here add a NMS layer to the CoreML output, so the output from inference is VNRecognizedObjectObservation. By adding NMS to the model directly, as opposed to later in code, the performance of the overall image/video processing is improved. This also allows use of the "Preview" tab in Xcode for quickly testing the model. Default IoU and confidence thresholds are taken from the `--iou-thres` and `--conf-thres` arguments during export.py script runtime. The user can also change these later by using a CoreML MLFeatureProvider in their application (see [https://developer.apple.com/documentation/coreml/mlfeatureprovider](https://developer.apple.com/documentation/coreml/mlfeatureprovider)). This has no effect on training, as it only adds an additional layer during CoreML export for NMS.

for more information, see https://pre-commit.ci

github-actions

👋 Hello @mshamash, thank you for submitting a YOLOv5 🚀 PR! To allow your work to be integrated as seamlessly as possible, we advise you to:

✅ Verify your PR is up-to-date with upstream/master. If your PR is behind upstream/master an automatic GitHub Actions merge may be attempted by writing /rebase in a new comment, or by running the following code, replacing 'feature' with the name of your local branch:

git remote add upstream https://github.com/ultralytics/yolov5.git
git fetch upstream
# git checkout feature  # <--- replace 'feature' with local branch name
git merge upstream/master
git push -u origin -f

✅ Verify all Continuous Integration (CI) checks are passing.
✅ Reduce changes to the absolute minimum required for your bug fix or feature addition. "It is not daily increase but daily decrease, hack away the unessential. The closer to the source, the less wastage there is." -Bruce Lee

liuzhiguai · 2022-04-04T15:11:59Z

I tried your new method, which was very effective. During the exporting, I noticed some warning,But it has no effect on the results

TorchScript: starting export with torch 1.9.1...
/Users/anyadong/PycharmProjects/yolov5-master/coreml_export-new.py:58: TracerWarning: Converting a tensor to a Python boolean might cause the trace to be incorrect. We can't record the data flow of Python values, so this value will be treated as a constant in the future. This means that the trace might not generalize to other inputs!
if self.grid[i].shape[2:4] != x[i].shape[2:4] or self.onnx_dynamic:
/Users/anyadong/PycharmProjects/yolov5-master/coreml_export-new.py:65: TracerWarning: Converting a tensor to a Python number might cause the trace to be incorrect. We can't record the data flow of Python values, so this value will be treated as a constant in the future. This means that the trace might not generalize to other inputs!
s = self.stride[i].item()
/Users/anyadong/PycharmProjects/yolov5-master/coreml_export-new.py:66: TracerWarning: Converting a tensor to a NumPy array might cause the trace to be incorrect. We can't record the data flow of Python values, so this value will be treated as a constant in the future. This means that the trace might not generalize to other inputs!
ag = torch.from_numpy(self.anchor_grid[i].numpy())#new
/Users/anyadong/PycharmProjects/yolov5-master/coreml_export-new.py:66: TracerWarning: torch.from_numpy results are registered as constants in the trace. You can safely ignore this warning if you use this function to create tensors out of constant variables that would be the same every time you call this function. In any other case, this might cause the trace to be incorrect.
ag = torch.from_numpy(self.anchor_grid[i].numpy())#new
/Users/anyadong/PycharmProjects/yolov5-master/coreml_export-new.py:47: TracerWarning: torch.tensor results are registered as constants in the trace. You can safely ignore this warning if you use this function to create tensors out of constant variables that would be the same every time you call this function. In any other case, this might cause the trace to be incorrect.
boxes = x[:, :4] * torch.tensor([1. / w, 1. / h, 1. / w, 1. / h])
/Users/anyadong/PycharmProjects/yolov5-master/coreml_export-new.py:58: TracerWarning: Converting a tensor to a Python boolean might cause the trace to be incorrect. We can't record the data flow of Python values, so this value will be treated as a constant in the future. This means that the trace might not generalize to other inputs!
if self.grid[i].shape[2:4] != x[i].shape[2:4] or self.onnx_dynamic:
/Users/anyadong/PycharmProjects/yolov5-master/coreml_export-new.py:65: TracerWarning: Converting a tensor to a Python number might cause the trace to be incorrect. We can't record the data flow of Python values, so this value will be treated as a constant in the future. This means that the trace might not generalize to other inputs!
s = self.stride[i].item()
/Users/anyadong/PycharmProjects/yolov5-master/coreml_export-new.py:66: TracerWarning: Converting a tensor to a NumPy array might cause the trace to be incorrect. We can't record the data flow of Python values, so this value will be treated as a constant in the future. This means that the trace might not generalize to other inputs!
ag = torch.from_numpy(self.anchor_grid[i].numpy())#new
/Users/anyadong/PycharmProjects/yolov5-master/coreml_export-new.py:66: TracerWarning: torch.from_numpy results are registered as constants in the trace. You can safely ignore this warning if you use this function to create tensors out of constant variables that would be the same every time you call this function. In any other case, this might cause the trace to be incorrect.
ag = torch.from_numpy(self.anchor_grid[i].numpy())#new
/Users/anyadong/PycharmProjects/yolov5-master/coreml_export-new.py:47: TracerWarning: torch.tensor results are registered as constants in the trace. You can safely ignore this warning if you use this function to create tensors out of constant variables that would be the same every time you call this function. In any other case, this might cause the trace to be incorrect.
boxes = x[:, :4] * torch.tensor([1. / w, 1. / h, 1. / w, 1. / h])

mshamash · 2022-04-04T15:15:24Z

@liuzhiguai - Thanks for reporting back! I don't think I had those errors during export, but I have made a couple modifications since, and integrated with the current version of the export.py script as well. Can you please try again with the newest version of the export script, which I am submitting in this PR? You can download the file here: https://github.com/mshamash/yolov5/blob/fix/coreml_export_nms_layer/export.py

liuzhiguai · 2022-04-04T15:45:42Z

I tried the newest version,There was no warning this time.This is very helpful to me
But in line 692,I need to change back to the original code(print_args(FILE.stem, opt)),Otherwise, an error will be reported

Traceback (most recent call last):
File "/Applications/PyCharm.app/Contents/plugins/python/helpers/pydev/pydevd.py", line 1483, in _exec
pydev_imports.execfile(file, globals, locals) # execute the script
File "/Applications/PyCharm.app/Contents/plugins/python/helpers/pydev/_pydev_imps/_pydev_execfile.py", line 18, in execfile
exec(compile(contents+"\n", file, 'exec'), glob, loc)
File "/Users/anyadong/PycharmProjects/yolov5-master/export2.py", line 703, in
opt = parse_opt()
File "/Users/anyadong/PycharmProjects/yolov5-master/export2.py", line 692, in parse_opt
print_args(vars(opt))
TypeError: print_args() missing 1 required positional argument: 'opt'

mshamash · 2022-04-04T15:47:59Z

@liuzhiguai - I didn't change anything on that line, so I'm not sure why it's erroring. Perhaps do a git pull on your local YOLOv5 repo, maybe there were some changes in other files since you pulled it last?

for more information, see https://pre-commit.ci

mshamash · 2022-04-17T12:41:26Z

@glenn-jocher is this something that you think could be implemented/merged in the export.py script?

glenn-jocher · 2022-04-17T13:19:42Z

@mshamash yes, but we have a higher level issue. Right now all model exports are benchmarkable, i.e. see #6613:

MacOS Intel CPU Results (CoreML-capable)

benchmarks: weights=/Users/glennjocher/PycharmProjects/yolov5/yolov5s.pt, imgsz=640, batch_size=1, data=/Users/glennjocher/PycharmProjects/yolov5/data/coco128.yaml, device=, half=False, test=False
Checking setup...
YOLOv5 🚀 v6.1-135-g7926afc torch 1.11.0 CPU
Setup complete ✅ (8 CPUs, 32.0 GB RAM, 793.4/931.6 GB disk)

Benchmarks complete (288.68s)
                   Format  mAP@0.5:0.95  Inference time (ms)
0                 PyTorch        0.4623               281.47
1             TorchScript        0.4623               262.97
2                    ONNX        0.4623                77.30
3                OpenVINO        0.4623                74.12
4                TensorRT           NaN                  NaN
5                  CoreML        0.4620                69.36
6   TensorFlow SavedModel        0.4623               123.12
7     TensorFlow GraphDef        0.4623               120.82
8         TensorFlow Lite        0.4623               249.62
9     TensorFlow Edge TPU           NaN                  NaN
10          TensorFlow.js           NaN                  NaN

There have been user requests for native-NMS exports in a few formats, i.e. TFLite, ONNX, TRT, TorchScript, and here with CoreML. So we need additional infrastructure within val.py, detect.py, PyTorch Hub, and/or the NMS function to recognize native-NMS output formats and handle these accordingly to allow these to also work correctly with the various inference pathways.

pillai-karthik · 2022-04-28T19:36:13Z

Thank you!

Jaykob · 2022-05-11T12:34:04Z

Thank you, works fine on my side :)

drush · 2022-05-17T21:04:48Z

+1

ultralytics#7263

github-actions · 2022-06-23T00:18:54Z

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions YOLOv5 🚀 and Vision AI ⭐.

mshamash · 2022-06-23T15:33:44Z

not stale

hietalajulius · 2022-08-23T10:08:48Z

export.py

+        nms.iouThreshold = iou_thres
+        nms.confidenceThreshold = conf_thres
+        nms.pickTop.perClass = False
+        nms.stringClassLabels.vector.extend(labels)


mshamash if you end up merging newer commits from the main branch to this branch, these labels could/should be changed to labels.values() since it's a dictionary now 👍

@hietalajulius don't forget that a dictionary is not ordered. I guess it's better to do [labels[k] for k in sorted(labels.keys())]

titanium-cranium · 2022-10-19T04:23:55Z

Any possibility of implementing this (NMS layer for coreml)? @glenn-jocher

philipperemy · 2022-10-24T07:30:13Z

@hietalajulius Can you have a look at this one please?

philipperemy · 2022-10-26T09:14:28Z

export.py

+        user_defined_metadata = {
+            "iou_threshold": str(iou_thres),
+            "confidence_threshold": str(conf_thres),
+            "classes": ", ".join(labels)}


@hietalajulius @mshamash Also relevant here.

philipperemy · 2022-10-26T09:27:56Z

@mshamash Do you know why the confidence shown in Xcode is always 100%? Isn't there a way to output the confidence returned by the NMS layer for the BBox?

Jaykob · 2022-12-30T16:01:36Z

Any reason this wonderfully working fix wasn't merged yet?

zaitsman · 2023-01-04T03:44:37Z

Agree with @Jaykob because the mlmodel that comes out of export.py just doesn't work with Apple's Vision framework at all :(

wmcnally · 2023-01-11T05:23:34Z

@philipperemy did you figure out why you were getting 100% confidence? I ran into the same issue.. confidence always 98-100%

philipperemy · 2023-01-11T08:27:06Z

@wmcnally nope. I gave it on that one. Mine was always 100%.

zaitsman · 2023-01-11T09:45:14Z

@wmcnally @philipperemy Are you guys testing on the same images you trained with? Confidence worked just fine for me, however I had to manually apply @mshamash 's changes to master coz I made a couple other changes.. doubt that it affected confidence working though.

philipperemy · 2023-01-11T09:57:50Z

@zaitsman yeah I tested it on the same images.

zaitsman · 2023-01-11T11:21:39Z

@philipperemy so how do you expect it to give you a different value? I mean if your model is well fit then data from the training set is always 100%. You need to compare against OTHER images not in your dataset.

wmcnally · 2023-01-11T15:12:33Z

@zaitsman @philipperemy i did not use training images and my confidence with @mshamash export was higher than when using detect.py

mshamash and others added 2 commits April 3, 2022 18:33

[pre-commit.ci] auto fixes from pre-commit.com hooks

749d8eb

for more information, see https://pre-commit.ci

github-actions bot reviewed Apr 3, 2022

View reviewed changes

This was referenced Apr 4, 2022

CoreML conversion/export and usage (non-max suppression) #5157

Closed

Use export.py to generate yolov5s.onnx will get a negative number. #343

Closed

when exporting to coreml (mlmodel format) NMS is not added. #7011

Closed

mshamash and others added 2 commits April 9, 2022 08:50

Merge branch 'master' into fix/coreml_export_nms_layer

761303c

[pre-commit.ci] auto fixes from pre-commit.com hooks

6bff769

for more information, see https://pre-commit.ci

Unbinilium added a commit to Unbinilium/yolov5 that referenced this pull request May 27, 2022

Add NMS to CoreML model output

f09c422

ultralytics#7263

github-actions bot added the Stale label Jun 23, 2022

github-actions bot removed the Stale label Jun 24, 2022

hietalajulius reviewed Aug 23, 2022

View reviewed changes

This was referenced Sep 2, 2022

Yolo v4 or v5 tucan9389/ObjectDetection-CoreML#4

Closed

Support YOLOv5 tucan9389/ObjectDetection-CoreML#6

Closed

Introduce iOS demo repo for YOLOv5 Core ML models 📱 #9271

Closed

philipperemy reviewed Oct 26, 2022

View reviewed changes

philipperemy mentioned this pull request Oct 26, 2022

Fail to export CoreML model with decode layer and NMS #9694

Closed

mshamash closed this by deleting the head repository Feb 12, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add NMS to CoreML model output, works with Vision #7263

Add NMS to CoreML model output, works with Vision #7263

mshamash commented Apr 3, 2022 •

edited by UltralyticsAssistant

Loading

github-actions bot left a comment

liuzhiguai commented Apr 4, 2022

mshamash commented Apr 4, 2022

liuzhiguai commented Apr 4, 2022 •

edited

Loading

mshamash commented Apr 4, 2022

mshamash commented Apr 17, 2022

glenn-jocher commented Apr 17, 2022 •

edited

Loading

pillai-karthik commented Apr 28, 2022

Jaykob commented May 11, 2022

drush commented May 17, 2022

github-actions bot commented Jun 23, 2022

mshamash commented Jun 23, 2022

hietalajulius Aug 23, 2022

philipperemy Oct 26, 2022

titanium-cranium commented Oct 19, 2022

philipperemy commented Oct 24, 2022

philipperemy Oct 26, 2022

philipperemy commented Oct 26, 2022 •

edited

Loading

Jaykob commented Dec 30, 2022 •

edited

Loading

zaitsman commented Jan 4, 2023 •

edited

Loading

wmcnally commented Jan 11, 2023

philipperemy commented Jan 11, 2023

zaitsman commented Jan 11, 2023

philipperemy commented Jan 11, 2023

zaitsman commented Jan 11, 2023

wmcnally commented Jan 11, 2023

Add NMS to CoreML model output, works with Vision #7263

Add NMS to CoreML model output, works with Vision #7263

Conversation

mshamash commented Apr 3, 2022 • edited by UltralyticsAssistant Loading

🛠️ PR Summary

🌟 Summary

📊 Key Changes

🎯 Purpose & Impact

github-actions bot left a comment

Choose a reason for hiding this comment

liuzhiguai commented Apr 4, 2022

mshamash commented Apr 4, 2022

liuzhiguai commented Apr 4, 2022 • edited Loading

mshamash commented Apr 4, 2022

mshamash commented Apr 17, 2022

glenn-jocher commented Apr 17, 2022 • edited Loading

MacOS Intel CPU Results (CoreML-capable)

pillai-karthik commented Apr 28, 2022

Jaykob commented May 11, 2022

drush commented May 17, 2022

github-actions bot commented Jun 23, 2022

mshamash commented Jun 23, 2022

hietalajulius Aug 23, 2022

Choose a reason for hiding this comment

philipperemy Oct 26, 2022

Choose a reason for hiding this comment

titanium-cranium commented Oct 19, 2022

philipperemy commented Oct 24, 2022

philipperemy Oct 26, 2022

Choose a reason for hiding this comment

philipperemy commented Oct 26, 2022 • edited Loading

Jaykob commented Dec 30, 2022 • edited Loading

zaitsman commented Jan 4, 2023 • edited Loading

wmcnally commented Jan 11, 2023

philipperemy commented Jan 11, 2023

zaitsman commented Jan 11, 2023

philipperemy commented Jan 11, 2023

zaitsman commented Jan 11, 2023

wmcnally commented Jan 11, 2023

mshamash commented Apr 3, 2022 •

edited by UltralyticsAssistant

Loading

liuzhiguai commented Apr 4, 2022 •

edited

Loading

glenn-jocher commented Apr 17, 2022 •

edited

Loading

philipperemy commented Oct 26, 2022 •

edited

Loading

Jaykob commented Dec 30, 2022 •

edited

Loading

zaitsman commented Jan 4, 2023 •

edited

Loading