doc v0.5 updates

Author: chrischoy

MinkowskiEngine/MinkowskiCoordinateManager.py

@@ -71,7 +71,7 @@ def set_gpu_allocator(backend: GPUMemoryAllocatorType):
     than allocating GPU directly using raw CUDA calls.
 
     By default, the Minkowski Engine uses
-    :attr:`ME.MemoryManagerBackend.PYTORCH` for memory management.
+    :attr:`ME.GPUMemoryAllocatorType.PYTORCH` for memory management.
 
     Example::
 
@@ -84,7 +84,7 @@ def set_gpu_allocator(backend: GPUMemoryAllocatorType):
     """
     assert isinstance(
         backend, GPUMemoryAllocatorType
-    ), f"Input must be an instance of MemoryManagerBackend not {backend}"
+    ), f"Input must be an instance of GPUMemoryAllocatorType not {backend}"
     global _allocator_type
     _allocator_type = backend
 

MinkowskiEngine/MinkowskiSparseTensor.py

@@ -89,9 +89,10 @@ class SparseTensor(Tensor):
 
        To use the GPU-backend for coordinate management, the
        :attr:`coordinates` must be a torch tensor on GPU. Applying `to(device)`
-       after a :attr:`MinkowskiEngine.SparseTensor` initialization with a CPU
-       `coordinates` will waste time and computation for creating a CPU
-       CoordinateMap since GPU CoordinateMap will be created from scratch.
+       after :attr:`MinkowskiEngine.SparseTensor` initialization with a CPU
+       `coordinates` will waste time and computation on creating an unnecessary
+       CPU CoordinateMap since the GPU CoordinateMap will be created from
+       scratch as well.
 
     .. warning::
 
@@ -145,6 +146,10 @@ def __init__(
             associated to the features. If not provided, :attr:`coordinate_map_key`
             must be provided.
 
+            :attr:`tensor_stride` (:attr:`int`, :attr:`list`,
+            :attr:`numpy.array`, or :attr:`tensor.Tensor`): The tensor stride
+            of the current sparse tensor. By default, it is 1.
+
             :attr:`coordinate_map_key`
             (:attr:`MinkowskiEngine.CoordinateMapKey`): When the coordinates
             are already cached in the MinkowskiEngine, we could reuse the same
@@ -164,11 +169,22 @@ def __init__(
             continuous coordinates will be quantized to define a sparse tensor.
             Please refer to :attr:`SparseTensorQuantizationMode` for details.
 
+            :attr:`allocator_type`
+            (:attr:`MinkowskiEngine.GPUMemoryAllocatorType`): Defines the GPU
+            memory allocator type. By default, it uses the c10 allocator.
+
+            :attr:`minkowski_algorithm`
+            (:attr:`MinkowskiEngine.MinkowskiAlgorithm`): Controls the mode the
+            minkowski engine runs, Use
+            :attr:`MinkowskiAlgorithm.MEMORY_EFFICIENT` if you want to reduce
+            the memory footprint. Or use
+            :attr:`MinkowskiAlgorithm.SPEED_OPTIMIZED` if you want to make it
+            run fasterat the cost of more memory.
+
             :attr:`requires_grad` (:attr:`bool`): Set the requires_grad flag.
 
-            :attr:`tensor_stride` (:attr:`int`, :attr:`list`,
-            :attr:`numpy.array`, or :attr:`tensor.Tensor`): The tensor stride
-            of the current sparse tensor. By default, it is 1.
+            :attr:`device` (:attr:`torch.device`): Set the device the sparse
+            tensor is defined.
 
         """
         # Type checks

MinkowskiEngine/MinkowskiTensor.py

@@ -99,17 +99,26 @@ def set_sparse_tensor_operation_mode(operation_mode: SparseTensorOperationMode):
     _sparse_tensor_operation_mode = operation_mode
 
 
-def sparse_tensor_operation_mode():
+def sparse_tensor_operation_mode() -> SparseTensorOperationMode:
+    r"""Return the current sparse tensor operation mode.
+    """
     global _sparse_tensor_operation_mode
     return copy.deepcopy(_sparse_tensor_operation_mode)
 
 
 def global_coordinate_manager():
+    r"""Return the current global coordinate manager
+    """
     global _global_coordinate_manager
     return _global_coordinate_manager
 
 
 def set_global_coordinate_manager(coordinate_manager):
+    r"""Set the global coordinate manager.
+
+    :attr:`MinkowskiEngine.CoordinateManager` The coordinate manager which will
+    be set to the global coordinate manager.
+    """
     global _global_coordinate_manager
     _global_coordinate_manager = coordinate_manager
 

MinkowskiEngine/MinkowskiTensorField.py

@@ -71,12 +71,16 @@ def __init__(
             associated to the features. If not provided, :attr:`coordinate_map_key`
             must be provided.
 
-            :attr:`coordinate_map_key`
+            :attr:`tensor_stride` (:attr:`int`, :attr:`list`,
+            :attr:`numpy.array`, or :attr:`tensor.Tensor`): The tensor stride
+            of the current sparse tensor. By default, it is 1.
+
+            :attr:`coordinate_field_map_key`
             (:attr:`MinkowskiEngine.CoordinateMapKey`): When the coordinates
             are already cached in the MinkowskiEngine, we could reuse the same
             coordinate map by simply providing the coordinate map key. In most
             case, this process is done automatically. When you provide a
-            `coordinate_map_key`, `coordinates` will be be ignored.
+            `coordinate_field_map_key`, `coordinates` will be be ignored.
 
             :attr:`coordinate_manager`
             (:attr:`MinkowskiEngine.CoordinateManager`): The MinkowskiEngine
@@ -90,12 +94,22 @@ def __init__(
             continuous coordinates will be quantized to define a sparse tensor.
             Please refer to :attr:`SparseTensorQuantizationMode` for details.
 
-            :attr:`requires_grad` (:attr:`bool`): Set the requires_grad flag.
+            :attr:`allocator_type`
+            (:attr:`MinkowskiEngine.GPUMemoryAllocatorType`): Defines the GPU
+            memory allocator type. By default, it uses the c10 allocator.
 
-            :attr:`tensor_stride` (:attr:`int`, :attr:`list`,
-            :attr:`numpy.array`, or :attr:`tensor.Tensor`): The tensor stride
-            of the current sparse tensor. By default, it is 1.
+            :attr:`minkowski_algorithm`
+            (:attr:`MinkowskiEngine.MinkowskiAlgorithm`): Controls the mode the
+            minkowski engine runs, Use
+            :attr:`MinkowskiAlgorithm.MEMORY_EFFICIENT` if you want to reduce
+            the memory footprint. Or use
+            :attr:`MinkowskiAlgorithm.SPEED_OPTIMIZED` if you want to make it
+            run fasterat the cost of more memory.
+
+            :attr:`requires_grad` (:attr:`bool`): Set the requires_grad flag.
 
+            :attr:`device` (:attr:`torch.device`): Set the device the sparse
+            tensor is defined.
         """
         # Type checks
         assert isinstance(features, torch.Tensor), "Features must be a torch.Tensor"

MinkowskiEngine/__init__.py

@@ -73,6 +73,8 @@
     SparseTensorQuantizationMode,
     set_sparse_tensor_operation_mode,
     sparse_tensor_operation_mode,
+    global_coordinate_manager,
+    set_global_coordinate_manager,
     clear_global_coordinate_manager,
 )
 

MinkowskiEngine/utils/__init__.py

@@ -23,5 +23,5 @@
 # of the code.
 from .quantization import sparse_quantize, ravel_hash_vec, fnv_hash_vec, unique_coordinate_map
 from .collation import SparseCollation, batched_coordinates, sparse_collate, batch_sparse_collate
-from .coords import get_coords_map
+# from .coords import get_coords_map
 from .init import kaiming_normal_

docs/benchmark.md

@@ -1,6 +1,6 @@
 # Benchmark
 
-We report the feed forward and backward pass time of a convolution layer, and a small U-network. Note that the kernel map can be reused for other layers with the same tensor-stride, stride, and kernel offsets, thus the time reported in this page can be amortized across all layers used in a large nueral network.
+We report the feed forward and backward pass time of a convolution layer, and a small U-network for v0.4.3. Note that the kernel map can be reused for other layers with the same tensor-stride, stride, and kernel offsets, thus the time reported in this page can be amortized across all layers used in a large nueral network.
 
 We use a Titan X for the experiments.
 

docs/coords.rst

@@ -1,32 +1,32 @@
 Coordinate Management
 =====================
 
-CoordsKey
----------
+CoordinateMapKey
+----------------
 
-.. autoclass:: MinkowskiEngine.CoordsKey
+.. autoclass:: MinkowskiEngine.CoordinateMapKey
     :members:
     :undoc-members:
     :exclude-members: __repr__
 
     .. automethod:: __init__
 
 
-CoordsManager
--------------
+CoordinateManager
+-----------------
 
-.. autoclass:: MinkowskiEngine.CoordsManager
+.. autoclass:: MinkowskiEngine.CoordinateManager
     :members:
     :undoc-members:
     :exclude-members: __repr__
 
     .. automethod:: __init__
 
 
-Coordinate GPU Memory Manager
------------------------------
+GPU Memory Allocator
+--------------------
 
-.. autoclass:: MinkowskiEngine.MemoryManagerBackend
+.. autoclass:: MinkowskiEngine.GPUMemoryAllocatorType
     :members:
 
-.. autofunction:: MinkowskiEngine.MinkowskiCoords.set_memory_manager_backend
+.. autofunction:: MinkowskiEngine.set_gpu_allocator

docs/demo/interop.rst

@@ -32,7 +32,7 @@ a min-batch.
                    kernel_size=3,
                    stride=2,
                    dilation=1,
-                   has_bias=False,
+                   bias=False,
                    dimension=D), ME.MinkowskiBatchNorm(64), ME.MinkowskiReLU(),
                ME.MinkowskiConvolution(
                    in_channels=64,
@@ -66,7 +66,7 @@ accessing the features of the sparse tensor
 
        # Get new data
        coords, feat, label = data_loader()
-       input = ME.SparseTensor(feat, coords=coords).to(device)
+       input = ME.SparseTensor(features=feat, coordinates=coords, device=device)
        label = label.to(device)
 
        # Forward