doc v0.5 updates

NVIDIA · Jan 5, 2021 · 5f36307 · 5f36307
1 parent f8ae4ad
commit 5f36307
Show file tree

Hide file tree

Showing 16 changed files with 333 additions and 219 deletions.
diff --git a/MinkowskiEngine/MinkowskiCoordinateManager.py b/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
 

diff --git a/MinkowskiEngine/MinkowskiTensor.py b/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
 

diff --git a/MinkowskiEngine/__init__.py b/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,
 )
 

diff --git a/MinkowskiEngine/utils/__init__.py b/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_
diff --git a/docs/benchmark.md b/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.
 

diff --git a/docs/coords.rst b/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
diff --git a/docs/demo/interop.rst b/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