Updates for nvmath-python-0.4.0 release (#26)

Updates for nvmath-python-0.4.0 release

Author: markjolah

.pre-commit-config.yaml

@@ -4,7 +4,7 @@
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v5.0.0
     hooks:
     - id: check-added-large-files
     - id: check-ast
@@ -22,37 +22,41 @@ repos:
       args: ['--fix=lf']
 
   - repo: https://github.com/abravalheri/validate-pyproject
-    rev: v0.19
+    rev: v0.24
     hooks:
       - id: validate-pyproject
         additional_dependencies: ["validate-pyproject-schema-store[all]"]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.6.4
+    rev: v0.11.2
     hooks:
       - id: ruff
         args: [--fix]
       - id: ruff-format
 
-  # FIXME
   # Mypy: static type checking
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: "v1.13.0"
+    rev: "v1.15.0"
     hooks:
       - id: mypy
+        # Envorce only one source of configuration.
         args: ["--config-file", "pyproject.toml"]
-        files: ^nvmath(.*)\.py$
         additional_dependencies:
           - cuda-python
           - cupy-cuda12x
-          - mpi4py-mpich
+          # TODO: https://github.com/mpi4py/mpi4py/issues/630
+          # - mpi4py
           - numba
+          - numba-cuda
           - numpy
           - pytest
           - scipy
           - torch
           - types-cffi
           - types-pywin32
+          - invoke
+          - cython<3
+          - wheel
 
   # FIXME: Prettier pre-commit plugin is no longer supported
   # Autoformat: YAML, JSON, Markdown, etc.
@@ -63,7 +67,7 @@ repos:
 
   # Spellcheck
   - repo: https://github.com/codespell-project/codespell
-    rev: "v2.3.0"
+    rev: "v2.4.1"
     hooks:
       - id: codespell
         additional_dependencies:
@@ -78,38 +82,32 @@ repos:
 
   # Security: secrets
   - repo: https://github.com/gitleaks/gitleaks
-    rev: v8.18.4
+    rev: v8.24.0
     hooks:
       - id: gitleaks
 
-  # FIXME
-  # Security: secrets
-  - repo: https://github.com/thoughtworks/talisman
-    rev: "v1.32.0"
-    hooks:
-      - id: talisman-commit
-        entry: cmd --githook pre-commit
-
-  # FIXME
   # Bash linter
-  # - repo: https://github.com/openstack/bashate
-  #   rev: 2.1.1
-  #   hooks:
-  #     - id: bashate
-  #       args: ["--ignore=E006,E010,E020"]
+  - repo: https://github.com/openstack/bashate
+    rev: 2.1.1
+    hooks:
+      - id: bashate
+        args: ["--ignore=E006,E010,E020"]
 
-  # FIXME
   # Shell script linter
-  # - repo: https://github.com/shellcheck-py/shellcheck-py
-  #   rev: "v0.10.0.1"
-  #   hooks:
-  #     - id: shellcheck
+  - repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: "v0.10.0.1"
+    hooks:
+      - id: shellcheck
 
   # Lint: Markdown
   - repo: https://github.com/igorshubovych/markdownlint-cli
-    rev: v0.41.0
+    rev: v0.44.0
     hooks:
       - id: markdownlint
+        # Setting up node version explicitly
+        # https://github.com/igorshubovych/markdownlint-cli/issues/502
+        language: node
+        language_version: "22.14.0"
       # Ignore old internal README that will not be rendered as docs page
         args: ["--fix", "--ignore", "internal/gtc2024/README.md"]
 
@@ -119,6 +117,3 @@ repos:
       - id: sphinx-lint
         args: ["--enable", "all", "--max-line-length", "92"]
         exclude: ^(.*)generated/(.*)\.rst$
-
-default_language_version:
-  python: python310

.talismanrc

@@ -43,7 +43,7 @@ def check_path(header):
 
 def decide_lib_name(ext_name):
     # TODO: move the record of the supported lib list elsewhere?
-    for lib in ("cublas", "cusolver", "cufft", "cusparse", "curand", "nvpl"):
+    for lib in ("cublas", "cusolver", "cufftMp", "cufft", "cusparse", "curand", "nvpl", "nvshmem", "mathdx"):
         if lib in ext_name:
             return lib
     else:
@@ -92,18 +92,23 @@ def _prep_includes_libs_rpaths(self, lib_name):
             extra_linker_flags = ["-Wl,--strip-all"]
             if lib_name is not None:
                 ldflag = "-Wl,--disable-new-dtags"
-                if lib_name == "nvpl":
-                    # 1. the nvpl bindings land in
-                    # site-packages/nvmath/bindings/nvpl/_internal/ as opposed to other
-                    # packages that have their bindings in
-                    # site-packages/nvmath/bindings/_internal/, so we need one extra `..` to
-                    # get into `site-packages` and then the lib_name=nvpl is not in nvidia
-                    # dir but directly in the site-packages.
-                    # 2. mkl lib is placed directly in the python `lib` directory, not in
-                    # python{ver}/site-packages
-                    ldflag += f",-rpath,$ORIGIN/../../../../{lib_name}/lib:$ORIGIN/../../../../../../"
-                else:
-                    ldflag += f",-rpath,$ORIGIN/../../../nvidia/{lib_name}/lib"
+                match lib_name:
+                    case "nvpl":
+                        # 1. the nvpl bindings land in
+                        # site-packages/nvmath/bindings/nvpl/_internal/ as opposed to other
+                        # packages that have their bindings in
+                        # site-packages/nvmath/bindings/_internal/, so we need one extra
+                        # `..` to get into `site-packages` and then the lib_name=nvpl is not
+                        # in nvidia dir but directly in the site-packages.
+                        # 2. mkl lib is placed directly in the python `lib` directory, not
+                        # in python{ver}/site-packages
+                        ldflag += f",-rpath,$ORIGIN/../../../../{lib_name}/lib:$ORIGIN/../../../../../../"
+                    case "cufftMp":
+                        ldflag += ",-rpath,$ORIGIN/../../../nvidia/cufftmp/cu12/lib"
+                    case "mathdx":
+                        ldflag += ",-rpath,$ORIGIN/../../../nvidia/cu12/lib"
+                    case _:
+                        ldflag += f",-rpath,$ORIGIN/../../../nvidia/{lib_name}/lib"
                 extra_linker_flags.append(ldflag)
 
         return cuda_incl_dir, extra_linker_flags

builder/pep517.py

@@ -3,7 +3,7 @@ SHELL=/bin/bash
 
 # You can set these variables from the command line or environment
 SPHINX_NVMATH_PYTHON_VER ?= $(shell [[ $$(< ../pyproject.toml) =~ [^a-zA-Z_]version\ =\ [^0-9.]*([0-9.]*) ]] && echo $${BASH_REMATCH[1]})
-SPHINXOPTS    ?= -W
+SPHINXOPTS    ?= -j auto -W
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = sphinx
 BUILDDIR      ?= _build/html

builder/utils.py

@@ -3,6 +3,10 @@
         "version": "latest",
         "url": "https://docs.nvidia.com/cuda/nvmath-python/latest"
     },
+    {
+        "version": "0.4.0",
+        "url": "https://docs.nvidia.com/cuda/nvmath-python/0.4.0"
+    },
     {
         "version": "0.3.0",
         "url": "https://docs.nvidia.com/cuda/nvmath-python/0.3.0"

docs/Makefile

@@ -34,7 +34,7 @@
 
 try:
     import nvmath
-    from nvmath._internal.enum_utils import snake_to_camel
+    from nvmath.internal.enum_utils import snake_to_camel
 except ImportError:
     warnings.warn(
         "\n\n\n"
@@ -93,6 +93,13 @@
     "nbsphinx_link",
 ]
 
+extlinks = {
+    "cufftmp_hw": (
+        "https://docs.nvidia.com/cuda/cufftmp/usage/requirements.html#hardware-%s",
+        "p2p or GPUDirect RDMA over IB %s",
+    )
+}
+
 imgmath_latex_preamble = r"\usepackage{braket}"
 
 imgmath_image_format = "svg"
@@ -126,6 +133,9 @@
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
+if tags.has("exclude-nvmath-distributed"):  # noqa: F821
+    exclude_patterns += ["distributed-apis"]
+
 # The reST default role (used for this markup: `text`) to use for all documents.
 default_role = "cpp:any"  # cpp:any
 
@@ -170,6 +180,11 @@
 # Output file base name for HTML help builder.
 htmlhelp_basename = "nvmath-python-doc"
 
+# TODO: remove this once examples are published.
+linkcheck_ignore = [
+    "https://github.com/NVIDIA/nvmath-python/tree/main/examples/distributed/.*",
+]
+
 
 def autodoc_process_docstring(app, what, name, obj, options, lines):
     if snake_to_camel is None:
@@ -303,6 +318,8 @@ def setup(app):
     # avoid name clash with the fft func
     "nvmath.fft.FFT": "nvmath.fft.FFT-class",
     "nvmath.linalg.advanced.Matmul": "nvmath.linalg.advanced.Matmul-class",
+    "nvmath.distributed.fft.FFT": "nvmath.distributed.fft.FFT-class",
+    "nvmath.distributed.reshape.Reshape": "nvmath.distributed.reshape.Reshape-class",
 }
 
 intersphinx_mapping = {

docs/sphinx/_static/switcher.json

@@ -36,5 +36,4 @@ API Reference
    CodeType
    ComputeCapability
    CodeType
-   Symbol
    Dim3