docs: make a documentation page outlining the terminology based on the spreadsheet #572
Conversation
benwandrew
requested review from
hollandjg,
musslick,
chadcwilliams and
younesStrittmatter
docs/terminology.md
Outdated
| | 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 observations which correspond to the specified conditions. | Experiment Runners, Theorists | |
There was a problem hiding this comment.
The Experiment Data field also holds the conditions.
docs/terminology.md
Outdated
| | 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 observations which correspond to the specified conditions. | Experiment Runners, Theorists | | ||
| | Model | A State field that holds the the collection of best fit equations produced by theorists. | Theorists, Experimentalists | | ||
| | Components | The distinct yet flexible capabilities of the AutoRA framework. | Experimentalists, Experiment Runners, Theorists | |
There was a problem hiding this comment.
This isn't very descriptive. Might want to change to something like "the objects that can act on the state - e.g., experimentalists, experiment runners, theorists."?
docs/terminology.md
Outdated
| | Experiment Data | A State field that holds observations which correspond to the specified conditions. | Experiment Runners, Theorists | | ||
| | Model | A State field that holds the the collection of best fit equations produced by theorists. | Theorists, Experimentalists | | ||
| | Components | The distinct yet flexible capabilities of the AutoRA framework. | Experimentalists, Experiment Runners, Theorists | | ||
| | Experimentalist | A module that takes in models and outputs new conditions, which are intended to yield novel observations. | Experimentalists | |
There was a problem hiding this comment.
I like the word module here and in the next two, but with Components explicitly defined, should we use that terminology instead?
There was a problem hiding this comment.
Also, not all experimentalists take in models.
There was a problem hiding this comment.
we should maybe update the core diagram that we use throughout the user guide then: https://autoresearch.github.io/autora/img/experimentalist.png
docs/terminology.md
Outdated
| | Model | A State field that holds the the collection of best fit equations produced by theorists. | Theorists, Experimentalists | | ||
| | Components | The distinct yet flexible capabilities of the AutoRA framework. | Experimentalists, Experiment Runners, Theorists | | ||
| | Experimentalist | A module that takes in models and outputs new conditions, which are intended to yield novel observations. | Experimentalists | | ||
| | Theorist | A module that takes in the full collection of conditions and observations and outputs equations that link the two (i.e., models) | Theorists | |
There was a problem hiding this comment.
I would say outputs models instead of equations because they don't always have to output an equation (although all of ours currently do).
…-terminology-based-on-the-spreadsheet
|
Hi @benwandrew, thanks for this! I'd love to look at this PR, but I won't get to it until next week. Can you keep it open until then? Thanks! |
There was a problem hiding this comment.
Hey @benwandrew , thanks for hanging fire on this one. This is extremely valuable!
I've got a couple of questions and suggestions.
Co-authored-by: John Gerrard Holland <[email protected]>
Co-authored-by: John Gerrard Holland <[email protected]>
Co-authored-by: John Gerrard Holland <[email protected]>
benwandrew
deleted the
docs/make-a-documentation-page-outlining-the-terminology-based-on-the-spreadsheet
branch
Description
Adds a page for essential terminology in AutoRA.
resolves #516
Type of change
Remarks (Optional)