Fix Many Things

Author: jamesnulliu

README.md

@@ -3,13 +3,20 @@ A Template of Python Project in Visual Studio Code with Github Actions CI/CD (Es
 
 ## How to Build
 
+Create a new conda environment:
+
 ```bash
 conda create -n pytemplate python=3.12
 conda activate pytemplate
-pip install .
 ```
 
-`torch.ops.example_package.vector_add` will be available after installation.
+Install `example_package`:
+
+```bash
+pip3 install .
+```
+
+`torch.ops.example_package.vector_add` will be available after installation; See [test.py](test/test.py) for usage.
 
 ## How to Test
 

csrc/CMakeLists.txt

@@ -5,7 +5,7 @@ cmake_minimum_required(VERSION 3.30)
 project(VSC-CMAKE-CXX-TEMPLATE VERSION 1.0.0)
 
 ####################################################################################################
-# [!] All CMake Options and Variables MAY Affect the Build Process
+# [NOTE] All CMake Options and Variables MAY Affect the Build Process
 # 
 # In "cmake/utils/logging.cmake":
 #   - `LOG_PREFIX`: The prefix for logging messages
@@ -31,8 +31,8 @@ project(VSC-CMAKE-CXX-TEMPLATE VERSION 1.0.0)
 #   - `BUILD_SHARED_LIBS`: Whether to build shared libraries
 ####################################################################################################
 
-# Utility functions for setting values:
-include(${PROJECT_SOURCE_DIR}/cmake/utils/variables.cmake)
+# Common utility functions
+include(${PROJECT_SOURCE_DIR}/cmake/utils/common.cmake)
 
 # @see "./cmake/utils/variables.cmake"
 set_default_values(
@@ -53,8 +53,4 @@ include(${PROJECT_SOURCE_DIR}/cmake/compilers/cuda-compiler-configs.cmake)
 include(${PROJECT_SOURCE_DIR}/cmake/libraries/libpython.cmake)
 include(${PROJECT_SOURCE_DIR}/cmake/libraries/libtorch.cmake)
 
-
-add_subdirectory(${PROJECT_SOURCE_DIR}/lib)
-
-# # [FIXME] Not support linking modules to an executable target
-# add_subdirectory(${PROJECT_SOURCE_DIR}/test)
+add_subdirectory(${PROJECT_SOURCE_DIR}/lib)

csrc/cmake/utils/variables.cmake csrc/cmake/utils/common.cmakecsrc/cmake/utils/variables.cmake renamed to csrc/cmake/utils/common.cmake

@@ -1,7 +1,6 @@
 include(GNUInstallDirs)
 include(CMakePackageConfigHelpers)
 
-# ==============================================================================
 # @breif Install target libraries
 function(install_libraries LIB_COMPONENT LIB_NAMESPACE LIB_LIST)
     log_info("Libraries to install:")

csrc/cmake/utils/lib-install.cmake

@@ -4,7 +4,7 @@
 #
 # @note This file shoule NEVER include any other file (to avoid circular dependencies).
 # @note Several parameters SHOULD be set BEFORE including this file:
-#         - `LOG_PREFIX`: Prefix for logging. Default: "ᓚᘏᗢ".
+#         - `LOG_PREFIX`: Prefix for logging. Default: "LogPrefix".
 # ==================================================================================================
 
 string(ASCII 27 Esc)

csrc/cmake/utils/logging.cmake

@@ -1,8 +1,8 @@
 include(${PROJECT_SOURCE_DIR}/cmake/utils/logging.cmake)
-include(${PROJECT_SOURCE_DIR}/cmake/utils/variables.cmake)
+include(${PROJECT_SOURCE_DIR}/cmake/utils/common.cmake)
 
 
-# Run python command and get result, output and error
+# @brief Run python command and get result, output and error
 function(run_python PY_COMMAND PY_RESULT PY_OUTPUT PY_ERROR)
     set_default_values(PYTHON_EXECUTABLE "python")
     execute_process(
@@ -14,7 +14,7 @@ function(run_python PY_COMMAND PY_RESULT PY_OUTPUT PY_ERROR)
         ERROR_STRIP_TRAILING_WHITESPACE
     )
     if(NOT _PY_RESULT EQUAL 0)
-        playground_log_fatal("run_python: PY_COMMAND failed:\n${_PY_ERROR}")
+        log_fatal("run_python: PY_COMMAND failed:\nCOMMAND:\n${PY_COMMAND}\nERROR:\n${_PY_ERROR}")
     endif()
     set(${PY_RESULT} "${_PY_RESULT}" PARENT_SCOPE)
     set(${PY_OUTPUT} "${_PY_OUTPUT}" PARENT_SCOPE)

csrc/cmake/utils/run-python.cmake

@@ -20,8 +20,7 @@ windows_prune_env_path() {
     local new_path=""
 
     # Include only the necessary paths
-    # You may want to add "conda" to the list if you are using Anaconda/Miniconda
-    local -a include_paths=("/usr/bin" "cuda" "windows kits" "microsoft visual studio")
+    local -a include_paths=("/usr/bin" "nvidia" "cuda" "windows kits" "microsoft visual studio" "conda")
     local -a filtered_paths
     for path in "${paths[@]}"; do
         local lowercase_path=$(echo "$path" | tr '[:upper:]' '[:lower:]')

csrc/scripts/build.sh

@@ -13,4 +13,4 @@ def load_torch_ops(lib_dir: str):
                 torch.ops.load_library(os.path.join(root, file))
 
 
-load_torch_ops(osp.join(PACKAGE_DIR, "_torch_ops_cxx"))
+load_torch_ops(osp.join(PACKAGE_DIR, "_torch_ops"))