[update] BIG UPDATE

Author: jamesnulliu

.clangd

@@ -1,25 +1,10 @@
-CompileFlags:
-  Add: 
-    # [TODO] Maybe add a python script to change cuda path automatically?
-    # You may need to change this to /usr/local/cuda if using Linux:
-    # - --cuda-path=C:/Program Files/NVIDIA GPU Computing Toolkit/CUDA/v12.5/
-    - --no-cuda-version-check
-  Remove:
-    - -ccbin
-    - -forward-unknown-to-host-compiler
-    - -rdc=true
-    - -gencode
-    - --generate-code*
-    - -Xcudafe
-    - --diag_suppress=*
-    - --expt-relaxed-constexpr
-    - --expt-extended-lambda
-    - -Xcompiler*
-    - -arch=*
+Index:
+  Background: Build
+  StandardLibrary: Yes
 
 Diagnostics:
-  UnusedIncludes: Strict
-  MissingIncludes: Strict
+  UnusedIncludes: None
+  MissingIncludes: None
 
   ClangTidy:
     Add: [
@@ -33,16 +18,48 @@ Diagnostics:
       readability-isolate-declaration,
       readability-identifier-length,
       readability-magic-numbers,
+      readability-function-cognitive-complexity,
+      readability-redundant-access-specifiers,
+      modernize-avoid-c-arrays,
+      readability-math-missing-parentheses,
     ]
 
     CheckOptions:
-      readability-identifier-naming.VariableCase: lowerCamelCase
-      readability-identifier-naming.ProtectedMemberCase: lowerCamelCase
-      readability-identifier-naming.PrivateMemberCase: lowerCamelCase
-      readability-identifier-naming.PublicMemberCase: lowerCamelCase
+      readability-identifier-naming.VariableCase: aNy_CasE
+      readability-identifier-naming.ProtectedMemberCase: aNy_CasE
+      readability-identifier-naming.PrivateMemberCase: aNy_CasE
+      readability-identifier-naming.PublicMemberCase: aNy_CasE
       readability-identifier-naming.NamespaceCase: lower_case
-      readability-identifier-naming.EnumCase: lowerCamelCase
+      readability-identifier-naming.EnumCase: CamelCase
       readability-identifier-naming.ClassCase: CamelCase
       readability-identifier-naming.StructCase: CamelCase
-      readability-identifier-naming.FunctionCase: lowerCamelCase
-      readability-identifier-naming.ClassMethodCase: lowerCamelCase
+      readability-identifier-naming.FunctionCase: camelBack
+      readability-identifier-naming.ClassMethodCase: camelBack
+
+CompileFlags:
+  Add: 
+    - -Wall
+    - -Wextra
+  Remove:
+    - -ccbin
+    - -forward-unknown-to-host-compiler
+    - --generate-code*
+    - -arch*
+    - -rdc=true
+    - -Xcudafe
+    - --diag_suppress=*
+    - --expt-relaxed-constexpr
+    - --expt-extended-lambda
+    - -gencode
+    - -Xcompiler*
+    - -fmodules*
+    - -fmodule-mapper*
+    - -fdeps-format*
+
+---
+
+If:
+  PathMatch: [.*\.cu, .*\.cuh]
+CompileFlags:
+  Add: 
+    - --cuda-gpu-arch=sm_89

.gitignore

@@ -164,7 +164,8 @@ cython_debug/
 # Not ignore anything from ./csrc
 !/csrc/*
 # But ignore ./build in case someone build with -B ./csrc/build (better not do this)
-/csrc/build
 
 # Ignore installation directory
 /example_package/_torch_ops
+
+/src/simple_py/extended_clib

.vscode/extensions.json

@@ -4,7 +4,7 @@
         "twxs.cmake",  // cmake
         "ms-vscode.cpptools",  // C/C++
         "ms-python.python",  // Python
-        "ms-python.black-formatter",  // Python formatter
         "njpwerner.autodocstring",  // Python docstring generator
+        "charliermarsh.ruff",
     ]
 }

README.md

@@ -6,21 +6,20 @@ A Template of Python Project in Visual Studio Code with Github Actions CI/CD (Es
 Create a new conda environment:
 
 ```bash
-conda create -n pytemplate python=3.12
-conda activate pytemplate
+$ uv venv -p 3.12
+$ source .venv/bin/activate
 ```
 
-Install `example_package`:
+Install `simple_py`:
 
 ```bash
-pip3 install --no-build-isolation .
+$ uv install -v .
 ```
 
-`torch.ops.example_package.vector_add` will be available after installation; See [test.py](test/test.py) for usage.
+`torch.ops.simple_py.vector_add` will be available after installation; See [test.py](test/test.py) for usage.
 
 ## How to Test
 
 ```bash
-conda activate pytemplate
 python test/test.py
 ```

configs/loggers.yml

@@ -0,0 +1,35 @@
+__default__:
+  level: INFO
+  to_console: true
+  save_path: null
+  mode: null
+  max_bytes: null
+  backup_count:  null
+  log_prefix: "[%(asctime)s,%(msecs)03d][pid=%(process)d][%(levelname)s]"
+  log_data: " > %(message)s"
+  log_suffix: ""
+  date_fmt: "%y-%m-%d %H:%M:%S"
+
+BASIC:
+  level: INFO
+  to_console: true
+  save_path: null
+  mode: null
+  max_bytes: null
+  backup_count:  null
+  log_prefix: "[%(asctime)s,%(msecs)03d][pid=%(process)d][%(levelname)s]"
+  log_data: " > %(message)s"
+  log_suffix: ""
+  date_fmt: "%y-%m-%d %H:%M:%S"
+
+DEBUG:
+  level: DEBUG
+  to_console: true
+  save_path: logs/debug.log
+  mode: "a"
+  max_bytes: 1048576
+  backup_count: 10 
+  log_prefix: "[%(asctime)s,%(msecs)03d][pid=%(process)d][%(levelname)s][%(module)s:L%(lineno)d]"
+  log_data: " > %(message)s"
+  log_suffix: ""
+  date_fmt: "%y-%m-%d %H:%M:%S"

csrc/CMakeLists.txt

@@ -2,29 +2,32 @@
 cmake_minimum_required(VERSION 3.30)
 
 # Project Name and version
-project(VSC-CMAKE-CXX-TEMPLATE VERSION 1.0.0)
+project(SIMPLE_PY VERSION 1.0.0)
 
 # Common utility functions
 include(${PROJECT_SOURCE_DIR}/cmake/utils/common.cmake)
 
 # @see "./cmake/utils/variables.cmake"
 set_default_values(
     # CMake project namespace:
-    # All the libs should have a alias with this namespace
-    # [NOTE] Change this to your own namespace
-    PROJECT_NAMESPACE "_template_project_name_::"
+    #   All the libs should have a alias with this namespace
+    PROJECT_NAMESPACE "simple_py::"
+    STDOUT_IS_TERMINAL OFF
+    CMAKE_EXECUTABLE_SUFFIX ""
 )
 
 # Utility functions for installing libraries:
 include(${PROJECT_SOURCE_DIR}/cmake/utils/lib-install.cmake)
 
 # Compiler configurations for cpp, e.g., g++, clang++, msvc(cl), etc.
 include(${PROJECT_SOURCE_DIR}/cmake/compilers/cxx-compiler-configs.cmake)
-
-# Compiler configurations for Python and PyTorch(with CUDA):
+# Compiler configurations for CUDA:
 include(${PROJECT_SOURCE_DIR}/cmake/compilers/cuda-compiler-configs.cmake)
+
+# Find other libraries:
 include(${PROJECT_SOURCE_DIR}/cmake/libraries/libpython.cmake)
 include(${PROJECT_SOURCE_DIR}/cmake/libraries/libtorch.cmake)
+include(${PROJECT_SOURCE_DIR}/cmake/libraries/libpybind11.cmake)
 
 add_subdirectory(${PROJECT_SOURCE_DIR}/lib)
 add_subdirectory(${PROJECT_SOURCE_DIR}/test)

csrc/cmake/cmake-parameters.md

@@ -35,7 +35,7 @@
   Default: *Auto-Detect*.
 - `PROJECT_NAMESPACE`: Project namespace; Library targets should have an alias with project namespace as the prefix.  
   See: [CMakelists.txt](../CMakeLists.txt).  
-  Default: `_template_project_name_`;
+  Default: `_simple_py_`;
 - `STACK_SIZE`: Stack size for the executable targets (if any).  
   See: [cmake/compilers/cxx-compiler-configs.cmake](../cmake/compilers/cxx-compiler-configs.cmake).  
   Default: `1048576` (Bytes).

csrc/cmake/compilers/cuda-compiler-configs.cmake

@@ -2,12 +2,12 @@
 # @file compiler-configs-cuda.cmake
 # @brief Compiler configurations for cuda.
 #
-# @note Several parameters SHOULD be set BEFORE including this file:
+# @note Values SHOULD be set BEFORE including this file:
 #         - `ENV{NVCC_CCBIN}`: CUDA Compiler bindir. Default: auto-detected.
 #         - `CMAKE_CUDA_STANDARD`: CUDA Standard. Default: 20.
 # ==================================================================================================
 
-include(${PROJECT_SOURCE_DIR}/cmake/utils/logging.cmake)
+include(${CMAKE_CURRENT_LIST_DIR}/../utils/logging.cmake)
 
 enable_language(CUDA)
 
@@ -22,6 +22,6 @@ set(CMAKE_CUDA_SEPARABLE_COMPILATION ON)
 set(CMAKE_CUDA_ARCHITECTURES native)
 log_info("CMAKE_CUDA_STANDARD: ${CMAKE_CUDA_STANDARD}")
 
-set(CMAKE_CUDA_FLAGS "${CMAKE_CUDA_FLAGS} --expt-relaxed-constexpr")
-set(CMAKE_CUDA_FLAGS_RELEASE "${CMAKE_CUDA_FLAGS_RELEASE} -O3")
-set(CMAKE_CUDA_FLAGS_DEBUG "${CMAKE_CUDA_FLAGS_DEBUG} -lineinfo")
+string(APPEND CMAKE_CUDA_FLAGS " --expt-relaxed-constexpr")
+string(APPEND CMAKE_CUDA_FLAGS_RELWITHDEBINFO " -lineinfo")
+string(APPEND CMAKE_CUDA_FLAGS_DEBUG " -lineinfo")

csrc/cmake/compilers/cxx-compiler-configs.cmake

@@ -2,60 +2,59 @@
 # @file compiler-configs-cpp.cmake
 # @brief Compiler configurations for the host.
 #
-# @note Several parameters SHOULD be set BEFORE including this file:
+# @note Values MUST be set BEFORE including this file:
+#         - `STDOUT_IS_TERMINAL`: Whether stdout is a terminal.
+#       Values SHOULD be set BEFORE including this file:
 #         - `ENV{CXX}`: C++ Compiler. Default: auto-detected.
 #         - `CMAKE_CXX_STANDARD`: C++ Standard. Default: 20.
 #         - `CMAKE_CXX_SCAN_FOR_MODULES`: Whether to use modules. Default: OFF.
 #         - `STACK_SIZE`: Stack size for the executable. Default: 1048576 (1MB).
 # ==================================================================================================
 
-include(${PROJECT_SOURCE_DIR}/cmake/utils/common.cmake)
+include(${CMAKE_CURRENT_LIST_DIR}/../utils/common.cmake)
 
-set_default_values(CMAKE_CXX_SCAN_FOR_MODULES OFF)
 enable_language(CXX)
 
-# Generate compile_commands.json in build directory
-set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+set(CMAKE_CXX_STANDARD_REQUIRED   ON)
 
-set(CMAKE_CXX_STANDARD_REQUIRED ON)
-log_info("CMAKE_CXX_STANDARD: ${CMAKE_CXX_STANDARD}")
+set_default_values(
+    CMAKE_CXX_STANDARD            20
+    CMAKE_CXX_SCAN_FOR_MODULES    OFF
+    STACK_SIZE                    1048576
+)
 
-# Set stack size
-if(NOT DEFINED STACK_SIZE)
-    set(STACK_SIZE 1048576)  # 1MB by default
-endif()
+log_info("CMAKE_CXX_STANDARD: ${CMAKE_CXX_STANDARD}")
+log_info("CMAKE_CXX_SCAN_FOR_MODULES: ${CMAKE_CXX_SCAN_FOR_MODULES}")
+log_info("STACK_SIZE: ${STACK_SIZE}")
 
-# Compiler flags for MSVC
+# MSVC ----------------------------------------------------------------------------------------------------------------
 if (CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
     string(APPEND CMAKE_CXX_FLAGS " /permissive- /Zc:forScope /openmp /Zc:__cplusplus")
-    string(APPEND CMAKE_CXX_FLAGS_RELEASE " /O2")
-    string(APPEND CMAKE_CXX_FLAGS_DEBUG " /Zi")
-    # Set stack size
     string(APPEND CMAKE_EXE_LINKER_FLAGS " /STACK:${STACK_SIZE}")
-# Compiler flags for Clang
+# Clang ---------------------------------------------------------------------------------------------------------------
 elseif(CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
-    string(APPEND CMAKE_CXX_FLAGS " -fopenmp -Wall -Wextra -Werror")
-    string(APPEND CMAKE_CXX_FLAGS_RELEASE " -O3")
-    string(APPEND CMAKE_CXX_FLAGS_DEBUG " -g")
-    # Set stack size
+    string(APPEND CMAKE_CXX_FLAGS " -stdlib=libc++ -fopenmp -Wall -Wextra -Werror")
     if (WIN32)
         string(APPEND CMAKE_EXE_LINKER_FLAGS " -Wl,-stack,${STACK_SIZE}")
     else()
         string(APPEND CMAKE_EXE_LINKER_FLAGS " -Wl,-zstack-size=${STACK_SIZE}")
     endif()
-# Compiler flags for GNU
+# GNU -----------------------------------------------------------------------------------------------------------------
 elseif(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
     string(APPEND CMAKE_CXX_FLAGS " -fopenmp -Wall -Wextra -Werror")
-    string(APPEND CMAKE_CXX_FLAGS_RELEASE " -O3")
-    string(APPEND CMAKE_CXX_FLAGS_DEBUG " -g")
-    # Set stack size
     if (WIN32)
         string(APPEND CMAKE_EXE_LINKER_FLAGS " -Wl,--stack,${STACK_SIZE}")
     else()
         string(APPEND CMAKE_EXE_LINKER_FLAGS " -Wl,-zstack-size=${STACK_SIZE}")
     endif()
-# @todo @jamesnulliu
-# |- Add compiler flags for other compilers
 else()
     log_fatal("Unsupported compiler")
+endif()
+
+if(STDOUT_IS_TERMINAL)
+    add_compile_options(
+        $<$<CXX_COMPILER_ID:GNU>:-fdiagnostics-color=always>
+        $<$<CXX_COMPILER_ID:Clang>:-fcolor-diagnostics>
+        $<$<CXX_COMPILER_ID:MSVC>:/FC>
+    )
 endif()