improve docs

Author: robertsulej

docs/npoptix_config.rst

@@ -18,6 +18,7 @@ Start, configure, get output
 .. automethod:: plotoptix.NpOptiX._run_event_loop
 .. automethod:: plotoptix.NpOptiX.run
 .. automethod:: plotoptix.NpOptiX.get_gpu_architecture
+.. automethod:: plotoptix.NpOptiX.enable_torch
 
 Scene configuration
 -------------------
@@ -126,7 +127,9 @@ GPU variables related to the raytracer general configuraton are documented below
 .. automethod:: plotoptix.NpOptiX.get_float
 .. automethod:: plotoptix.NpOptiX.get_float2
 .. automethod:: plotoptix.NpOptiX.get_float3
+.. automethod:: plotoptix.NpOptiX.set_torch_texture_1d
 .. automethod:: plotoptix.NpOptiX.set_texture_1d
+.. automethod:: plotoptix.NpOptiX.set_torch_texture_2d
 .. automethod:: plotoptix.NpOptiX.set_texture_2d
 .. automethod:: plotoptix.NpOptiX.load_texture
 

plotoptix/npoptix.py

@@ -278,6 +278,11 @@ def __del__(self):
 
     def enable_torch(self):
         """Enable pytorch features.
+
+        Required before any call to PyTorch related methods:
+        :meth:`plotoptix.NpOptiX.set_torch_texture_1d`, :meth:`plotoptix.NpOptiX.set_torch_texture_2d`,
+        or :meth:`plotoptix.NpOptiX.update_raw_data` with torch tensor used.
+
         """
         import importlib
         try:
@@ -1197,6 +1202,10 @@ def set_torch_texture_1d(self, name: str, data: Any,
             Store texture data copy in the host memory.
         refresh : bool, optional
             Set to ``True`` if the image should be re-computed.
+
+        See Also
+        --------
+        :meth:`plotoptix.NpOptiX.enable_torch`
         """
         if self._torch is None:
             self._logger.error("Torch features are not enabled, use rt.enable_torch() first.")
@@ -1382,6 +1391,10 @@ def set_torch_texture_2d(self, name: str, data: Any,
             Store texture data copy in the host memory.
         refresh : bool, optional
             Set to ``True`` if the image should be re-computed.
+
+        See Also
+        --------
+        :meth:`plotoptix.NpOptiX.enable_torch`
         """
 
         if self._torch is None:
@@ -4494,6 +4507,7 @@ def update_raw_data(self, name: str,
 
         See Also
         --------
+        :meth:`plotoptix.NpOptiX.enable_torch`
         :meth:`plotoptix.NpOptiX.update_data`
         :meth:`plotoptix.NpOptiX.get_data`
         """