Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: added state illustration #96

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/The State Mechanism.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
"- operate on `States` and \n",
"- return `States`.\n",
"\n",
"<img src=\"https://autoresearch.github.io/autora/img/state_logic.png\" width=\"75%\" alt=\"State Logic\">\n",
"\n",
"The `autora.state` submodule provides classes and functions to help build these functions. "
]
},
Expand Down Expand Up @@ -327,7 +329,9 @@
"source": [
"### Use the `autora.state.on_state` decorator\n",
"\n",
"`autora.state.on_state` is a wrapper for functions which allows them to accept `State` objects as the first argument.\n",
"`autora.state.on_state` is a wrapper for functions which allows them to accept `State` objects as the first argument. This decorator enables AutoRA components to retrieve relevant data from the state and add new data to it. \n",
"\n",
"<img src=\"https://autoresearch.github.io/autora/img/state_wrapper.png\" width=\"75%\" alt=\"State Wrapper Overview\">\n",
"\n",
"The most concise way to use it is as a decorator on the function where it is defined. You can specify how the \n",
"returned values should be mapped to fields on the `State` using the `@autora.state.on_state(output=...)` argument."
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Command Line Interface
# Workflows for HPCs via the Command Line Interface

Different parts of AutoRA experiments can require very different computational resources. For instance:

Expand Down
8 changes: 4 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Core Functionality
# States & Workflow Mechanics

AutoRA includes core functionality for running AutoRA experiments organized into these submodules:
AutoRA includes core functionality for defining empirical research workflows. This core functionality is organized into these submodules:

- `autora.state`, which underpins the unified `State` interface for writing experimentalists, experiment runners and
- `autora.variable`, for representing experimental metadata describing the type and domain of variables
- `autora.state`, which underpins the unified `State` interface for interacting with experimentalists, experiment runners and
theorists
- `autora.serializer`, utilities for saving and loading `States`
- `autora.workflow`, command line tools for running experimentalists, experiment runners and theorists
- `autora.variable`, for representing experimental metadata describing the type and domain of variables
- `autora.utils`, utilities and helper functions not linked to any specific core functionality

It also provides some basic experimentalists in the `autora.experimentalist` submodule. However, most
Expand Down
Loading