[update] Formatter and Project Structure

Author: jamesnulliu

.github/workflows/ci-auto-format-and-commit.yml

@@ -32,7 +32,7 @@ jobs:
           wget https://apt.llvm.org/llvm.sh && sudo bash ./llvm.sh 20 && rm ./llvm.sh
           sudo apt-get install clang-format-20
           sudo ln -sf $(which clang-format-20) /usr/bin/clang-format
-          python -m pip install black
+          python -m pip install ruff
 
       - name: Run format script
         shell: bash

pyproject.toml

@@ -1,31 +1,12 @@
 [build-system]
-requires = ["setuptools>=42", "wheel", "torch>=2.0.0", "torchvision"]
+requires = ["setuptools>=42", "wheel", "torch>=2.0.0"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "example_package"
 version = "0.1.0"
-description = "A Template of Python Project in Visual Studio Code with Github Actions CI/CD (Especially for PyTorch based Deeplearning Projects)."
 authors = [{ name = "jamesnulliu", email = "jamesnulliu@gmail.com" }]
 readme = "README.md"
 requires-python = ">=3.10, <3.13"
 license = { file = "LICENSE" }
-classifiers = [
-    "Development Status :: 2 - Pre-Alpha",
-    "Environment :: Console",
-    "Intended Audience :: Science/Research",
-    "License :: OSI Approved :: MIT License",
-    "Operating System :: Unix",
-    "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.10",
-    "Programming Language :: Python :: 3.11",
-    "Programming Language :: Python :: 3.12",
-    "Topic :: Software Development :: Libraries :: Python Modules",
-    "Topic :: Scientific/Engineering :: Artificial Intelligence",
-]
-dependencies = [ 
-    "numpy", 
-    "torch>=2.0.0", 
-    "torchvision", 
-    "torchaudio" 
-]
+dynamic = ["dependencies"]

requirements/common.txt

@@ -0,0 +1,2 @@
+torch==2.8.0
+numpy

ruff.toml

@@ -0,0 +1,9 @@
+# Set the maximum line length to 79.
+line-length = 79
+
+[lint]
+# Add the `line-too-long` rule to the enforced rule set.
+extend-select = ["E501"]
+
+# [lint.per-file-ignores]
+# "/path/to/file/that/should/ignore/E501" = ["E501"]

scripts/format.sh

@@ -1,5 +1,5 @@
 # [NOTE] 
-# |- This script is used to format the code using clang-format and black.
+# |- This script is used to format the code using clang-format and ruff.
 # |- Although CI pipeline is configured to format the code after pushing to main,
 # |- it is still recommended to run this script manually before committing the code.
 
@@ -40,7 +40,7 @@ if [[ "$FORMAT_PYTHON" == "true" ]]; then
     echo "Formatting Python files..."
     files=$(git ls-files '*.py')
     if [[ -n "$files" ]]; then
-        black --quiet --fast $files
+        ruff format $files
     fi
 fi
 

setup.py

@@ -1,11 +1,12 @@
 from pathlib import Path
 import sys
-from os import path as osp
 import subprocess
 from setuptools import setup, Extension, find_packages
 from setuptools.command.build_ext import build_ext
 
 """ You may want to change the following variables to customize your project """
+# Root directory:
+ROOT_DIR = Path(__file__).parent
 # Name of your package; Must match the directory name under `CSRC_DIR`:
 PKG_NAME = "example_package"
 # Path to the directory of setup.py file:
@@ -31,7 +32,6 @@ def __init__(self, name, source_dir, build_dir, install_dir):
 
 
 class CMakeBuild(build_ext):
-
     def run(self):
         try:
             subprocess.check_output(["cmake", "--version"])
@@ -42,20 +42,19 @@ def run(self):
             self.build_extension(ext)
 
     def build_extension(self, ext: CMakeExtension):
-        build_args = [
-            "-S",
-            ext.source_dir,
-            "-B",
-            ext.build_dir,
-            "Release",
-        ]
+        build_args = ["-S", ext.source_dir,
+                      "-B", ext.build_dir,
+                      "Release"]  # fmt: skip
         # If Current Platform is Windows
         if sys.platform == "win32":
             subprocess.check_call(
-                [R"csrc\scripts\msvc-bash.bat", R"csrc\scripts\build.sh"] + build_args
+                [R"csrc\scripts\msvc-bash.bat", R"csrc\scripts\build.sh"]
+                + build_args
             )
         else:
-            subprocess.check_call(["bash", "csrc/scripts/build.sh"] + build_args)
+            subprocess.check_call(
+                ["bash", "csrc/scripts/build.sh"] + build_args
+            )
         install_args = [
             "--install",
             ext.build_dir,
@@ -65,6 +64,29 @@ def build_extension(self, ext: CMakeExtension):
         subprocess.check_call(["cmake"] + install_args)
 
 
+def get_requirements(root_dir: Path) -> list[str]:
+    """Get Python package dependencies from requirements.txt."""
+    requirements_dir = root_dir / "requirements"
+
+    def _read_requirements(filename: str) -> list[str]:
+        with open(requirements_dir / filename) as f:
+            requirements = f.read().strip().split("\n")
+        resolved_requirements = []
+        for line in requirements:
+            if line.startswith("-r "):
+                resolved_requirements += _read_requirements(line.split()[1])
+            elif (
+                not line.startswith("--")
+                and not line.startswith("#")
+                and line.strip() != ""
+            ):
+                resolved_requirements.append(line)
+        return resolved_requirements
+
+    requirements = _read_requirements("common.txt")
+    return requirements
+
+
 setup(
     ext_modules=[
         CMakeExtension(
@@ -81,4 +103,5 @@ def build_extension(self, ext: CMakeExtension):
         # Use relative path here
         PKG_NAME: ["_torch_ops/lib/*.so", "_torch_ops/lib/*.dll"]
     },
+    install_requires=get_requirements(ROOT_DIR),
 )

src/example_package/_torch_ops/include/template_project_name/math/vec_add.hpp

@@ -0,0 +1,13 @@
+#include "template_project_name/system.hpp"
+
+namespace template_project_name::cuda
+{
+VSC_PYTHON_TEMPLATE_API void launch_vec_add(const float* a, const float* b,
+                                            float* c, int n);
+}
+
+namespace template_project_name::cpu
+{
+VSC_PYTHON_TEMPLATE_API void launch_vec_add(const float* a, const float* b,
+                                            float* c, int n);
+}

src/example_package/_torch_ops/include/template_project_name/system.hpp

@@ -0,0 +1,17 @@
+#pragma once
+
+#if defined(_WIN32) || defined(__WIN32__)
+    #if defined(VSC_PYTHON_TEMPLATE_EXPORT)
+        #define VSC_PYTHON_TEMPLATE_API __declspec(dllexport)
+    #elif defined(VSC_PYTHON_TEMPLATE_IMPORT)
+        #define VSC_PYTHON_TEMPLATE_API __declspec(dllimport)
+    #else
+        #define VSC_PYTHON_TEMPLATE_API
+    #endif
+#else
+    #if defined(VSC_PYTHON_TEMPLATE_EXPORT)
+        #define VSC_PYTHON_TEMPLATE_API __attribute__((visibility("default")))
+    #else
+        #define VSC_PYTHON_TEMPLATE_API
+    #endif
+#endif

src/example_package/_torch_ops/include/template_project_name/utils/address.hpp

@@ -0,0 +1,51 @@
+#pragma once
+
+#include <cassert>
+#include <cstddef>
+
+#if __cplusplus < 202002L
+    #include <array>
+#else
+    #include <tuple>
+    #include <utility>
+#endif
+
+namespace template_project_name
+{
+/**
+ * @brief Compute the offset of a multi-dimensional array.
+ *
+ * @param args First half is the indexes, second half is the size of each
+ *             dimension.
+ * @return std::uint32_t The offset of the multi-dimensional array.
+ *
+ * @example computeOffset(1, 2, 3, 4, 5, 6) -> 3*1 + 2*6 + 1*6*5 = 45
+ */
+template <typename OffsetT, typename... ArgsT>
+constexpr auto computeOffset(ArgsT... args) -> OffsetT
+{
+    constexpr std::size_t nArgs = sizeof...(ArgsT);
+    constexpr std::size_t nDims = nArgs / 2;
+
+    OffsetT offset = 0, stride = 1;
+
+#if __cplusplus >= 202002L
+    auto params = std::make_tuple(static_cast<OffsetT>(args)...);
+    [&]<std::size_t... I>(std::index_sequence<I...>) {
+        ((I < nDims ? (offset += std::get<nDims - 1 - I>(params) * stride,
+                       stride *= std::get<nArgs - 1 - I>(params))
+                    : 0),
+         ...);
+    }(std::make_index_sequence<nDims>{});
+#else
+    auto params = std::array{static_cast<OffsetT>(args)...};
+    for (std::size_t i = 0; i < nDims; ++i) {
+        offset += params[nDims - 1 - i] * stride;
+        stride *= params[nArgs - 1 - i];
+    }
+#endif
+
+    return offset;
+}
+
+}  // namespace template_project_name

uv.toml

@@ -0,0 +1 @@
+python-preference = "only-managed"