cuda support warnings, minor updates

Author: chrischoy

CHANGELOG.md

@@ -4,7 +4,9 @@
 
 ### Added
 
+- v0.5 documentation updates
 - Nonlinear functionals and modules
+- Warning when using cuda without ME cuda support
 
 ## [0.5.0a] - 2020-08-05
 

MinkowskiEngine/MinkowskiChannelwiseConvolution.py

@@ -114,7 +114,9 @@ def __init__(
         """
 
         super(MinkowskiChannelwiseConvolution, self).__init__()
-        assert dimension > 0, f"dimension must be a positive integer, {dimension}"
+        assert (
+            dimension > 0
+        ), f"Invalid dimension. Please provide a valid dimension argument. dimension={dimension}"
 
         if kernel_generator is None:
             kernel_generator = KernelGenerator(

MinkowskiEngine/MinkowskiConvolution.py

@@ -238,7 +238,9 @@ def __init__(
 
         """
         super(MinkowskiConvolutionBase, self).__init__()
-        assert dimension > 0, f"dimension must be a positive integer, {dimension}"
+        assert (
+            dimension > 0
+        ), f"Invalid dimension. Please provide a valid dimension argument. dimension={dimension}"
 
         if kernel_generator is None:
             kernel_generator = KernelGenerator(

MinkowskiEngine/MinkowskiCoordinateManager.py

@@ -133,6 +133,10 @@ def __init__(
         if coordinate_map_type == CoordinateMapType.CPU:
             postfix = "CPU"
         else:
+            assert (
+                _C.is_cuda_available()
+            ), "The MinkowskiEngine was compiled with CPU_ONLY flag. If you want to compile with CUDA support, make sure `torch.cuda.is_available()` is True when you install MinkowskiEngine."
+
             postfix = "GPU" + (
                 "_default" if allocator_type == GPUMemoryAllocatorType.CUDA else "_c10"
             )

MinkowskiEngine/MinkowskiPooling.py

@@ -129,7 +129,9 @@ def __init__(
         dimension=-1,
     ):
         super(MinkowskiPoolingBase, self).__init__()
-        assert dimension > 0, f"dimension must be a positive integer, {dimension}"
+        assert (
+            dimension > 0
+        ), f"Invalid dimension. Please provide a valid dimension argument. dimension={dimension}"
 
         if kernel_generator is None:
             kernel_generator = KernelGenerator(

MinkowskiEngine/__init__.py

@@ -197,3 +197,14 @@
 import MinkowskiEngine.modules as modules
 
 from sparse_matrix_functions import spmm, MinkowskiSPMMFunction
+
+
+if not is_cuda_available():
+    warnings.warn(
+        " ".join(
+            [
+                "The MinkowskiEngine was compiled with CPU_ONLY flag.",
+                "If you want to compile with CUDA support, make sure `torch.cuda.is_available()` is True when you install MinkowskiEngine.",
+            ]
+        )
+    )

README.md

@@ -9,13 +9,9 @@ The Minkowski Engine is an auto-differentiation library for sparse tensors. It s
 
 ## News
 
-- 2020-12-24 v0.5 is now available! Try with `pip install git+https://github.com/NVIDIA/MinkowskiEngine.git`.
+- 2020-12-24 v0.5 is now available!
 - 2020-08-18 v0.5 beta version is now available! [The speedup compared with v0.4.3 ranges from x2 to x5 depending on the network architectures](https://github.com/chrischoy/MinkowskiEngineBenchmark). Please install with the following command. The migration guide from v0.4 to v0.5 is available at [the wiki page](https://github.com/NVIDIA/MinkowskiEngine/wiki/Migration-Guide-from-v0.4.x-to-0.5.x). Feel free to update the wiki page to add and update any discrepancies you see.
 
-```
-pip install git+https://github.com/NVIDIA/MinkowskiEngine.git
-```
-
 ## Example Networks
 
 The Minkowski Engine supports various functions that can be built on a sparse tensor. We list a few popular network architectures and applications here. To run the examples, please install the package and run the command in the package root directory.