feat: adding code for CV-CUDA Patch Release 0.3.1 Beta

Author: milesp-nvidia

CMakeLists.txt

@@ -23,7 +23,7 @@ endif()
 
 project(cvcuda
         LANGUAGES C CXX
-        VERSION 0.3.0
+        VERSION 0.3.1
         DESCRIPTION "CUDA-accelerated Computer Vision algorithms"
 )
 

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing to CV-CUDA
 
-**As of release v0.3.0-beta, CV-CUDA is not accepting outside contribution.**
+**As of release v0.3.1-beta, CV-CUDA is not accepting outside contribution.**
 
 Contributions to CV-CUDA fall into the following categories:
 
@@ -12,7 +12,7 @@ Contributions to CV-CUDA fall into the following categories:
 1. To propose a new feature, please file a new feature request
    [issue](https://github.com/CVCUDA/CV-CUDA/issues/new/choose). Describe the
    intended feature and discuss the design and implementation with the team and
-   community. NOTE: Currently, as of release v0.3.0-beta, CV-CUDA is not accepting
+   community. NOTE: Currently, as of release v0.3.1-beta, CV-CUDA is not accepting
    outside contribution.
 1. To ask a general question, please sumbit a question
    [issue](https://github.com/CVCUDA/CV-CUDA/issues/new/choose). If you need

DEVELOPER_GUIDE.md

@@ -20,11 +20,8 @@ CV-CUDA includes:
 
 | Pre/Post-Processing Operators | Definition |
 |-------------------------------|------------|
-| Adaptive Thresholding | Computes the threshold value for each fractional region of the image |
 | AverageBlur | Reduces image noise using an average filter |
 | BilateralFilter | Reduces image noise while preserving strong edges |
-| Bounding Box | Draws an overlay 2D rectangular bounding box using the coordinate points |
-| Bounding Box Blur | Adds a 2D rectangular blur in the region of interest <br> (ROI) using the coordinate points |
 | CenterCrop | Crops an image at its center |
 | ChannelReorder | Shuffles the order of image channels |
 | Composite | Composites two images together |
@@ -35,21 +32,18 @@ CV-CUDA includes:
 | DataTypeConvert | Converts an image’s data type, with optional scaling |
 | Erase | Erases image regions |
 | Flip | Flips a 2D image around its axis |
-| GammaContrast | Adjusts image contrast based on gamma value |
+| GammaContrast | Adjusts image contrast |
 | Gaussian | Applies a gaussian blur filter to the image |
 | JointBilateralFilter | Reduces image noise while preserving strong edges <br> based on a guidance image |
 | Laplacian | Applies a Laplace transform to an image |
 | MedianBlur | Reduces an image’s salt-and-pepper noise |
 | Morphology | Performs morphological erode and dilate transformations |
-| Non-Max Suppression | Selects the best bounding box out of a set of <br> overlapping boxes based on IOU and confidence thresholds |
 | Normalize | Normalizes an image pixel’s range |
 | PadStack | Stacks several images into a tensor, with border extension |
 | PillowResize | Changes the size and scale of an image using python-pillow algorithm |
 | Reformat | Converts a planar image into non-planar and vice versa |
-| Remap | Applies a generic geometrical transformation to an image, for <br> example, to perform fisheye dewarping |
 | Resize | Changes the size and scale of an image |
 | Rotate | Rotates a 2D array in multiples of 90 degrees |
-| Thresholding | Computes the threshold value based on the histogram of the <br> overall pixel intensity distribution of the image |
 | WarpAffine | Applies an affine transformation to an image |
 | WarpPerspective | Applies a perspective transformation to an image |
 

README.md

@@ -2,7 +2,7 @@
 
 [![License](https://img.shields.io/badge/License-Apache_2.0-yellogreen.svg)](https://opensource.org/licenses/Apache-2.0)
 
-![Version](https://img.shields.io/badge/Version-v0.3.0--alpha-blue)
+![Version](https://img.shields.io/badge/Version-v0.3.1--beta-blue)
 
 ![Platform](https://img.shields.io/badge/Platform-linux--64_%7C_win--64_wsl2-gray)
 
@@ -18,7 +18,7 @@ efficient pre- and post-processing pipelines. CV-CUDA originated as a
 collaborative effort between [NVIDIA][NVIDIA Develop] and [ByteDance][ByteDance].
 
 Refer to our [Developer Guide](DEVELOPER_GUIDE.md) for more information on the
-operators available as of release v0.3.0-beta.
+operators available as of release v0.3.1-beta.
 
 ## Getting Started
 
@@ -27,14 +27,14 @@ To get a local copy up and running follow these steps.
 ### Pre-requisites
 
 - Linux distro:
-  - Ubuntu x86_64 == 18.04, 20.04, 22.04
-  - WSL2 with Ubuntu >= 20.04 (https://docs.nvidia.com/cuda/wsl-user-guide/index.html)
-- NVIDIA driver >= 515.43.04+
-- CUDA Toolkit >= 11.7
-  - Toolkit >= 11.3 support for core library build and run
+  - Ubuntu x86_64 >= 18.04
+  - WSL2 with Ubuntu >= 20.04 (tested with 20.04)
+- NVIDIA driver
+    - Linux: Driver version 520.56.06 or higher
+- CUDA Toolkit
+    - Version 11.7 or above. (12.0 is not yet tested.)
 - GCC >= 11.0
-  - GCC >= 9.0 supported for core library build and run
-- Python == 3.7, 3.8, 3.10
+- Python >= 3.7
 - cmake >= 3.22
 
 ### Installation
@@ -45,20 +45,20 @@ packages. Choose the installation method that meets your environment needs.
 #### Tar File Installation
 
 ```shell
-tar -xvf nvcv-lib-0.3.0-cuda11-x86_64-linux.tar.xz
-tar -xvf nvcv-dev-0.3.0-cuda11-x86_64-linux.tar.xz
+tar -xvf nvcv-lib-0.3.1-cuda11-x86_64-linux.tar.xz
+tar -xvf nvcv-dev-0.3.1-cuda11-x86_64-linux.tar.xz
 ```
 
 #### DEB File Installation
 
 ```shell
-sudo apt-get install -y ./nvcv-lib-0.3.0-cuda11-x86_64-linux.deb ./nvcv-dev-0.3.0-cuda11-x86_64-linux.deb
+sudo apt-get install -y ./nvcv-lib-0.3.1-cuda11-x86_64-linux.deb ./nvcv-dev-0.3.1-cuda11-x86_64-linux.deb
 ```
 
 #### Python WHL File Installation
 
 ```shell
-pip install nvcv_python-0.3.0-cp38-cp38-linux_x86_64.whl
+pip install nvcv_python-0.3.1-cp38-cp38-linux_x86_64.whl
 ```
 
 ### Build from Source
@@ -208,7 +208,7 @@ Follow these instruction to build CV-CUDA from source:
 
 CV-CUDA is an open source project. As part of the Open Source Community, we are
 committed to the cycle of learning, improving, and updating that makes this
-community thrive. However, as of release v0.3.0-beta, CV-CUDA is not yet ready
+community thrive. However, as of release v0.3.1-beta, CV-CUDA is not yet ready
 for external contributions.
 
 To understand the process for contributing the CV-CUDA, see our

ci/build_docs.sh

@@ -1,6 +1,6 @@
 #!/bin/bash -e
 
-# SPDX-FileCopyrightText: Copyright (c) 2022 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-FileCopyrightText: Copyright (c) 2022-2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -25,4 +25,4 @@ if [[ $# -ge 1 ]]; then
    build_dir=$1
 fi
 
- ./ci/build.sh $build_type $build_dir "-DBUILD_DOCS=ON -DBUILD_TESTS=OFF -DBUILD_PYTHON=OFF"
+./ci/build.sh $build_type $build_dir "-DBUILD_DOCS=ON -DBUILD_TESTS=OFF -DBUILD_PYTHON=ON"

docker/build/Dockerfile

@@ -94,3 +94,6 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
      ./libstdc++-8-dev_8.4.0-3ubuntu2_amd64.deb \
      ./libisl22_0.22.1-1_amd64.deb \
     && rm -rf /var/lib/apt/lists/*
+
+# Needed for python sphinx docs
+RUN python3 -m pip install numpy==1.24.1

docker/config

@@ -17,13 +17,13 @@
 #         reason: we include this file from other scripts, no need to export it
 # shellcheck disable=SC2034
 
-IMAGE_URL_BASE=''
+IMAGE_URL_BASE='gitlab-master.nvidia.com:5005/cv/cvcuda'
 
 # image versions must be upgraded whenever a breaking
 # change is done, such as removing some package, or updating
 # packaged versions that introduces incompatibilities.
-TAG_IMAGE=0
-TAG_IMAGE_SAMPLES=0
+TAG_IMAGE=4
+TAG_IMAGE_SAMPLES=5
 
 VER_CUDA=11.7.0
 VER_UBUNTU=22.04

docker/devel/Dockerfile

@@ -49,7 +49,7 @@ RUN DEBIAN_FRONTEND="noninteractive" apt-get update \
     && rm -rf /var/lib/apt/lists/*
 
 # needed by tests
-RUN python3 -m pip install torch==1.13.0 torchvision numpy==1.24.1 cupy-cuda11x \
+RUN python3 -m pip install torch==1.13.0 torchvision cupy-cuda11x \
     && rm -rf /root/.cache/pip
 
 WORKDIR /cvcuda

docs/CMakeLists.txt

@@ -31,12 +31,17 @@ set(DOXYGEN_IMAGE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/assets)
 # Replace variables inside @@ with the current value
 configure_file(${DOXYFILE_IN} ${DOXYFILE_OUT} @ONLY)
 
-# Only regenerate Doxygen when the Doxyfile change
+# Only regenerate Doxygen when the Doxyfile changes
+
+# Build docs once python libraries are generated
 file(MAKE_DIRECTORY ${DOXYGEN_OUTPUT_DIR})
+list(GET PYTHON_VERSIONS -1 VER)
+
 add_custom_command(OUTPUT ${DOXYGEN_INDEX_FILE}
                    COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYFILE_OUT}
                    MAIN_DEPENDENCY ${DOXYFILE_OUT} ${DOXYFILE_IN}
-                   COMMENT "Generating doxygen xml")
+                   COMMENT "Generating doxygen xml"
+	   	   DEPENDS nvcv_python${VER})
 
 add_custom_target(cvcuda_doxygen ALL DEPENDS ${DOXYGEN_INDEX_FILE})
 
@@ -54,6 +59,7 @@ add_custom_target(cvcuda_groups ALL
 # Generate Sphinx
 add_custom_command(OUTPUT ${SPHINX_INDEX_FILE}
                    COMMAND
+		   ${CMAKE_COMMAND} -E env "SPHINX_PYTHON_SRC=${CMAKE_BINARY_DIR}/lib/python"
                    ${SPHINX_EXECUTABLE} -j auto -b html
                    # Tell Breathe where to find the Doxygen output
                    -Dbreathe_projects.cvcuda=${DOXYGEN_OUTPUT_DIR}/xml
@@ -65,7 +71,6 @@ add_custom_command(OUTPUT ${SPHINX_INDEX_FILE}
                    MAIN_DEPENDENCY ${SPHINX_SOURCE}/conf.py
                    COMMENT "Generating documentation with Sphinx")
 
-
 add_custom_target(cvcuda_sphinx ALL DEPENDS ${SPHINX_INDEX_FILE})
 
 install(DIRECTORY ${SPHINX_BUILD} DESTINATION docs)

docs/sphinx/conf.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: Copyright (c) 2022 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-FileCopyrightText: Copyright (c) 2022-2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -30,13 +30,17 @@
 # -- Project information -----------------------------------------------------
 import os
 import sphinx_rtd_theme
+import sys
 
 project = "CV-CUDA"
-copyright = "2022, NVIDIA."
+copyright = "2022-2023, NVIDIA."
 author = "NVIDIA"
-version = "Alpha"
+version = "Beta"
 release = version
 
+# set python docstring source path
+lib_path = os.getenv("SPHINX_PYTHON_SRC", default=".")
+sys.path.insert(0, os.path.abspath(lib_path))
 
 # -- General configuration ---------------------------------------------------
 
@@ -114,6 +118,9 @@ def setup(app):
 # Enable the breathe extension
 extensions.append("breathe")
 extensions.append("exhale")
+extensions.append("sphinx.ext.autodoc")
+extensions.append("sphinx.ext.viewcode")
+extensions.append("sphinx.ext.napoleon")
 
 # Set up the default project for breathe extension
 breathe_default_project = "cvcuda"
@@ -183,3 +190,5 @@ def setup(app):
 
 # Tell sphinx what the pygments highlight language should be.
 highlight_language = "cpp"
+
+autodoc_inherit_docstrings = False