Skip to content

Commit 469174b

Browse files
committed
add docstring for vectorize parameter in sample
1 parent a0eafc8 commit 469174b

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

driftbench/data_generation/sample.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,15 @@ def sample_curves(
1818
1919
Args:
2020
dataset_specification (dict): A dataset specification which contains
21-
all information to syntethisize curves in yaml-format.
21+
all information to synthesize curves in yaml-format.
2222
Each dataset is encoded with a name and needs a latent information provided.
2323
The function `f` to fit and as well as initial guess `w0`can be provided as well.
2424
f (Callable): The function to fit the curves. Use this parameter if no function is specified
2525
in `dataset_specification`.
26-
w0 (np.ndarray): The inital guess for the optimization problem used to synthesize curves.
26+
w0 (np.ndarray): The initial guess for the optimization problem used to synthesize curves.
2727
Use this parameter if no initial guess is specified in `dataset_specification`.
28-
random_state (int): The random state for reproducablity.
28+
random_state (int): The random state for reproducibility.
29+
vectorize (bool): Whether to vectorize the optimization over multiple latent information instances.
2930
measurement_scale (float): The scale for the noise applied on the evaluated curves. If not
3031
set, 5% percent of the mean of the curves is used. Set to 0.0 if you want to omit
3132
this noise.

0 commit comments

Comments
 (0)