Skip to content

Commit 655a68e

Browse files
committed
Update docstrings of dataset methods
1 parent e7a5a80 commit 655a68e

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

mattergen/common/data/dataset.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ def from_cache_path(
101101
Load a dataset from a specified cache path.
102102
103103
Args:
104-
name: Name of the reference dataset.
104+
cache_path: Path to the cache directory containing the dataset.
105105
transforms: List of transforms to apply to **each datapoint** when loading, e.g., to make the lattice matrices symmetric.
106106
properties: List of properties to condition on.
107107
dataset_transforms: List of transforms to apply to the **whole dataset**, e.g., to filter out certain entries.
@@ -318,9 +318,8 @@ def from_num_atoms_distribution(
318318
319319
Args:
320320
num_atoms_distribution: A dictionary with the number of atoms as keys and the probability of that number of atoms as values.
321+
num_samples: The number of samples to generate.
321322
transforms: List of transforms to apply to **each datapoint** when loading, e.g., to make the lattice matrices symmetric.
322-
properties: List of properties to condition on.
323-
dataset_transforms: List of transforms to apply to the **whole dataset**, e.g., to filter out certain entries.
324323
325324
Returns:
326325
The dataset.

0 commit comments

Comments
 (0)