From b5618d25c8fa176d4f5716668be2fadf33fe8c31 Mon Sep 17 00:00:00 2001 From: Yuxing Fei Date: Tue, 8 Oct 2024 10:12:55 -0700 Subject: [PATCH] fix(get-exp-result-import): fix the import of `get_experiment_result` at the top of the package and change the function name in the doc from `get_experiment_results` to `get_experiment_result` (#85) --- alab_management/__init__.py | 2 +- alab_management/builders/__init__.py | 6 +++++- docs/source/submit_experiments.md | 6 +++--- 3 files changed, 9 insertions(+), 5 deletions(-) diff --git a/alab_management/__init__.py b/alab_management/__init__.py index a712dc43..21548274 100644 --- a/alab_management/__init__.py +++ b/alab_management/__init__.py @@ -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 diff --git a/alab_management/builders/__init__.py b/alab_management/builders/__init__.py index ef0541a3..54213192 100644 --- a/alab_management/builders/__init__.py +++ b/alab_management/builders/__init__.py @@ -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 diff --git a/docs/source/submit_experiments.md b/docs/source/submit_experiments.md index f64c2129..dccd1d93 100644 --- a/docs/source/submit_experiments.md +++ b/docs/source/submit_experiments.md @@ -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