forked from M-Labs/artiq
update documentation (#1820)
This commit is contained in:
parent
f42bea06a8
commit
eaa1505c94
|
@ -392,11 +392,11 @@ class HasEnvironment:
|
||||||
|
|
||||||
By default, datasets obtained by this method are archived into the output
|
By default, datasets obtained by this method are archived into the output
|
||||||
HDF5 file of the experiment. If an archived dataset is requested more
|
HDF5 file of the experiment. If an archived dataset is requested more
|
||||||
than one time (and therefore its value has potentially changed) or is
|
than one time or is modified, only the value at the time of the first call
|
||||||
modified, a warning is emitted.
|
is archived. This may impact reproducibility of experiments.
|
||||||
|
|
||||||
:param archive: Set to ``False`` to prevent archival together with the run's results.
|
:param archive: Set to ``False`` to prevent archival together with the run's results.
|
||||||
Default is ``True``
|
Default is ``True``.
|
||||||
"""
|
"""
|
||||||
try:
|
try:
|
||||||
return self.__dataset_mgr.get(key, archive)
|
return self.__dataset_mgr.get(key, archive)
|
||||||
|
|
Loading…
Reference in New Issue