Skip to content

Commit b322f41

Browse files
committed
edit experiment doc
1 parent 73c1093 commit b322f41

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/smexperiments/experiment.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@ class Experiment(_base_types.Record):
2323
New experiments are created by calling :meth:`~smexperiments.experiment.Experiment.create`. Existing
2424
experiments can be reloaded by calling :meth:`~smexperiments.experiment.Experiment.load`. You can
2525
add a new trial to an Experiment by calling :meth:`~smexperiments.experiment.Experiment.create_trial`.
26-
To remove a Trial from an experiment, delete the trial.
26+
To remove an experiment and associated trials, trial components by calling :meth:`~smexperiments.experiment
27+
.Experiment.delete_all`.
2728
2829
Examples:
2930
.. code-block:: python
@@ -38,8 +39,7 @@ class Experiment(_base_types.Record):
3839
for trial in my_experiment.list_trials():
3940
print(trial)
4041
41-
my_trial.delete()
42-
my_experiment.delete()
42+
my_experiment.delete_all(action="--force")
4343
4444
Attributes:
4545
experiment_name (str): The name of the experiment. The name must be unique within an account.

0 commit comments

Comments
 (0)