improve wrapped architecture documenation

janelia-cellmap · Feb 18, 2025 · 0b72a22 · 0b72a22
1 parent 98272b3
commit 0b72a22
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/dacapo/experiments/architectures/wrapped_architecture.py b/dacapo/experiments/architectures/wrapped_architecture.py
@@ -12,7 +12,9 @@
 @attr.s
 class WrappedArchitectureConfig(ArchitectureConfig):
     """
-    A thin wrapper allowing users to pass in any architecture they want
+    A thin wrapper around user provided `torch.nn.Module` instances. It can be provided
+    via a python object, or a file path that can be loaded with `torch.load`. This includes
+    pickled modules or jit-compiled modules.
     """
 
     _module: torch.nn.Module | Path = attr.ib(