Skip to content
Snippets Groups Projects
Verified Commit 925bce66 authored by Björn Ludwig's avatar Björn Ludwig
Browse files

docs(dataset): improve description of allowed inputs

parent 9d091873
No related branches found
No related tags found
No related merge requests found
...@@ -67,14 +67,16 @@ class ZeMASamples: ...@@ -67,14 +67,16 @@ class ZeMASamples:
Parameters Parameters
---------- ----------
n_samples : int, optional n_samples : int, optional
number of samples each containing size_scaler readings from each of the number of samples each containing the first ``size_scaler`` readings from each
eleven sensors with associated uncertainties, defaults to 1 of the eleven sensors for one of the cycles with associated uncertainties,
defaults to 1 and must be between 1 and 476
size_scaler : int, optional size_scaler : int, optional
number of sensor readings from each of the individual sensors per sample, number of sensor readings from each of the individual sensors per sample/cycle,
defaults to 1 defaults to 1 and should be between 1 and 2000, as there are only 2000
readings per cycle, higher values will be clipped to 2000
normalize : bool, optional normalize : bool, optional
if ``True``, then data is centered around zero and scaled to unit std, if ``True``, then values are centered around zero and values and
defaults to False uncertainties are scaled to values' unit std, defaults to ``False``
Attributes Attributes
---------- ----------
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment