DRAFT initial circle-mlir project

seanshpark · seanshpark · commit 2944f3a0cf29 · 2025-03-17T08:11:57.000+09:00
on-going draft to introduce initial circle-mlir project.

Signed-off-by: SaeHie Park &lt;saehie.park@gmail.com&gt;
diff --git a/circle-mlir/Makefile.sample b/circle-mlir/Makefile.sample
@@ -15,6 +15,9 @@ endif
 # TODO error handle if not found
 PYTHON3_PATH=$(shell dirname $(PYTHON3_CMD))
 
+# NOTE CIRCLEM_LIR_XXX is used for CMakeLists
+#      CIRCLEMLIR_XXX is used in this Makefile
+
 CIRCLEMLIR_BUILD_DEBUG?=build/debug
 CIRCLEMLIR_BUILD_REL?=build/release
 CIRCLEMLIR_BUILD_COV?=build/coverage
diff --git a/circle-mlir/README.md b/circle-mlir/README.md
@@ -169,6 +169,23 @@ make testcov
 make gencov
 ```
 
+## Dump debug logs
+
+To see logs during conversion with `onnx2circle` tool, set `CM_PASS_DUMP=1` for
+preprocessing ONNX and ONNX to circle conversion, or set `CM_PASS_DUMP=2` to see
+additional logs for circle rewrite.
+
+```
+CM_PASS_DUMP=2 onnx2circle input.onnx output.circle
+```
+
+You can give `-debug` option to see general MLIR logs or `-debug-only=o2c`
+option to see only logs from onnx2circle.
+
+```
+onnx2circle -debug-only=o2c input.onnx output.circle
+```
+
 ## TensorFlow source code
 
 Some source codes are referenced from TensorFlow and the file path is added to
diff --git a/circle-mlir/circle-mlir/tools-test/circle-impexp-test/test.lst b/circle-mlir/circle-mlir/tools-test/circle-impexp-test/test.lst
@@ -6,3 +6,27 @@
 
 AddModel(Add_F32_R4)
 AddModel(Add_F32_R4_C1)
+AddModel(Conv2d_F32_R4)
+AddModel(Conv2d_F32_R4_nobias)
+AddModel(Conv2d_F32_R4_k33)
+AddModel(Conv2d_F32_R4_p11)
+AddModel(Conv2d_F32_R4_p10)
+# TODO AddModel(Conv2d_F32_R4_g2)
+# TODO AddModel(Conv2d_F32_R4_g5)
+AddModel(Conv2d_F32_R4_s2)
+AddModel(Conv2d_F32_R4_dil)
+# TODO AddModel(Conv2d_F32_R4_dil_g2)
+AddModel(Pad_Constant2d_F32_R4)
+# TODO AddModel(Pad_Constant2d_F32_R4_v14)
+AddModel(Pad_Constant2d_F32_R4_1)
+AddModel(Pad_Constant2d_F32_R4_t4)
+AddModel(Pad_Constant2d_F32_R4_t8)
+AddModel(Reshape_F32_R4_1)
+AddModel(Reshape_F32_R4_2)
+AddModel(Reshape_F32_R4_3)
+AddModel(Reshape_F32_R4_4)
+AddModel(Reshape_F32_R4_5)
+AddModel(Reshape_F32_R4_6)
+AddModel(Shape_F32_R4)
+AddModel(Transpose_F32_R4)
+AddModel(Transpose_F32_R4_pm)
diff --git a/circle-mlir/circle-mlir/tools-test/onnx2circle-models/CMakeLists.txt b/circle-mlir/circle-mlir/tools-test/onnx2circle-models/CMakeLists.txt
@@ -33,6 +33,30 @@ macro(AddModel MODEL_NAME)
   list(APPEND FILE_DEPS_VALCHK "${TEST_CIRCLE_MODEL_DST}")
 endmacro(AddModel)
 
+macro(AddDownloadModel MODEL_NAME)
+  # copy to build folder only when source file exist
+  set(TEST_ONNX_MODEL_SRC "${DOWNLOAD_ONNX_PATH}/${MODEL_NAME}.onnx")
+  set(TEST_ONNX_MODEL_DST "${CMAKE_CURRENT_BINARY_DIR}/${MODEL_NAME}.onnx")
+  if(EXISTS ${TEST_ONNX_MODEL_SRC})
+    add_custom_command(
+      OUTPUT ${TEST_ONNX_MODEL_DST}
+      COMMAND ${CMAKE_COMMAND} -E copy "${TEST_ONNX_MODEL_SRC}" "${TEST_ONNX_MODEL_DST}"
+      DEPENDS ${TEST_ONNX_MODEL_SRC}
+      COMMENT "onnx2circle-models: prepare ${MODEL_NAME}.onnx"
+    )
+
+    set(TEST_CIRCLE_MODEL_DST "${CMAKE_CURRENT_BINARY_DIR}/${MODEL_NAME}.circle")
+    add_custom_command(
+      OUTPUT ${TEST_CIRCLE_MODEL_DST}
+      COMMAND "$<TARGET_FILE:onnx2circle>" "${OPTION_O2C_SINGLE}" "${TEST_ONNX_MODEL_DST}" "${TEST_CIRCLE_MODEL_DST}"
+      DEPENDS ${TEST_ONNX_MODEL_DST} onnx2circle
+      COMMENT "onnx2circle-models: generate ${MODEL_NAME}.circle"
+    )
+
+    list(APPEND FILE_DEPS_VALCHK "${TEST_CIRCLE_MODEL_DST}")
+  endif()
+endmacro(AddDownloadModel)
+
 # Read "test.lst"
 include("test.lst")
 # Read "test.local.lst" if exists
diff --git a/circle-mlir/circle-mlir/tools-test/onnx2circle-value-test/CMakeLists.txt b/circle-mlir/circle-mlir/tools-test/onnx2circle-value-test/CMakeLists.txt
@@ -30,6 +30,7 @@ COPY_SCRIPT(util_validation.py)
 
 # AddModel used in test.lst
 set(UNIT_TEST_MODELS )
+set(UNIT_TEST_TOL_MODELS )
 
 get_target_property(ONNX_ARTIFACTS_BIN_PATH gen_onnx_target BINARY_DIR)
 get_target_property(CIRCLE_ARTIFACTS_BIN_PATH onnx2circle_models_target BINARY_DIR)
@@ -59,6 +60,62 @@ macro(AddModel MODEL_NAME)
   list(APPEND FILE_DEPS_VALCHK "${TEST_CIRCLE_MODEL_DST}")
 endmacro(AddModel)
 
+macro(AddDownloadModel MODEL_NAME)
+  # copy ONNX to build folder
+  set(TEST_ONNX_MODEL_SRC "${DOWNLOAD_ONNX_PATH}/${MODEL_NAME}.onnx")
+  set(TEST_ONNX_MODEL_DST "${CMAKE_CURRENT_BINARY_DIR}/${MODEL_NAME}.onnx")
+
+  if(EXISTS ${TEST_ONNX_MODEL_SRC})
+    add_custom_command(
+      OUTPUT ${TEST_ONNX_MODEL_DST}
+      COMMAND ${CMAKE_COMMAND} -E copy "${TEST_ONNX_MODEL_SRC}" "${TEST_ONNX_MODEL_DST}"
+      DEPENDS ${TEST_ONNX_MODEL_SRC}
+      COMMENT "onnx2circle-value-test: prepare ${MODEL_NAME}.onnx"
+    )
+    # copy Circle to build folder
+    set(TEST_CIRCLE_MODEL_SRC "${CIRCLE_ARTIFACTS_BIN_PATH}/${MODEL_NAME}.circle")
+    set(TEST_CIRCLE_MODEL_DST "${CMAKE_CURRENT_BINARY_DIR}/${MODEL_NAME}.circle")
+    add_custom_command(
+      OUTPUT ${TEST_CIRCLE_MODEL_DST}
+      COMMAND ${CMAKE_COMMAND} -E copy "${TEST_CIRCLE_MODEL_SRC}" "${TEST_CIRCLE_MODEL_DST}"
+      DEPENDS ${TEST_CIRCLE_MODEL_SRC}
+      COMMENT "onnx2circle-value-test: prepare ${MODEL_NAME}.circle"
+    )
+
+    list(APPEND UNIT_TEST_MODELS "${MODEL_NAME}")
+    list(APPEND FILE_DEPS_VALCHK "${TEST_ONNX_MODEL_DST}")
+    list(APPEND FILE_DEPS_VALCHK "${TEST_CIRCLE_MODEL_DST}")
+  endif()
+endmacro(AddDownloadModel)
+
+macro(AddDownloadModelTol MODEL_NAME RTOL ATOL)
+  # copy ONNX to build folder
+  set(TEST_ONNX_MODEL_SRC "${DOWNLOAD_ONNX_PATH}/${MODEL_NAME}.onnx")
+  set(TEST_ONNX_MODEL_DST "${CMAKE_CURRENT_BINARY_DIR}/${MODEL_NAME}.onnx")
+
+  if(EXISTS ${TEST_ONNX_MODEL_SRC})
+    add_custom_command(
+      OUTPUT ${TEST_ONNX_MODEL_DST}
+      COMMAND ${CMAKE_COMMAND} -E copy "${TEST_ONNX_MODEL_SRC}" "${TEST_ONNX_MODEL_DST}"
+      DEPENDS ${TEST_ONNX_MODEL_SRC}
+      COMMENT "onnx2circle-value-test: prepare ${MODEL_NAME}.onnx"
+    )
+    # copy Circle to build folder
+    set(TEST_CIRCLE_MODEL_SRC "${CIRCLE_ARTIFACTS_BIN_PATH}/${MODEL_NAME}.circle")
+    set(TEST_CIRCLE_MODEL_DST "${CMAKE_CURRENT_BINARY_DIR}/${MODEL_NAME}.circle")
+    add_custom_command(
+      OUTPUT ${TEST_CIRCLE_MODEL_DST}
+      COMMAND ${CMAKE_COMMAND} -E copy "${TEST_CIRCLE_MODEL_SRC}" "${TEST_CIRCLE_MODEL_DST}"
+      DEPENDS ${TEST_CIRCLE_MODEL_SRC}
+      COMMENT "onnx2circle-value-test: prepare ${MODEL_NAME}.circle"
+    )
+
+    list(APPEND UNIT_TEST_TOL_MODELS "${MODEL_NAME} ${RTOL} ${ATOL}")
+    list(APPEND FILE_DEPS_VALCHK "${TEST_ONNX_MODEL_DST}")
+    list(APPEND FILE_DEPS_VALCHK "${TEST_CIRCLE_MODEL_DST}")
+  endif()
+endmacro(AddDownloadModelTol)
+
 # Read "test.lst"
 include("test.lst")
 # Read "test.local.lst" if exists
@@ -76,3 +133,16 @@ foreach(MODEL IN ITEMS ${UNIT_TEST_MODELS})
     COMMAND bash run_value_test.sh ${VENV_PATH} ${TEST_MODEL_BASE}
   )
 endforeach()
+
+foreach(MODEL_INFO IN ITEMS ${UNIT_TEST_TOL_MODELS})
+  separate_arguments(MODEL_INFO_LIST UNIX_COMMAND ${MODEL_INFO})
+  list (GET MODEL_INFO_LIST 0 MODEL)
+  list (GET MODEL_INFO_LIST 1 ATOL)
+  list (GET MODEL_INFO_LIST 2 RTOL)
+
+  set(TEST_MODEL_BASE "${CMAKE_CURRENT_BINARY_DIR}/${MODEL}")
+  add_test(
+    NAME onnx2circle_value_test_${MODEL}
+    COMMAND bash run_value_test.sh ${VENV_PATH} ${TEST_MODEL_BASE} ${ATOL} ${RTOL}
+  )
+endforeach()
diff --git a/circle-mlir/circle-mlir/tools/onnx2circle/TestModels.cmake b/circle-mlir/circle-mlir/tools/onnx2circle/TestModels.cmake
@@ -16,6 +16,21 @@ macro(ConvertUnitModel MLIR_FNAME)
   list(APPEND FILE_DEPS "${TEST_MLIR_MODEL_DST}")
 endmacro(ConvertUnitModel)
 
+set(TEST_NEG_MODELS )
+macro(ConvertUnitModelNEG MLIR_FNAME)
+  # copy to build folder
+  set(TEST_MLIR_MODEL_SRC "${CMAKE_SOURCE_DIR}/models/mlir/${MLIR_FNAME}")
+  set(TEST_MLIR_MODEL_DST "${CMAKE_CURRENT_BINARY_DIR}/models/mlir/${MLIR_FNAME}")
+  add_custom_command(
+    OUTPUT ${TEST_MLIR_MODEL_DST}
+    COMMAND ${CMAKE_COMMAND} -E copy "${TEST_MLIR_MODEL_SRC}" "${TEST_MLIR_MODEL_DST}"
+    DEPENDS ${TEST_MLIR_MODEL_SRC}
+    COMMENT "tools/onnx2circle: prepare mlir/${MLIR_FNAME}"
+  )
+  list(APPEND TEST_NEG_MODELS "${MLIR_FNAME}")
+  list(APPEND FILE_DEPS "${TEST_MLIR_MODEL_DST}")
+endmacro(ConvertUnitModelNEG)
+
 set(VALIDATE_SHAPEINF_MODELS)
 macro(ValidateShapeInf MLIR_FNAME)
   # copy to build folder
@@ -63,6 +78,18 @@ foreach(MODEL IN ITEMS ${TEST_MODELS})
   )
 endforeach()
 
+foreach(MODEL IN ITEMS ${TEST_NEG_MODELS})
+  set(MLIR_MODEL_PATH "${CMAKE_CURRENT_BINARY_DIR}/models/mlir/${MODEL}")
+  set(CIRCLE_MODEL_PATH "${CMAKE_CURRENT_BINARY_DIR}/models/mlir/${MODEL}.circle")
+  add_test(
+    NAME onnx2circle_neg_test_${MODEL}
+    COMMAND "$<TARGET_FILE:onnx2circle>"
+      "${MLIR_MODEL_PATH}"
+      "${CIRCLE_MODEL_PATH}"
+  )
+  set_tests_properties(onnx2circle_neg_test_${MODEL} PROPERTIES WILL_FAIL TRUE)
+endforeach()
+
 foreach(MODEL IN ITEMS ${VALIDATE_SHAPEINF_MODELS})
   set(MLIR_MODEL_PATH "${CMAKE_CURRENT_BINARY_DIR}/models/mlir/${MODEL}")
   set(CIRCLE_MODEL_PATH "${CMAKE_CURRENT_BINARY_DIR}/models/mlir/${MODEL}.circle")
diff --git a/circle-mlir/circle-mlir/tools/onnx2circle/test.lst b/circle-mlir/circle-mlir/tools/onnx2circle/test.lst
@@ -3,6 +3,9 @@
 # ConvertUnitModel(test_mode.mlir)
 #
 
+ConvertUnitModel(Add_F32_0.circle.mlir)
+ConvertUnitModel(Add_F32_1.circle.mlir)
+ConvertUnitModel(Add_F32_2.circle.mlir)
 ConvertUnitModel(Add_F32.onnx.mlir)
 
 # shape inference validation
diff --git a/circle-mlir/externals/CMakeLists.txt b/circle-mlir/externals/CMakeLists.txt
@@ -112,6 +112,10 @@ ExternalProject_Add(externals-llvm-project
   INSTALL_DIR    "${LP_INSTALL_DIR}"
   CMAKE_ARGS     -DLLVM_ENABLE_PROJECTS=mlir
                  -DLLVM_TARGETS_TO_BUILD=host
+                 -DLLVM_ENABLE_TERMINFO=OFF
+                 -DLLVM_ENABLE_ZLIB=OFF
+                 -DLLVM_ENABLE_ZSTD=OFF
+                 -DLLVM_INCLUDE_TESTS=OFF
                  -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
                  -DCMAKE_INSTALL_PREFIX='${LP_INSTALL_DIR}'
                  ${CIRCLE_MLIR_GOLD_OPTION}

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,9 @@`
`3`	`3`	`# ConvertUnitModel(test_mode.mlir)`
`4`	`4`	`#`
`5`	`5`
	`6`	`+ConvertUnitModel(Add_F32_0.circle.mlir)`
	`7`	`+ConvertUnitModel(Add_F32_1.circle.mlir)`
	`8`	`+ConvertUnitModel(Add_F32_2.circle.mlir)`
`6`	`9`	`ConvertUnitModel(Add_F32.onnx.mlir)`
`7`	`10`
`8`	`11`	`# shape inference validation`