Merge sdk (open-mmlab#251)

* check in cmake

* move backend_ops to csrc/backend_ops

* check in preprocess, model, some codebase and their c-apis

* check in CMakeLists.txt

* check in parts of test_csrc

* commit everything else

* add readme

* update core's BUILD_INTERFACE directory

* skip codespell on third_party

* update trt_net and ort_net's CMakeLists

* ignore clion's build directory

* check in pybind11

* add onnx.proto. Remove MMDeploy's dependency on ncnn's source code

* export MMDeployTargets only when MMDEPLOY_BUILD_SDK is ON

* remove useless message

* target include directory is wrong

* change target name from mmdeploy_ppl_net to mmdeploy_pplnn_net

* skip install directory

* update project's cmake

* remove useless code

* set CMAKE_BUILD_TYPE to Release by force if it isn't set by user

* update custom ops CMakeLists

* pass object target's source lists

* fix lint end-of-file

* fix lint: trailing whitespace

* fix codespell hook

* remove bicubic_interpolate to csrc/backend_ops/

* set MMDEPLOY_BUILD_SDK OFF

* change custom ops build command

* add spdlog installation command

* update docs on how to checkout pybind11

* move bicubic_interpolate to backend_ops/tensorrt directory

* remove useless code

* correct cmake

* fix typo

* fix typo

* fix install directory

* correct sdk's readme

* set cub dir when cuda version < 11.0

* change directory where clang-format will apply to

* fix build command

* add .clang-format

* change clang-format style from google to file

* reformat csrc/backend_ops

* format sdk's code

* turn off clang-format for some files

* add -Xcompiler=-fno-gnu-unique

* fix trt topk initialize

* check in config for sdk demo

* update cmake script and csrc's readme

* correct config's path

* add cuda include directory, otherwise compile failed in case of tensorrt8.2

* clang-format onnx2ncnn.cpp

Co-authored-by: zhangli <[email protected]>
Co-authored-by: grimoire <[email protected]>

Author: 3 people

.clang-format

@@ -0,0 +1,156 @@
+---
+Language:        Cpp
+# BasedOnStyle:  Google
+AccessModifierOffset: -1
+AlignAfterOpenBracket: Align
+AlignConsecutiveMacros: false
+AlignConsecutiveAssignments: false
+AlignConsecutiveDeclarations: false
+AlignEscapedNewlines: Left
+AlignOperands:   true
+AlignTrailingComments: true
+AllowAllArgumentsOnNextLine: true
+AllowAllConstructorInitializersOnNextLine: true
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortBlocksOnASingleLine: false
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: All
+AllowShortLambdasOnASingleLine: All
+AllowShortIfStatementsOnASingleLine: WithoutElse
+AllowShortLoopsOnASingleLine: true
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: true
+AlwaysBreakTemplateDeclarations: Yes
+BinPackArguments: true
+BinPackParameters: true
+BraceWrapping:
+  AfterCaseLabel:  false
+  AfterClass:      false
+  AfterControlStatement: false
+  AfterEnum:       false
+  AfterFunction:   false
+  AfterNamespace:  false
+  AfterObjCDeclaration: false
+  AfterStruct:     false
+  AfterUnion:      false
+  AfterExternBlock: false
+  BeforeCatch:     false
+  BeforeElse:      false
+  IndentBraces:    false
+  SplitEmptyFunction: true
+  SplitEmptyRecord: true
+  SplitEmptyNamespace: true
+BreakBeforeBinaryOperators: None
+BreakBeforeBraces: Attach
+BreakBeforeInheritanceComma: false
+BreakInheritanceList: BeforeColon
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializersBeforeComma: false
+BreakConstructorInitializers: BeforeColon
+BreakAfterJavaFieldAnnotations: false
+BreakStringLiterals: true
+ColumnLimit:     100
+CommentPragmas:  '^ IWYU pragma:'
+CompactNamespaces: false
+ConstructorInitializerAllOnOneLineOrOnePerLine: true
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DerivePointerAlignment: true
+DisableFormat:   false
+ExperimentalAutoDetectBinPacking: false
+FixNamespaceComments: true
+ForEachMacros:
+  - foreach
+  - Q_FOREACH
+  - BOOST_FOREACH
+IncludeBlocks:   Regroup
+IncludeCategories:
+  - Regex:           '^<ext/.*\.h>'
+    Priority:        2
+  - Regex:           '^<.*\.h>'
+    Priority:        1
+  - Regex:           '^<.*'
+    Priority:        2
+  - Regex:           '.*'
+    Priority:        3
+IncludeIsMainRegex: '([-_](test|unittest))?$'
+IndentCaseLabels: true
+IndentPPDirectives: None
+IndentWidth:     2
+IndentWrappedFunctionNames: false
+JavaScriptQuotes: Leave
+JavaScriptWrapImports: true
+KeepEmptyLinesAtTheStartOfBlocks: false
+MacroBlockBegin: ''
+MacroBlockEnd:   ''
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: None
+ObjCBinPackProtocolList: Never
+ObjCBlockIndentWidth: 2
+ObjCSpaceAfterProperty: false
+ObjCSpaceBeforeProtocolList: true
+PenaltyBreakAssignment: 2
+PenaltyBreakBeforeFirstCallParameter: 1
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakString: 1000
+PenaltyBreakTemplateDeclaration: 10
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 200
+PointerAlignment: Left
+RawStringFormats:
+  - Language:        Cpp
+    Delimiters:
+      - cc
+      - CC
+      - cpp
+      - Cpp
+      - CPP
+      - 'c++'
+      - 'C++'
+    CanonicalDelimiter: ''
+    BasedOnStyle:    google
+  - Language:        TextProto
+    Delimiters:
+      - pb
+      - PB
+      - proto
+      - PROTO
+    EnclosingFunctions:
+      - EqualsProto
+      - EquivToProto
+      - PARSE_PARTIAL_TEXT_PROTO
+      - PARSE_TEST_PROTO
+      - PARSE_TEXT_PROTO
+      - ParseTextOrDie
+      - ParseTextProtoOrDie
+    CanonicalDelimiter: ''
+    BasedOnStyle:    google
+ReflowComments:  true
+SortIncludes:    true
+SortUsingDeclarations: true
+SpaceAfterCStyleCast: false
+SpaceAfterLogicalNot: false
+SpaceAfterTemplateKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCpp11BracedList: false
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeInheritanceColon: true
+SpaceBeforeParens: ControlStatements
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 2
+SpacesInAngles:  false
+SpacesInContainerLiterals: true
+SpacesInCStyleCastParentheses: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+Standard:        Auto
+StatementMacros:
+  - Q_UNUSED
+  - QT_REQUIRE_VERSION
+TabWidth:        8
+UseTab:          Never
+...

.github/workflows/lint.yml

@@ -24,9 +24,9 @@ jobs:
       - name: Format c/cuda codes with clang-format
         uses: DoozyX/[email protected]
         with:
-          source: backend_ops
+          source: csrc
           extensions: h,c,cpp,hpp,cu,cuh
-          style: google
+          style: file
       - name: Check docstring coverage
         run: |
           pip install interrogate

.gitignore

@@ -121,3 +121,10 @@ work_dirs/
 *.pth
 *.py~
 *.sh~
+
+#clion's build directory
+/cmake-build-debug
+/cmake-build-release
+
+# install directory
+/install

.gitmodules

@@ -1,3 +1,6 @@
 [submodule "third_party/cub"]
 	path = third_party/cub
 	url = https://github.com/NVIDIA/cub.git
+[submodule "third_party/pybind11"]
+	path = third_party/pybind11
+	url = https://github.com/pybind/pybind11.git

.pre-commit-config.yaml

@@ -43,6 +43,8 @@ repos:
     rev: v2.1.0
     hooks:
       - id: codespell
+        args: ["--skip=third_party/*,*.proto"]
+
   - repo: https://github.com/myint/docformatter
     rev: v1.3.1
     hooks:

CMakeLists.txt

@@ -1,43 +1,84 @@
+# Copyright (c) OpenMMLab. All rights reserved.
+if (NOT DEFINED CMAKE_INSTALL_PREFIX)
+    set(CMAKE_INSTALL_PREFIX "${CMAKE_BINARY_DIR}/install" CACHE PATH "MMDeploy's installation directory")
+endif ()
+message(STATUS "CMAKE_INSTALL_PREFIX: ${CMAKE_INSTALL_PREFIX}")
+
 cmake_minimum_required(VERSION 3.14)
-project(mmdeploy_backend_ops)
-
-# ONNXRUNTIME config
-
-# enable onnxruntime
-option(BUILD_ONNXRUNTIME_OPS "enable ONNXRUNTIME ops" OFF)
-# ONNXRUNTIME search path
-if(BUILD_ONNXRUNTIME_OPS)
-  if(NOT DEFINED ONNXRUNTIME_DIR)
-    set(ONNXRUNTIME_DIR $ENV{ONNXRUNTIME_DIR})
-  endif()
-  if(NOT ONNXRUNTIME_DIR)
-    message(ERROR " ONNXRUNTIME_DIR is not found.")
-  endif()
-endif()
-
-# TensorRT config
-
-# enable tensorrt
-option(BUILD_TENSORRT_OPS "enable TensorRT ops" OFF)
-# TensorRT search path
-if(BUILD_TENSORRT_OPS)
-  if(NOT DEFINED TENSORRT_DIR)
-    set(TENSORRT_DIR $ENV{TENSORRT_DIR})
-  endif()
-endif()
-
-# NCNN config
-
-# enable ncnn
-option(BUILD_NCNN_OPS "enable NCNN ops" OFF)
-# NCNN search path
-if(BUILD_NCNN_OPS)
-  if(NOT DEFINED NCNN_DIR)
-    set(NCNN_DIR $ENV{NCNN_DIR})
-  endif()
-  if(NOT NCNN_DIR)
-    message(ERROR " NCNN_DIR is not found.")
-  endif()
-endif()
-
-add_subdirectory(backend_ops)
+project(MMDeploy VERSION 0.1.0)
+
+set(CMAKE_CXX_STANDARD 17)
+
+set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
+set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
+set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
+
+# options
+option(MMDEPLOY_BUILD_MODEL_OPTIMIZER "build MMDeploy's model optimizer" ON)
+option(MMDEPLOY_BUILD_SDK "build MMDeploy's SDK" OFF)
+option(MMDEPLOY_ZIP_MODEL "support sdk model in zip format" OFF)
+option(MMDEPLOY_BUILD_TEST "build MMDeploy's csrc's unittest" OFF)
+set(MMDEPLOY_TARGET_DEVICES
+        "cpu" CACHE STRING "MMDeploy's target devices")
+set(MMDEPLOY_TARGET_BACKENDS "" CACHE STRING "MMDeploy's target inference engines")
+set(MMDEPLOY_CODEBASES "" CACHE STRING "select OpenMMLab's codebases")
+#set(MMDEPLOY_TRANSFORM_PLATFORMS "cpu" CACHE STRING "select transform operations' platform")
+
+if (NOT CMAKE_BUILD_TYPE)
+    set(CMAKE_BUILD_TYPE Release CACHE STRING "choose 'Release' as default build type" FORCE)
+endif ()
+
+include(${CMAKE_SOURCE_DIR}/cmake/common.cmake)
+# set INTERFACE target to gather linked modules
+add_library(MMDeployStaticModules INTERFACE)
+add_library(MMDeployDynamicModules INTERFACE)
+
+add_subdirectory(csrc)
+if (MMDEPLOY_BUILD_TEST)
+    add_subdirectory(tests/test_csrc)
+endif ()
+
+if (MMDEPLOY_BUILD_SDK)
+    # get static modules and dynamic modules from MMDeployStaticModules and MMDeployDynamicModules, respectively
+    set(STATIC_MODULES)
+    get_target_property(STATIC_MODULES MMDeployStaticModules INTERFACE_LINK_LIBRARIES)
+    get_target_list("${STATIC_MODULES}" FILTERED_MODULES)
+    set(MMDEPLOY_STATIC_MODULES "${FILTERED_MODULES}" CACHE STRING "MMDeploy's static modules")
+    message(STATUS "MMDEPLOY_STATIC_MODULES: ${MMDEPLOY_STATIC_MODULES}")
+
+    set(DYNAMIC_MODULES)
+    get_target_property(DYNAMIC_MODULES MMDeployDynamicModules INTERFACE_LINK_LIBRARIES)
+    get_target_list("${DYNAMIC_MODULES}" FILTERED_MODULES)
+    set(MMDEPLOY_DYNAMIC_MODULES "${FILTERED_MODULES}" CACHE STRING "MMDeploy's dynamic modules")
+    message(STATUS "MMDEPLOY_DYNAMIC_MODULES: ${MMDEPLOY_DYNAMIC_MODULES}")
+
+    # export MMDeploy package
+    install(EXPORT MMDeployTargets
+            # NAMESPACE mmdeploy::
+            FILE MMDeployTargets.cmake
+            #EXPORT_LINK_INTERFACE_LIBRARIES
+            DESTINATION lib/cmake/MMDeploy)
+
+    include(CMakePackageConfigHelpers)
+    # generate the config file that is includes the exports
+    configure_package_config_file(${CMAKE_SOURCE_DIR}/cmake/MMDeployConfig.cmake.in
+            "${CMAKE_CURRENT_BINARY_DIR}/MMDeployConfig.cmake"
+            INSTALL_DESTINATION "lib/cmake"
+            NO_SET_AND_CHECK_MACRO
+            NO_CHECK_REQUIRED_COMPONENTS_MACRO
+            )
+
+    write_basic_package_version_file(
+            "${CMAKE_CURRENT_BINARY_DIR}/MMDeployConfigVersion.cmake"
+            VERSION "${MMDeploy_VERSION_MAJOR}.${MMDeploy_VERSION_MINOR}"
+            COMPATIBILITY AnyNewerVersion
+    )
+
+    install(FILES
+            ${CMAKE_CURRENT_BINARY_DIR}/MMDeployConfig.cmake
+            ${CMAKE_CURRENT_BINARY_DIR}/MMDeployConfigVersion.cmake
+            DESTINATION lib/cmake/MMDeploy
+            )
+
+    install(DIRECTORY ${CMAKE_SOURCE_DIR}/demo/csrc/ DESTINATION example)
+endif ()