updates missing fn in doc

NVIDIA · Jan 7, 2021 · ac55d00 · ac55d00
1 parent 6db3c49
commit ac55d00
Show file tree

Hide file tree

Showing 6 changed files with 105 additions and 15 deletions.
diff --git a/docs/convolution.rst b/docs/convolution.rst
@@ -14,6 +14,16 @@ MinkowskiConvolution
     .. automethod:: __init__
 
 
+MinkowskiChannelwiseConvolution
+-------------------------------
+
+.. autoclass:: MinkowskiEngine.MinkowskiChannelwiseConvolution
+    :members: cpu, cuda, double, float, to, type, forward
+    :undoc-members:
+
+    .. automethod:: __init__
+
+
 MinkowskiConvolutionTranspose
 -----------------------------
 
@@ -22,3 +32,13 @@ MinkowskiConvolutionTranspose
     :undoc-members:
 
     .. automethod:: __init__
+
+
+MinkowskiGenerativeConvolutionTranspose
+---------------------------------------
+
+.. autoclass:: MinkowskiEngine.MinkowskiGenerativeConvolutionTranspose
+    :members: cpu, cuda, double, float, to, type, forward
+    :undoc-members:
+
+    .. automethod:: __init__
diff --git a/docs/index.rst b/docs/index.rst
@@ -44,6 +44,7 @@ Table of Contents
    normalization
    nonlinearity
    pruning
+   interp
    union
    coords
    utils

diff --git a/docs/interp.rst b/docs/interp.rst
@@ -0,0 +1,12 @@
+MinkowskiInterpolation
+======================
+
+
+MinkowskiInterpolation
+----------------------
+
+.. autoclass:: MinkowskiEngine.MinkowskiInterpolation
+    :members: cpu, cuda, double, float, to, type, forward
+    :undoc-members:
+
+    .. automethod:: __init__
diff --git a/docs/misc.rst b/docs/misc.rst
@@ -9,6 +9,33 @@ The kernel map `[1] <https://arxiv.org/abs/1904.08755>`_ defines which row of an
 By default, we use all CPU threads available in the system. However, this might not be desirable in some cases. Simply define an environmental variable ``OMP_NUM_THREADS`` to control the number of threads you want to use. For example, ``export OMP_NUM_THREADS=8; python your_program.py``. If you use SLURM, the environment variable ``OMP_NUM_THREADS`` will be automatically set.
 
 
+
+is_cuda_available
+-----------------
+
+.. autofunction:: MinkowskiEngine.is_cuda_available
+
+
+cuda_version
+------------
+
+.. autofunction:: MinkowskiEngine.cuda_version
+
+
+get_gpu_memory_info
+-------------------
+
+.. autofunction:: MinkowskiEngine.get_gpu_memory_info
+
+
+set_memory_manager_backend
+--------------------------
+
+.. autofunction:: MinkowskiEngine.set_memory_manager_backend
+
+
+
+
 References
 ----------
 

diff --git a/docs/sparse_tensor.rst b/docs/sparse_tensor.rst
@@ -1,5 +1,5 @@
-SparseTensor
-============
+SparseTensor and TensorField
+============================
 
 SparseTensor
 ------------
@@ -11,21 +11,49 @@ SparseTensor
     .. automethod:: __init__
 
 
-Sparse Tensor Operation Mode
-----------------------------
+TensorField
+-----------
+
+.. autoclass:: MinkowskiEngine.MinkowskiTensorField.TensorField
+    :members:
+    :undoc-members:
+
+    .. automethod:: __init__
+
+
+SparseTensorOperationMode
+-------------------------
 
 .. autoclass:: MinkowskiEngine.MinkowskiTensor.SparseTensorOperationMode
     :members:
 
+SparseTensorQuantizationMode
+----------------------------
+
 .. autoclass:: MinkowskiEngine.MinkowskiTensor.SparseTensorQuantizationMode
     :members:
 
+set_sparse_tensor_operation_mode
+--------------------------------
+
 .. autofunction:: MinkowskiEngine.MinkowskiTensor.set_sparse_tensor_operation_mode
 
+sparse_tensor_operation_mode
+----------------------------
+
 .. autofunction:: MinkowskiEngine.MinkowskiTensor.sparse_tensor_operation_mode
 
+global_coordinate_manager
+-------------------------
+
 .. autofunction:: MinkowskiEngine.MinkowskiTensor.global_coordinate_manager
 
+set_global_coordinate_manager
+-----------------------------
+
 .. autofunction:: MinkowskiEngine.MinkowskiTensor.set_global_coordinate_manager
 
+clear_global_coordinate_manager
+-------------------------------
+
 .. autofunction:: MinkowskiEngine.MinkowskiTensor.clear_global_coordinate_manager
diff --git a/docs/utils.rst b/docs/utils.rst
@@ -1,6 +1,7 @@
 Utility Functions and Classes
 =============================
 
+
 sparse_quantize
 ---------------
 
@@ -25,18 +26,8 @@ batch_sparse_collate
 .. autofunction:: MinkowskiEngine.utils.batch_sparse_collate
 
 
-SparseCollation
----------------
-
-.. autoclass:: MinkowskiEngine.utils.SparseCollation
-    :members:
-    :undoc-members:
-
-    .. automethod:: __init__
-
-
 cat
-___
+---
 
 .. autofunction:: MinkowskiEngine.cat
 
@@ -46,6 +37,17 @@ to_sparse
 
 .. autofunction:: MinkowskiEngine.to_sparse
 
+
+SparseCollation
+---------------
+
+.. autoclass:: MinkowskiEngine.utils.SparseCollation
+    :members:
+    :undoc-members:
+
+    .. automethod:: __init__
+
+
 MinkowskiToSparseTensor
 -----------------------