Merge pull request #2045 from swahtz/fvdb_update

Author: swahtz

fvdb/.clangd

@@ -0,0 +1,70 @@
+# https://clangd.llvm.org/config
+
+# Apply a config conditionally to all C files
+If:
+  PathMatch: .*\.(c|h)$
+
+---
+
+# Apply a config conditionally to all C++ files
+If:
+  PathMatch: .*\.(c|h)pp
+
+---
+
+# Apply a config conditionally to all CUDA files
+If:
+  PathMatch: .*\.cuh?
+CompileFlags:
+  Add:
+    - "-x"
+    - "cuda"
+    # No error on unknown CUDA versions
+    - "-Wno-unknown-cuda-version"
+    # Allow variadic CUDA functions
+    - "-Xclang=-fcuda-allow-variadic-functions"
+Diagnostics:
+  Suppress:
+    - "variadic_device_fn"
+    - "attributes_not_allowed"
+    - "unknown_cuda_version"
+    - "unknown_type_name"
+    - "implicit_return_from_non_void_function"
+    - "no_template_args_on_forwarding_function"
+
+---
+
+# Tweak the clangd parse settings for all files
+CompileFlags:
+  Add:
+    # report all errors
+    - "-ferror-limit=0"
+    - "-fmacro-backtrace-limit=0"
+    - "-ftemplate-backtrace-limit=0"
+    # Skip the CUDA version check
+    - "--no-cuda-version-check"
+  Remove:
+    # remove gcc's -fcoroutines
+    - -fcoroutines
+    # remove nvc++ flags unknown to clang
+    - "-gpu=*"
+    - "-stdpar*"
+    # remove nvcc flags unknown to clang
+    - "-arch*"
+    - "-gencode*"
+    - "--generate-code*"
+    - "-ccbin*"
+    - "-t=*"
+    - "--threads*"
+    - "-Xptxas*"
+    - "-Xcudafe*"
+    - "-Xfatbin*"
+    - "-Xcompiler*"
+    - "--diag-suppress*"
+    - "--diag_suppress*"
+    - "--compiler-options*"
+    - "--extended-lambda"
+    - "--expt-extended-lambda"
+    - "--expt-relaxed-constexpr"
+    - "-forward-unknown-to-host-compiler"
+    - "-Werror=cross-execution-space-call"

fvdb/.vscode/extensions.json

@@ -0,0 +1,14 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
+    // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
+
+    // List of extensions which should be recommended for users of this workspace.
+    "recommendations": [
+        "llvm-vs-code-extensions.vscode-clangd",
+        "ms-vscode.cpptools-extension-pack"
+    ],
+    // List of extensions recommended by VS Code that should not be recommended for users of this workspace.
+    "unwantedRecommendations": [
+
+    ]
+}

fvdb/.vscode/settings.json

@@ -112,7 +112,7 @@
     },
     "files.trimTrailingWhitespace": true,
     "editor.rulers": [ 100 ],
-    "C_Cpp.intelliSenseEngine": "default",
+    "C_Cpp.intelliSenseEngine": "disabled",
     "C_Cpp.enhancedColorization": "enabled",
     "C_Cpp.errorSquiggles": "enabledIfIncludesResolve",
     "C_Cpp.autocomplete": "default",
@@ -123,11 +123,11 @@
     "cmake.configureOnOpen": false,
     "C_Cpp.default.compilerPath": "${env:CONDA_PREFIX}/envs/fvdb/bin/x86_64-conda-linux-gnu-c++",
     "[cpp]": {
-        "editor.defaultFormatter": "ms-vscode.cpptools",
+        "editor.defaultFormatter": "llvm-vs-code-extensions.vscode-clangd",
         "editor.formatOnSave": true
     },
     "[cuda-cpp]": {
-        "editor.defaultFormatter": "ms-vscode.cpptools",
+        "editor.defaultFormatter": "llvm-vs-code-extensions.vscode-clangd",
         "editor.formatOnSave": true
     },
     "[python]": {
@@ -158,4 +158,5 @@
     "C_Cpp.formatting": "clangFormat",
     "C_Cpp.clang_format_path": "${env:CONDA_PREFIX}/envs/fvdb/bin/clang-format-18",
     "files.insertFinalNewline": true,
+    "clangd.path": "${env:CONDA_PREFIX}/envs/fvdb/bin/clangd",
 }

fvdb/CMakeLists.txt

@@ -13,6 +13,7 @@ find_package(Python3 COMPONENTS Development Interpreter)
 message(STATUS "CMAKE_BUILD_PARALLEL_LEVEL: ${CMAKE_BUILD_PARALLEL_LEVEL}")
 
 include(${CMAKE_CURRENT_SOURCE_DIR}/src/cmake/get_cpm.cmake)
+include(${CMAKE_CURRENT_SOURCE_DIR}/src/cmake/get_nvtx.cmake)
 include(${CMAKE_CURRENT_SOURCE_DIR}/src/cmake/get_torch.cmake)
 include(${CMAKE_CURRENT_SOURCE_DIR}/src/cmake/get_pybind11.cmake)
 include(${CMAKE_CURRENT_SOURCE_DIR}/src/cmake/configure_torch_pybind11.cmake)

fvdb/Dockerfile

@@ -14,3 +14,6 @@ ENV CONDA_OVERRIDE_CUDA=12.0
 # copy env/dev_environment.yml to /tmp/
 COPY fvdb/env/dev_environment.yml /tmp/
 RUN  conda env create -f /tmp/dev_environment.yml
+
+RUN conda init
+RUN echo "conda activate fvdb" >> ~/.bashrc

fvdb/README.md

@@ -145,6 +145,9 @@ sphinx-build -E -a docs/ build/sphinx
 open build/sphinx/index.html
 ```
 
+### Setting up Intellisense with clangd in Visual Studio Code
+
+Please see the guide [`Clangd for Intellisense in fVDB`](docs/markdown/clangd.md)
 
 
 ## Usage Examples

fvdb/build.sh

@@ -48,8 +48,31 @@ setup_parallel_build_jobs() {
 # Ensure that the build is done with the conda environment
 # Get any additional command line arguments after $1
 shift
-ADDITIONAL_ARGS="$@"
-export PIP_ARGS="-v --no-build-isolation $ADDITIONAL_ARGS"
+
+CONFIG_SETTINGS=""
+PASS_THROUGH_ARGS=""
+
+while (( "$#" )); do
+  if [[ "$BUILD_TYPE" == "install" ]]; then
+    if [[ "$1" == "gtests" ]]; then
+      echo "Detected 'gtests' flag for install build. Enabling FVDB_BUILD_TESTS."
+      CONFIG_SETTINGS+=" --config-settings=cmake.define.FVDB_BUILD_TESTS=ON"
+    elif [[ "$1" == "benchmarks" ]]; then
+      echo "Detected 'benchmarks' flag for install build. Enabling FVDB_BUILD_BENCHMARKS."
+      CONFIG_SETTINGS+=" --config-settings=cmake.define.FVDB_BUILD_BENCHMARKS=ON"
+    else
+      # Append other arguments, handling potential spaces safely
+      PASS_THROUGH_ARGS+=" $(printf "%q" "$1")"
+    fi
+  else
+    # Append other arguments, handling potential spaces safely
+    PASS_THROUGH_ARGS+=" $(printf "%q" "$1")"
+  fi
+  shift
+done
+
+# Construct PIP_ARGS with potential CMake args and other pass-through args
+export PIP_ARGS="-v --no-build-isolation$CONFIG_SETTINGS$PASS_THROUGH_ARGS"
 
 if [ "$BUILD_TYPE" != "ctest" ]; then
     setup_parallel_build_jobs
@@ -62,7 +85,7 @@ if [ "$BUILD_TYPE" == "wheel" ]; then
     pip wheel . --wheel-dir dist/ $PIP_ARGS
 elif [ "$BUILD_TYPE" == "install" ]; then
     echo "Build and install package"
-    echo "pip install  --force-reinstall $PIP_ARGS ."
+    echo "pip install --force-reinstall $PIP_ARGS ."
     pip install --force-reinstall $PIP_ARGS .
 # TODO: Fix editable install
 # else

fvdb/compile_commands.json

@@ -0,0 +1 @@
+build/cp311-cp311-linux_x86_64/compile_commands.json

fvdb/docs/markdown/clangd.md

@@ -0,0 +1,60 @@
+# Clangd for "Intellisense" in fVDB
+
+In fVDB we typically develop using Visual Studio Code (VSCode), both local, in containers, and
+remove via SSH. To aid development we use `clangd` for intellisense (code navigation) and to
+detect syntax and usage errors before compiling. With `clangd` active, you will see "red squiggles"
+under actual syntax / compilation errors in your code as you edit; you will get code completion
+suggestions; and you will get tooltips for definitions when you mouse over code.
+
+The fVDB VSCode workspace includes configuration for clangd but developers new to fVDB should follow
+these instructions.
+
+## Setting up clangd in your environment
+
+The fvdb Conda development environment installs the CUDA toolkit, but clangd runs outside the
+environment and so may not find the correct CUDA installation. Therefore you should create the file
+
+To fix this, you need to create a user clangd config file to point to the CUDA installation in the
+FVDB conda environment: Create ~/.config/clangd/config.yaml with these contents. This assumes you
+use the `dev_environment.yml` to create the `fvdb` Conda environment.
+
+```yaml
+# https://clangd.llvm.org/config
+
+# Apply a config conditionally to all CUDA files
+If:
+  PathMatch: .*\.cuh?
+CompileFlags:
+  Add:
+    - "--cuda-path=/home/mharris/miniforge3/envs/fvdb"
+```
+
+The first time you load the fVDB VSCode workspace, it should prompt you to install recommended
+extensions. Specifically: "llvm-vs-code-extensions.vscode-clangd", and
+"ms-vscode.cpptools-extension-pack", as defined in the `extensions.json` file. Install these
+extensions. With Clangd, the MS CPPTools is only used for syntax highlighting. Clangd is used for
+intellisense and (CUDA) C++ file formatting.
+
+## Troubleshooting Intellisense
+
+Clangd uses the file `compile_commands.json` to determine the compiler command line used so that it
+can build an index of the source code for "intellisense" navigation. This file is generated by
+CMake when you configure the build. This happens when you run fVDB's `build.sh`. Here are some
+tips for troubleshooting intellisense issues.
+
+- If you get a red squiggle on the first character of a file, it’s usually a major failure. For
+  example when clangd fails to find the CUDA installation. This is often a configuration problem.
+- A common problem is when you are editing a file that is not in `compile_commands.json`. if this is
+  the case, you may not have CMake-configured your build.
+    - A key indicator of this is seeing a message about ‘inferred’ commands like this in the clangd
+    output log `ASTWorker building file XXX with command inferred from YYY`
+- Switching conda environments: if you activate a conda environment, e.g. `fvdb_build` and build
+  (or cmake configure), then switch to another conda environment, your `compile_commands.json` will
+  be out of date with the wrong include paths. You need to rerun cmake configure or rebuild in the
+  active conda environment.
+- red squiggles in google test .cpp : did you build the tests? Are they in compile_commands.cpp?
+  Make sure you add the `gtests` argument to your `build.sh` command line:
+
+```sh
+./build.sh install gtests
+```

fvdb/env/build_environment.yml

@@ -19,6 +19,7 @@ dependencies:
   - libcublas-dev
   - libcusolver-dev
   - libcusparse-dev
+  - libpng
   - linkify-it-py
   - make
   - myst-parser

fvdb/env/dev_environment.yml

@@ -5,7 +5,9 @@ channels:
 dependencies:
   - ca-certificates
   - certifi
+  - clang=18
   - clang-format=18
+  - clang-tools=18
   - cmake
   - cuda-command-line-tools
   - cuda-compiler
@@ -19,6 +21,7 @@ dependencies:
   - gxx_linux-64=11
   - ipython
   - jupyterlab
+  - libclang=18
   - libcublas-dev
   - libcurand-dev
   - libcusolver-dev
@@ -57,12 +60,17 @@ dependencies:
   - scikit-learn
   - torchmetrics
   - tyro
+  - gdal
+  - utm
+  - pyproj
+  - open3d
   - pip:
     - point-cloud-utils
     - https://nksr.s3.ap-northeast-1.amazonaws.com/dev-whls/pt24cu120/torchsparse-2.1.0-cp311-cp311-linux_x86_64.whl
     - https://nksr.s3.ap-northeast-1.amazonaws.com/dev-whls/pt24cu120/torchsparse_20-2.0.0b0-cp311-cp311-linux_x86_64.whl
     - https://nksr.s3.ap-northeast-1.amazonaws.com/dev-whls/pt24cu120/torch_scatter-2.1.2-cp311-cp311-linux_x86_64.whl
     ## 3dgs
     - viser
+    - srt
     ## 3dgs tests
     - oiio-static-python

fvdb/env/test_environment.yml

@@ -3,32 +3,33 @@ channels:
   - conda-forge
   - nodefaults
 dependencies:
-  - python=3.11
-  - pytorch-gpu=2.4.1[build=cuda120*]
-  - tensorboard
+  - ca-certificates
+  - certifi
   - cuda-version=12.0
-  - pip>=23.3.1
   - git
   - gitpython
-  - ca-certificates
-  - certifi
-  - openssl
-  - parameterized
+  - imageio
   - ipython
+  - libpng
+  - linkify-it-py
   - matplotlib
-  - tqdm
-  - sphinx>=7.0.0
-  - sphinx_rtd_theme
   - myst-parser
-  - pandas
-  - rich
-  - pytest-benchmark
   - numpy
-  - linkify-it-py
+  - openssl
+  - pandas
+  - parameterized
+  - pip>=23.3.1
   - polyscope
   - py-opencv=4.10[build=headless*]
-  - imageio
+  - pytest-benchmark
+  - python=3.11
+  - pytorch-gpu=2.4.1[build=cuda120*]
+  - rich
   - scikit-learn
+  - sphinx_rtd_theme
+  - sphinx>=7.0.0
+  - tensorboard
+  - tqdm
   - zlib
   - pip:
     - gsplat

fvdb/fvdb/nn/__init__.py

@@ -25,7 +25,6 @@
 from .vdbtensor import VDBTensor, vdbtensor_from_dense
 
 __all__ = [
-    "GaussianSplat3D",
     "VDBTensor",
     "vdbtensor_from_dense",
     "MaxPool",