mirror of
https://github.com/opencv/opencv.git
synced 2024-12-03 00:10:21 +08:00
3cd57ea09e
New dnn engine #26056 This is the 1st PR with the new engine; CI is green and PR is ready to be merged, I think. Merge together with https://github.com/opencv/opencv_contrib/pull/3794 --- **Known limitations:** * [solved] OpenVINO is temporarily disabled, but is probably easy to restore (it's not a deal breaker to merge this PR, I guess) * The new engine does not support any backends nor any targets except for the default CPU implementation. But it's possible to choose the old engine when loading a model, then all the functionality is available. * [Caffe patch is here: #26208] The new engine only supports ONNX. When a model is constructed manually or is loaded from a file of different format (.tf, .tflite, .caffe, .darknet), the old engine is used. * Even in the case of ONNX some layers are not supported by the new engine, such as all quantized layers (including DequantizeLinear, QuantizeLinear, QLinearConv etc.), LSTM, GRU, .... It's planned, of course, to have full support for ONNX by OpenCV 5.0 gold release. When a loaded model contains unsupported layers, we switch to the old engine automatically (at ONNX parsing time, not at `forward()` time). * Some layers , e.g. Expat, are only partially supported by the new engine. In the case of unsupported flavours it switches to the old engine automatically (at ONNX parsing time, not at `forward()` time). * 'Concat' graph optimization is disabled. The optimization eliminates Concat layer and instead makes the layers that generate tensors to be concatenated to write the outputs to the final destination. Of course, it's only possible when `axis=0` or `axis=N=1`. The optimization is not compatible with dynamic shapes since we need to know in advance where to store the tensors. Because some of the layer implementations have been modified to become more compatible with the new engine, the feature appears to be broken even when the old engine is used. * Some `dnn::Net` API is not available with the new engine. Also, shape inference may return false if some of the output or intermediate tensors' shapes cannot be inferred without running the model. Probably this can be fixed by a dummy run of the model with zero inputs. * Some overloads of `dnn::Net::getFLOPs()` and `dnn::Net::getMemoryConsumption()` are not exposed any longer in wrapper generators; but the most useful overloads are exposed (and checked by Java tests). * [in progress] A few Einsum tests related to empty shapes have been disabled due to crashes in the tests and in Einsum implementations. The code and the tests need to be repaired. * OpenCL implementation of Deconvolution is disabled. It's very bad and very slow anyway; need to be completely revised. * Deconvolution3D test is now skipped, because it was only supported by CUDA and OpenVINO backends, both of which are not supported by the new engine. * Some tests, such as FastNeuralStyle, checked that the in the case of CUDA backend there is no fallback to CPU. Currently all layers in the new engine are processed on CPU, so there are many fallbacks. The checks, therefore, have been temporarily disabled. --- - [x] I agree to contribute to the project under Apache 2 License. - [x] To the best of my knowledge, the proposed patch is not based on a code under GPL or another license that is incompatible with OpenCV - [x] The PR is proposed to the proper branch - [ ] There is a reference to the original bug report and related work - [ ] There is accuracy test, performance test and test data in opencv_extra repository, if applicable Patch to opencv_extra has the same branch name. - [ ] The feature is well documented and sample code can be built with the project CMake
88 lines
4.3 KiB
Python
Executable File
88 lines
4.3 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
"""
|
|
This script builds OpenCV docs for iOS.
|
|
"""
|
|
|
|
from __future__ import print_function
|
|
import os, sys, multiprocessing, argparse, traceback
|
|
from subprocess import check_call, check_output, CalledProcessError, Popen
|
|
|
|
def execute(cmd, cwd = None, output = None):
|
|
if not output:
|
|
print("Executing: %s in %s" % (cmd, cwd), file=sys.stderr)
|
|
print('Executing: ' + ' '.join(cmd))
|
|
retcode = check_call(cmd, cwd = cwd)
|
|
if retcode != 0:
|
|
raise Exception("Child returned:", retcode)
|
|
else:
|
|
with open(output, "a") as f:
|
|
f.flush()
|
|
p = Popen(cmd, cwd = cwd, stdout = f)
|
|
os.waitpid(p.pid, 0)
|
|
|
|
class DocBuilder:
|
|
def __init__(self, script_dir, framework_dir, output_dir, framework_header, framework_name, arch, target):
|
|
self.script_dir = script_dir
|
|
self.framework_dir = framework_dir
|
|
self.output_dir = output_dir
|
|
self.framework_header = framework_header
|
|
self.framework_name = framework_name
|
|
self.arch = arch
|
|
self.target = target
|
|
|
|
def _build(self):
|
|
if not os.path.isdir(self.output_dir):
|
|
os.makedirs(self.output_dir)
|
|
|
|
self.buildDocs()
|
|
|
|
def build(self):
|
|
try:
|
|
self._build()
|
|
except Exception as e:
|
|
print("="*60, file=sys.stderr)
|
|
print("ERROR: %s" % e, file=sys.stderr)
|
|
print("="*60, file=sys.stderr)
|
|
traceback.print_exc(file=sys.stderr)
|
|
sys.exit(1)
|
|
|
|
def getToolchain(self):
|
|
return None
|
|
|
|
def getSourceKitten(self):
|
|
ret = check_output(["gem", "which", "jazzy"])
|
|
if ret.find('ERROR:') == 0:
|
|
raise Exception("Failed to find jazzy")
|
|
else:
|
|
return os.path.join(ret[0:ret.rfind('/')], '../bin/sourcekitten')
|
|
|
|
def buildDocs(self):
|
|
sourceKitten = self.getSourceKitten()
|
|
sourceKittenSwiftDoc = [sourceKitten, "doc", "--module-name", self.framework_name, "--", "-project", self.framework_name + ".xcodeproj", "ARCHS=" + self.arch, "-sdk", self.target, "-configuration", "Release", "-parallelizeTargets", "-jobs", str(multiprocessing.cpu_count()), "-target", "opencv_objc_framework"]
|
|
execute(sourceKittenSwiftDoc, cwd = self.framework_dir, output = os.path.join(self.output_dir, "swiftDoc.json"))
|
|
sdk_dir = check_output(["xcrun", "--show-sdk-path", "--sdk", self.target]).rstrip()
|
|
sourceKittenObjcDoc = [sourceKitten, "doc", "--objc", self.framework_header, "--", "-x", "objective-c", "-isysroot", sdk_dir, "-fmodules"]
|
|
print(sourceKittenObjcDoc)
|
|
execute(sourceKittenObjcDoc, cwd = self.framework_dir, output = os.path.join(self.output_dir, "objcDoc.json"))
|
|
execute(["jazzy", "--author", "OpenCV", "--author_url", "http://opencv.org", "--github_url", "https://github.com/opencv/opencv", "--module", self.framework_name, "--undocumented-text", "\"\"", "--sourcekitten-sourcefile", "swiftDoc.json,objcDoc.json"], cwd = self.output_dir)
|
|
|
|
class iOSDocBuilder(DocBuilder):
|
|
|
|
def getToolchain(self):
|
|
return None
|
|
|
|
if __name__ == "__main__":
|
|
script_dir = os.path.abspath(os.path.dirname(sys.argv[0]))
|
|
parser = argparse.ArgumentParser(description='The script builds OpenCV docs for iOS.')
|
|
parser.add_argument('framework_dir', metavar='FRAMEWORK_DIR', help='folder where framework build files are located')
|
|
parser.add_argument('--output_dir', default=None, help='folder where docs will be built (default is "../doc_build" relative to framework_dir)')
|
|
parser.add_argument('--framework_header', default=None, help='umbrella header for OpenCV framework (default is "../../../lib/Release/{framework_name}.framework/Headers/{framework_name}.h")')
|
|
parser.add_argument('--framework_name', default='opencv2', help='Name of OpenCV framework (default: opencv2, will change to OpenCV in future version)')
|
|
args = parser.parse_args()
|
|
|
|
arch = "x86_64"
|
|
target = "iphonesimulator"
|
|
|
|
b = iOSDocBuilder(script_dir, args.framework_dir, args.output_dir if args.output_dir else os.path.join(args.framework_dir, "../doc_build"), args.framework_header if args.framework_header else os.path.join(args.framework_dir, "../../../lib/Release/" + args.framework_name + ".framework/Headers/" + args.framework_name + ".h"), args.framework_name, arch, target)
|
|
b.build()
|