nuTens 0.1.0__tar.gz

nutens-0.1.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

nutens-0.1.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

nutens-0.1.0/.github/workflows/CI-build-and-test.yml

@@ -0,0 +1,108 @@
+# This starter workflow is for a CMake project running on a single platform. There is a different starter workflow if you need cross-platform coverage.
+# See: https://github.com/actions/starter-workflows/blob/main/ci/cmake-multi-platform.yml
+name: CI Build & Test
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+  workflow_dispatch:
+
+env:
+  # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
+  BUILD_TYPE: Release
+
+jobs:
+  build:
+    # The CMake configure and build commands are platform agnostic and should work equally well on Windows or Mac.
+    # You can convert this to a matrix build if you need cross-platform coverage.
+    # See: https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - OS: ubuntu-latest
+            cpp_compiler: g++
+            c_compiler: gcc
+            
+          - OS: ubuntu-latest
+            cpp_compiler: clang++
+            c_compiler: clang
+            
+          - OS: windows-latest
+            cpp_compiler: cl
+            c_compiler: cl
+             
+    name: Build & Test ${{ matrix.os }} ${{ matrix.c_compiler }}
+
+    runs-on: ${{ matrix.os }}
+    
+    env:
+      CC: ${{ matrix.c_compiler }}
+      CXX: ${{ matrix.cpp_compiler }}
+      
+    steps:
+    # this Action should follow steps to set up Python build environment
+    - uses: actions/checkout@v4
+
+    - name: Install Protoc Windows
+      if: ${{ startsWith(matrix.OS, 'windows') }}
+      uses: arduino/setup-protoc@v3
+
+    - name: Install Protoc Ubuntu
+      if: ${{ startsWith(matrix.OS, 'ubuntu') }}
+      run: sudo apt install protobuf-compiler
+      
+    - name: Install Python dependencies
+      uses: py-actions/py-dependency-install@v4
+      with:
+        path: "PyTorch_requirements.txt"
+        
+    - name: Configure CMake ubuntu
+      if: ${{ startsWith(matrix.OS, 'ubuntu') }}
+      # Configure CMake in a 'build' subdirectory. `CMAKE_BUILD_TYPE` is only required if you are using a single-configuration generator such as make.
+      # See https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html?highlight=cmake_build_type
+      run: |
+        cmake \
+        -DNT_TEST_COVERAGE=ON \
+        -DCMAKE_PREFIX_PATH=`python3 -c "import torch;print(torch.utils.cmake_prefix_path)"` \
+        -B ${{github.workspace}}/build \
+        -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
+
+    - name: Configure CMake windows
+      if: ${{ startsWith(matrix.OS, 'windows') }}
+      # on windows to get the pytorch config we have to 
+      # run the same python command as before but now save it 
+      # to a file then read from the file into a variable to pass to cmake
+      run: |
+        $Torch_DIR = python3 -c "import torch;print(torch.utils.cmake_prefix_path)"
+        echo "torch location: $Torch_DIR"
+        cmake -DNT_TEST_COVERAGE=ON -DCMAKE_PREFIX_PATH="$Torch_DIR" -B ${{github.workspace}}\build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
+         
+    - name: Build
+      # Build your program with the given configuration
+      run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}} --parallel 2
+
+    - name: Test
+      working-directory: ${{github.workspace}}/build
+      # Execute tests defined by the CMake configuration.
+      # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail
+      run: ctest -C ${{env.BUILD_TYPE}}
+
+    - name: Generate Coverage Report
+      # only need to do this for one combination of OS and compiler
+      if: ${{ matrix.OS == 'ubuntu-latest' && matrix.c_compiler == 'gcc' }}
+      working-directory: ${{github.workspace}}/build
+      run: gcovr --json -o nuTens_coverage.json -r .. -f "../nuTens/*"
+      
+    - name: Upload coverage reports to Codecov
+      # only need to do this for one combination of OS and compiler
+      if: ${{ matrix.OS == 'ubuntu-latest' && matrix.c_compiler == 'gcc' }}
+      uses: codecov/codecov-action@v4.0.1
+      with:
+        verbose: true
+        files: nuTens_coverage.json
+      env:
+        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

nutens-0.1.0/.github/workflows/benchmarking-track-main.yaml

@@ -0,0 +1,56 @@
+name: Main Branch Benchmarking
+
+on:
+  push:
+    branches: main
+
+  workflow_dispatch:
+
+env:
+  # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
+  BUILD_TYPE: Release
+  
+jobs:
+  benchmark_base_branch:
+    name: Continuous Benchmarking with Bencher
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: bencherdev/bencher@main
+      
+      - name: Set Flags
+        run: export USE_CUDA=0
+  
+      - name: Install Protobuf
+        run: sudo apt install protobuf-compiler
+        
+      - name: Install Python dependencies
+        uses: py-actions/py-dependency-install@v4
+        with:
+          path: "PyTorch_requirements.txt"
+          
+      - name: Make Build Directory
+        run: mkdir build
+          
+      - name: Configure CMake
+        working-directory: ${{github.workspace}}/build
+        # Configure CMake with benchmarking option on
+        run: |
+          cmake --debug-output -DNT_USE_PCH=ON -DNT_ENABLE_BENCHMARKING=ON -DCMAKE_PREFIX_PATH=`python3 -c 'import torch;print(torch.utils.cmake_prefix_path)'` -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} .. 
+          
+      - name: Build
+        working-directory: ${{github.workspace}}/build
+        # Build your program with the given configuration
+        run: make
+        
+      - name: Track base branch benchmarks with Bencher
+        working-directory: ${{github.workspace}}/build
+        run: |
+          bencher run \
+          --project nutens \
+          --token '${{ secrets.BENCHER_API_TOKEN }}' \
+          --branch main \
+          --testbed ubuntu-latest \
+          --adapter cpp_google \
+          --err \
+          "./benchmarks/benchmarks --benchmark_format=json --benchmark_repetitions=16 --benchmark_min_warmup_time=60" \

nutens-0.1.0/.github/workflows/benchmarking.yaml

@@ -0,0 +1,78 @@
+name: Continuous Benchmarking
+
+on:
+  push:
+    branches: [ "main" ]
+    
+  pull_request:
+    branches: [ "main" ]
+    types: [opened, reopened, edited, synchronize]
+    
+  workflow_dispatch:
+
+env:
+  # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
+  BUILD_TYPE: Release
+  
+jobs:
+  benchmark_pr_branch:        
+    name: Continuous Benchmarking PRs with Bencher
+    # DO NOT REMOVE: For handling Fork PRs see Pull Requests from Forks
+    if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository
+    
+    permissions:
+      pull-requests: write
+      
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: bencherdev/bencher@main
+      
+      - name: Set Flags
+        run: export USE_CUDA=0
+  
+      - name: Install Protobuf
+        run: sudo apt install protobuf-compiler
+        
+      - name: Install Python dependencies
+        uses: py-actions/py-dependency-install@v4
+        with:
+          path: "PyTorch_requirements.txt"
+          
+      - name: Make Build Directory
+        run: mkdir build
+          
+      - name: Configure CMake
+        working-directory: ${{github.workspace}}/build
+        # Configure CMake with benchmarking option on
+        run: |
+          cmake --debug-output -DNT_USE_PCH=ON -DNT_ENABLE_BENCHMARKING=ON -DCMAKE_PREFIX_PATH=`python3 -c 'import torch;print(torch.utils.cmake_prefix_path)'` -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} .. 
+          echo :::: Build directory post-CMake:
+          ls
+          echo 
+          echo :::: _deps directory:
+          ls _deps
+          echo 
+          echo :::: benchmark link file:
+          cat benchmarks/CMakeFiles/benchmarks.dir/link.txt
+          
+      - name: Build
+        working-directory: ${{github.workspace}}/build
+        # Build your program with the given configuration
+        run: make --trace #cmake --build ${{github.workspace}}/build
+        
+      - name: Track PR Benchmarks with Bencher
+        working-directory: ${{github.workspace}}/build
+        run: |
+          ls
+          bencher run \
+          --project nutens \
+          --token '${{ secrets.BENCHER_API_TOKEN }}' \
+          --branch '${{ github.head_ref }}' \
+          --branch-start-point '${{ github.base_ref }}' \
+          --branch-start-point-hash '${{ github.event.pull_request.base.sha }}' \
+          --testbed ubuntu-latest \
+          --adapter cpp_google \
+          --err \
+          --github-actions '${{ secrets.GITHUB_TOKEN }}' \
+          "./benchmarks/benchmarks --benchmark_format=json --benchmark_repetitions=16 --benchmark_min_warmup_time=60" \

nutens-0.1.0/.github/workflows/cpp-linter.yaml

@@ -0,0 +1,59 @@
+name: cpp-linter
+
+on:
+  pull_request:
+    branches: [ "main" ]
+  workflow_dispatch:
+
+
+jobs:
+  cpp-linter:
+    permissions: write-all
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set Flags
+        run: export USE_CUDA=0
+  
+      - name: Install Protobuf
+        run: sudo apt install protobuf-compiler
+        
+      - name: Install Python dependencies
+        uses: py-actions/py-dependency-install@v4
+        with:
+          path: "PyTorch_requirements.txt"
+        
+      - name: Configure CMake
+        # Configure CMake so we can get a compile_commands.json so that clang-tidy won't be angry about missing headers any more
+        run: cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DNT_ENABLE_BENCHMARKING=ON -DCMAKE_PREFIX_PATH=`python3 -c 'import torch;print(torch.utils.cmake_prefix_path)'` -B ${{github.workspace}} -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
+
+      ## horrible little hack to put spdlog include files somewhere that clang-tidy can find them
+      ## it doesn't seem to like headers included by cpm
+      - name: Move spdlog
+        run: |
+          cp -r _deps/spdlog-src/include/spdlog .
+          cp spdlog/spdlog* .
+        
+      - uses: cpp-linter/cpp-linter-action@main
+        id: linter
+        continue-on-error: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          style: "Microsoft"
+          ignore: '.github|_deps|CMakeFiles|spdlog*'
+          tidy-review: true
+          step-summary: true
+          files-changed-only: true
+          
+          thread-comments: false
+          file-annotations: false
+          tidy-checks: 'boost-*,bugprone-*,performance-*,readability-*,portability-*,modernize-*,clang-analyzer-*,cppcoreguidelines-*,-modernize-use-trailing-return-type,-modernize-use-emplace,-readability-redundant-access-specifiers'
+
+      - name: Fail fast?!
+        if: steps.linter.outputs.checks-failed != 0
+        #run: |
+        #  echo "some linter checks failed. ${{ steps.linter.outputs.checks-failed }}"
+        # for actual deployment
+        run: exit 1

nutens-0.1.0/.github/workflows/doxygen-deployment.yml

@@ -0,0 +1,29 @@
+name: Doxygen GitHub Pages Deploy Action
+
+permissions:
+  contents: write
+  
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - run: sudo apt-get update
+      
+      - run: sudo apt-get install -y texlive  
+      
+      - run: sudo apt-get install -y libjs-mathjax
+      
+      - uses: DenverCoder1/doxygen-github-pages-action@v1.3.0
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          folder: doc/html
+          config_file: doc/doxygen.config
+
+      - run: ls
+      - run: ls doc/html

nutens-0.1.0/.github/workflows/pip.yaml

@@ -0,0 +1,39 @@
+name: "Pip"
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    name: Build with Pip
+    runs-on: ${{ matrix.platform }}
+    strategy:
+      fail-fast: false
+      matrix:
+        platform: [ubuntu-latest]
+        python-version: ["3.9", "3.10", "3.11"]
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+        
+    - name: Install Protoc Ubuntu
+      run: sudo apt install protobuf-compiler
+      
+    - name: Install Python dependencies
+      uses: py-actions/py-dependency-install@v4
+      with:
+        path: "PyTorch_requirements.txt"
+
+    - name: Build and install
+      run: pip install --verbose .
+
+    #- name: Test
+    #  run: pytest

nutens-0.1.0/.github/workflows/pypi-distribution-reusable.yaml

@@ -0,0 +1,179 @@
+on:
+  workflow_call:
+    inputs:
+      build_type:
+        required: true
+        type: string
+      platform:
+        required: true
+        type: string
+
+jobs:
+  build:
+  
+    name: Build ${{ inputs.platform }} ${{ inputs.build_type }} distribution 📦
+    runs-on: ${{ inputs.platform }}
+
+    steps:
+    - uses: actions/checkout@v4
+
+    ## runner will run out of space if we don't clear some up by removing some unused tools
+    - name: Clear space
+      run: >-
+        sudo rm -rf /usr/share/dotnet
+        sudo rm -rf /opt/ghc
+        sudo rm -rf "/usr/local/share/boost"
+        sudo rm -rf "$AGENT_TOOLSDIRECTORY"
+        
+    #- name: cuda-toolkit
+    #  if: ${{ startsWith( inputs.build_type, 'cuda' ) }}
+    #  uses: Jimver/cuda-toolkit@v0.2.17
+    
+    #- name: Set up Python
+    #  uses: actions/setup-python@v5
+    #  with:
+    #    python-version: "3.11"
+
+    #- name: Install Protoc 
+    #  run: sudo apt install protobuf-compiler
+      
+    #- name: Install Python dependencies
+    #  uses: py-actions/py-dependency-install@v4
+    #  with:
+    #    path: "PyTorch_requirements.txt"
+
+    #- name: Install cibuildwheel
+    #  run: python -m pip install cibuildwheel==2.21.1
+      
+    - uses: yezz123/setup-uv@v4
+    
+    - uses: pypa/cibuildwheel@v2.21
+      if: runner.os == 'Linux'
+      env:
+        CIBW_BUILD_VERBOSITY: 1
+        CIBW_ARCHS_LINUX: "x86_64"
+        CIBW_SKIP: "*musl*"
+        CIBW_BEFORE_ALL: >
+          yum-config-manager --add-repo https://developer.download.nvidia.com/compute/cuda/repos/rhel7/x86_64/cuda-rhel7.repo &&
+          yum clean all &&
+          yum -y install cuda-toolkit &&
+          ls -al /usr/local &&
+          nvcc --version &&
+          echo nvcc location: &&
+          which nvcc &&
+          export CUDACXX="$(which nvcc)" &&
+          echo $CUDACXX &&
+          echo gcc version: &&
+          gcc --version &&
+          export BUILD_WITH_CUDA=1 &&
+          export TORCH_CUDA_ARCH_LIST="8.0 8.6 8.9 9.0" 
+        CIBW_ENVIRONMENT: >
+          PATH=$PATH:/usr/local/cuda/bin LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$(python -c 'import sys; print(sys.prefix + "/lib/python" + sys.version[:3] + "/site-packages")')/torch/lib/ 
+        CIBW_BEFORE_BUILD: >
+          python -m site &&
+          python -c 'import sys; print(sys.prefix + "/lib/python" + sys.version[:3] + "/site-packages")' &&
+          echo $LD_LIBRARY_PATH &&
+          ls $(python -c 'import sys; print(sys.prefix + "/lib/python" + sys.version[:3] + "/site-packages")')
+        
+      
+    #- name: Build wheels
+    #  run: python -m cibuildwheel --output-dir dist
+    #  env:
+    #    CIBW_BEFORE_BUILD: pip install scikit-build-core
+        
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+
+  publish-to-testpypi:
+    name: Publish Python 🐍 distribution 📦 to TestPyPI
+    needs:
+    - build
+    runs-on: ${{ inputs.platform }}
+
+    environment:
+      name: testPyPi-distribution
+      url: https://test.pypi.org/p/nuTens
+
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution 📦 to TestPyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        repository-url: https://test.pypi.org/legacy/
+        
+  publish-to-pypi:
+    name: >-
+      Publish Python 🐍 distribution 📦 to PyPI
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+    needs:
+    - build
+    runs-on: ${{ inputs.platform }}
+    environment:
+      name: PyPi-distribution
+      url: https://pypi.org/p/nuTens  # Replace <package-name> with your PyPI project name
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+      
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution 📦 to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+    name: >-
+      Sign the Python 🐍 distribution 📦 with Sigstore
+      and upload them to GitHub Release
+    needs:
+    - publish-to-pypi
+    runs-on: ${{ inputs.platform }}
+
+    permissions:
+      contents: write  # IMPORTANT: mandatory for making GitHub Releases
+      id-token: write  # IMPORTANT: mandatory for sigstore
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Sign the dists with Sigstore
+      uses: sigstore/gh-action-sigstore-python@v2.1.1
+      with:
+        inputs: >-
+          ./dist/*.tar.gz
+          ./dist/*.whl
+    - name: Create GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      run: >-
+        gh release create
+        '${{ github.ref_name }}'
+        --repo '${{ github.repository }}'
+        --notes ""
+    - name: Upload artifact signatures to GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      # Upload to GitHub Release using the `gh` CLI.
+      # `dist/` contains the built packages, and the
+      # sigstore-produced signatures and certificates.
+      run: >-
+        gh release upload
+        '${{ github.ref_name }}' dist/**
+        --repo '${{ github.repository }}'