Skip to content

Commit

Permalink
fix(get-exp-result-import): fix the import of get_experiment_result
Browse files Browse the repository at this point in the history
… at the top of the package and change the function name in the doc from `get_experiment_results` to `get_experiment_result`
  • Loading branch information
idocx committed Oct 8, 2024
1 parent 5b6f178 commit f3dfc54
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 5 deletions.
2 changes: 1 addition & 1 deletion alab_management/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
import os

__version__ = "1.0.1"
from .builders import ExperimentBuilder, get_experiment_status
from .builders import ExperimentBuilder, get_experiment_result, get_experiment_status
from .device_view.dbattributes import value_in_database
from .device_view.device import BaseDevice, add_device, mock
from .sample_view import Sample, SamplePosition, add_standalone_sample_position
Expand Down
6 changes: 5 additions & 1 deletion alab_management/builders/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
used to create the input file for the `experiment` command.
"""

from .experimentbuilder import ExperimentBuilder, get_experiment_status
from .experimentbuilder import (
ExperimentBuilder,
get_experiment_result,
get_experiment_status,
)
from .samplebuilder import SampleBuilder
from .utils import append_task
6 changes: 3 additions & 3 deletions docs/source/submit_experiments.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,12 +214,12 @@ The format of the status is as follows:
```

### Get the results
Once the experiment is completed, you can get the results of the experiment using the `get_experiment_results` method.
Once the experiment is completed, you can get the results of the experiment using the `get_experiment_result` method.

```python
from alab_management import get_experiment_results
from alab_management import get_experiment_result

results = get_experiment_results(exp_id)
results = get_experiment_result(exp_id)
```

The format of the results is as follows. If the experiment has not been completed, it
Expand Down

0 comments on commit f3dfc54

Please sign in to comment.