From 56a238e7b3d6556436520ca978e7c4e803253bde Mon Sep 17 00:00:00 2001 From: John Gerrard Holland Date: Mon, 4 Dec 2023 08:31:17 -0500 Subject: [PATCH] =?UTF-8?q?docs:=20update=20command=20line=20interface=20o?= =?UTF-8?q?verview=20=E2=80=93=20state=20and=20plotting=20text.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/cli/basic-usage/README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/cli/basic-usage/README.md b/docs/cli/basic-usage/README.md index 850ebdd8..812bc651 100644 --- a/docs/cli/basic-usage/README.md +++ b/docs/cli/basic-usage/README.md @@ -45,7 +45,6 @@ python -m autora.workflow example.lib.theorist --in-path experiment_data.pkl --o We can interrogate the results by loading them into the current session. - ```python #!/usr/bin/env python from autora.workflow.__main__ import load_state @@ -110,18 +109,18 @@ print(state) # ) ``` -`state` is the following object which, once loaded, can be treated like any other `State` object. -For instance, we can plot the results: +For instance, we can plot the results. We define another script in the `example` package: ```python title="example/plot.py" --8<-- "https://raw.githubusercontent.com/AutoResearch/autora-core/main/docs/cli/basic-usage/example/plot.py" ``` +... and invoke it on the command line: + ```shell python -m example.plot model.pkl ``` - ![png](img/after-one-cycle.png) If we instead run the experiment for 4 cycles, we can get results closer to the ground truth.