Skip to content

Commit cd7ac83

Browse files
committed
TarDataGenerator docstring update
1 parent 469d747 commit cd7ac83

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

mlspm/data_generation.py

+8
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,14 @@ class TarDataGenerator:
139139
- ``'lattice'``: Lattice vectors as an array of shape ``(3, 3)``, where the rows are the vectors.
140140
- ``'xyz'``: Atom xyz coordinates as an array of shape ``(n_atoms, 3)``.
141141
- ``'Z'``: Atom atomic numbers as an array of shape ``(n_atoms,)``.
142+
143+
Yields dicts that contain the following:
144+
145+
- ``'xyzs'``: Atom xyz coordinates.
146+
- ``'Zs'``: Atomic numbers.
147+
- ``'qs'``: Sample Hartree potential.
148+
- ``'rho_sample'``: Sample electron density if the sample dict contained ``rho``, or ``None`` otherwise.
149+
- ``'rot'``: Rotation matrix.
142150
143151
Note: it is recommended to use ``multiprocessing.set_start_method('spawn')`` when using the :class:`TarDataGenerator`.
144152
Otherwise a lot of warnings about leaked memory objects may be thrown on exit.

0 commit comments

Comments
 (0)