From 5c46b0c2b4e1532007ba10655ae6d8168992416d Mon Sep 17 00:00:00 2001 From: Sebastian Musslick Date: Mon, 21 Oct 2024 17:00:08 +0200 Subject: [PATCH 1/4] updated order of terms introduced --- docs/index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/index.md b/docs/index.md index 3602a90e..1cbb600f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,12 +1,12 @@ -# Core Functionality +# Workflow & State 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 From df9255a82a326b1f8bcde042031e0c3a6909b33b Mon Sep 17 00:00:00 2001 From: Sebastian Musslick Date: Mon, 21 Oct 2024 17:01:08 +0200 Subject: [PATCH 2/4] added state and wrapper illustrations --- docs/The State Mechanism.ipynb | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/The State Mechanism.ipynb b/docs/The State Mechanism.ipynb index d3393cc6..21aa841b 100644 --- a/docs/The State Mechanism.ipynb +++ b/docs/The State Mechanism.ipynb @@ -16,6 +16,8 @@ "- operate on `States` and \n", "- return `States`.\n", "\n", + "\"State\n", + "\n", "The `autora.state` submodule provides classes and functions to help build these functions. " ] }, @@ -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", + "\"State\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." From 2c23a1a31e765d0571e49fa84c4cc31a8f3432d9 Mon Sep 17 00:00:00 2001 From: Sebastian Musslick Date: Mon, 21 Oct 2024 20:46:35 +0200 Subject: [PATCH 3/4] reversed title order --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 1cbb600f..5426cb14 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,4 @@ -# Workflow & State Mechanics +# States & Workflow Mechanics AutoRA includes core functionality for defining empirical research workflows. This core functionality is organized into these submodules: From 6b180c259cf88b04b636b20e77d80fde34b7d72a Mon Sep 17 00:00:00 2001 From: Sebastian Musslick Date: Mon, 21 Oct 2024 21:26:58 +0200 Subject: [PATCH 4/4] adjusted title --- docs/cli/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cli/index.md b/docs/cli/index.md index 6404655d..134acd0e 100644 --- a/docs/cli/index.md +++ b/docs/cli/index.md @@ -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: