Docstring for attribute space_groups_subset

alexhernandezgarcia · Oct 18, 2023 · 4cd042a · 4cd042a
1 parent 75aa91e
commit 4cd042a
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/gflownet/envs/crystals/spacegroup.py b/gflownet/envs/crystals/spacegroup.py
@@ -97,6 +97,11 @@ def __init__(
         """
         Args
         ----
+        space_groups_subset : iterable
+            A subset of space group (international) numbers to which to restrict the
+            state space. If None (default), the entire set of 230 space groups is
+            considered.
+
         n_atoms : list of int (optional)
             A list with the number of atoms per element, used to compute constraints on
             the space group. 0's are removed from the list. If None, composition/space