Skip to content

Commit

Permalink
docs: update command line interface overview – state and plotting text.
Browse files Browse the repository at this point in the history
  • Loading branch information
hollandjg committed Dec 4, 2023
1 parent f029e0a commit 56a238e
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions docs/cli/basic-usage/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 56a238e

Please sign in to comment.