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

docs: make a documentation page outlining the terminology based on the spreadsheet #572

Merged
Changes from 16 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
22 changes: 22 additions & 0 deletions docs/terminology.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# AutoRA Terminology

The following table includes naming conventions used throughout AutoRA.

| Term | Description | Relevant Modules |
|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------|
| State | Base object that has all relevant fields and which uses the Delta mechanism to modify those fields. | Core |
benwandrew marked this conversation as resolved.
Show resolved Hide resolved
benwandrew marked this conversation as resolved.
Show resolved Hide resolved
| Delta | An object that determines the extension behavior of State objects. | Core |
benwandrew marked this conversation as resolved.
Show resolved Hide resolved
| StandardState | An optional default State that has the following fields: variables, conditions, experiment_data, models. | Core |
| Variables | A State field that holds experimental variables, which are defined according to name, type, units, allowed values, and range. | Experimentalists, Experiment Runners, Theorists |
| VariableCollection | Immutable metadata about dependent variables, independent variables, and covariates. | Experimentalists, Experiment Runners, Theorists |
| Conditions | A State field that defines what observations should be collected according to a specific combination of values of the independent variables | Experimentalists, Experiment Runners, Theorists |
| Experiment Data | A State field that holds specified conditions as well as the corresponding observations. | Experiment Runners, Theorists |
| Model | A State field that holds the the collection of best fit equations produced by theorists. | Theorists, Experimentalists |
| Components | The objects that can act on the State (e.g., experimentalists, experiment runners, theorists). | Experimentalists, Experiment Runners, Theorists |
benwandrew marked this conversation as resolved.
Show resolved Hide resolved
benwandrew marked this conversation as resolved.
Show resolved Hide resolved
| Experimentalist | A component that outputs new conditions, which are intended to yield novel observations. | Experimentalists |
| Theorist | A component that takes in the full collection of conditions and observations and outputs models that link the two. | Theorists |
| Experiment Runner | A component that takes in conditions and collects corresponding observations. | Experiment Runners |
| Wrapper | Special functions that make the components of AutoRA able to operate on State objects. | Experimentalists, Experiment Runners, Theorists |
| Workflow | A collection of tools that enable closed-loop empirical research with the AutoRA framework. | Experimentalists, Experiment Runners, Theorists |
| Cycle | A workflow tool that allows AutoRA components to be chained together in serial loops. | Experimentalists, Experiment Runners, Theorists |
benwandrew marked this conversation as resolved.
Show resolved Hide resolved
| Cylc | A workflow engine for cycling systems that orchestrates distributed workflows of interdependent cycling tasks. | Experimentalists, Experiment Runners, Theorists |
benwandrew marked this conversation as resolved.
Show resolved Hide resolved