docs: restructure basic-usage directory

AutoResearch · Dec 1, 2023 · 68f7bac · 68f7bac
1 parent 6aa50e0
commit 68f7bac
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 5 deletions.
diff --git a/docs/cli/basic-usage/example/__init__.py b/docs/cli/basic-usage/example/__init__.py
diff --git a/docs/cli/basic-usage/lib.py → docs/cli/basic-usage/example/lib.py b/docs/cli/basic-usage/lib.py → docs/cli/basic-usage/example/lib.py
diff --git a/docs/cli/basic-usage/plot.py → docs/cli/basic-usage/example/plot.py b/docs/cli/basic-usage/plot.py → docs/cli/basic-usage/example/plot.py
@@ -4,13 +4,14 @@
 import numpy as np
 import pandas as pd
 import typer
-from lib import ground_truth, noise_std
 from matplotlib import pyplot as plt
 from sklearn.model_selection import GridSearchCV
 
 from autora.state import StandardState
 from autora.workflow.__main__ import load_state
 
+from .lib import ground_truth, noise_std
+
 
 def plot_results(state: StandardState):
     x = np.linspace(-10, 10, 100).reshape((-1, 1))

diff --git a/docs/cli/basic-usage/index.md b/docs/cli/basic-usage/index.md
@@ -6,8 +6,8 @@ The command line interface allows us to load and save `States` and run arbitrary
 
 To use the command line, we first define a file containing the functions we want to run on the State.
 
-```python title="lib.py"
---8<-- "https://raw.githubusercontent.com/AutoResearch/autora-core/docs/update-workflow-docs/docs/cli/basic-usage/lib.py"
+```python title="example/lib.py"
+--8<-- "https://raw.githubusercontent.com/AutoResearch/autora-core/docs/update-workflow-docs/docs/cli/basic-usage/example/lib.py"
 ```
 
 We can run the pipeline of initialization, condition generation, experiment and theory building as follows.
@@ -109,8 +109,8 @@ 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:
 
-```python title="plot.py"
---8<-- "https://raw.githubusercontent.com/AutoResearch/autora-core/docs/update-workflow-docs/docs/cli/basic-usage/plot.py"
+```python title="example/plot.py"
+--8<-- "https://raw.githubusercontent.com/AutoResearch/autora-core/docs/update-workflow-docs/docs/cli/basic-usage/example/plot.py"
 ```
 
 ```shell