Skip to content

Commit

Permalink
Merge pull request #494 from AutoResearch/fix/minor-typos-doc
Browse files Browse the repository at this point in the history
doc: fixed minor typos
  • Loading branch information
benwandrew authored Jun 24, 2023
2 parents 23d02eb + 5bc640e commit eb85d5c
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
9 changes: 6 additions & 3 deletions docs/contribute/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ You may contribute to any of the core packages or develop your own module as a s
### Code Style

In general, AutoRA follows the [PEP 8 – Style Guide for Python Code](https://peps.python.org/pep-0008/). We particularly encourage the following conventions:

- Snake case for variables and modules: `example_name`, `example_module.py`
- Camel case for class names: `ExampleClass`
- Camel case with spaces for Jupyter notebooks: `Example Notebook.ipynb`
Expand All @@ -45,9 +46,11 @@ For documenation, AutoRA adheres to the maxim, "Everything should be made as sim
Modules include theorists, experimentalists, experiment runners, or other functionalities not covered by the core packages.
All modules are child packages and can become optional dependencies of the `autora` parent package. Modules packages are
owned and maintained by you, the contributor, which provides several advantages:
- *Easy setup*: We provide simple [templates](modules/index.md) for modules, which you can use to get started quickly
- *Independence*: You can develop and maintain your package independently of other child packages (and thereby avoid dependency conflicts)
- *Ownership*: You can publish your package on PyPI or Conda, use it in other projects, and get credit for its use.

- **Easy setup**: We provide simple [templates](modules/index.md) for modules, which you can use to get started quickly
- **Independence**: You can develop and maintain your package independently of other child packages (and thereby avoid dependency conflicts)
- **Ownership**: You can publish your package on PyPI or Conda, use it in other projects, and get credit for its use.


For details on how to submit child packages
for inclusion in `autora`, see
Expand Down
10 changes: 5 additions & 5 deletions docs/experimentalist/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,27 @@ The primary goal of an experimentalist is to identify experiments that yield
scientific merit. AutoRA implements techniques for automating the identification
of novel experiments.

An experiment consists of a series of **experiment conditions** $\vec{x} \in X$.
The experimental variables manipulated in each experiment condition
An experiment consists of a series of **experimental conditions** $\vec{x} \in X$.
The experimental variables manipulated in each experimental condition
are defined as **factors**, and the values of each variable to be sampled
in the experiment are defined as **levels** of the corresponding **factors**.
As an example, consider a visual discrimination tasks in which participants are presented
with two lines of different lengths, and are asked to indicate which line is longer.
There are two factors in this experiment: the length of the first line and
the length of the second line. Instances of the two line lengths
(e.g., 2.0 cm for the first line and 2.1 cm for the sceond line)
can be considered levels of the two factors, respectively. Thus, *an experiment condition is a vector of values that
can be considered levels of the two factors, respectively. Thus, *an experimental condition is a vector of values that
corresponds to a specific combination of experiment levels $x_i$,
each of which is an instance of an experiment factor.*

Experimentalists in AutoRA serve to identify novel
experiment conditions $\vec{x} \in X$, where $x_i$ corresponds
experimental conditions $\vec{x} \in X$, where $x_i$ corresponds
to the level of an experimental factor $i$.

![Overview](../img/experimentalist.png)

Experimentalists may use information about candidate models $M$ obtained from a theorist,
experiment conditions that have already been probed $\vec{x}' \in X'$, or
experimental conditions that have already been probed $\vec{x}' \in X'$, or
respective dependent measures $\vec{y}' \in Y'$. The following table includes the experimentalists currently implemented
in AutoRA.

Expand Down

0 comments on commit eb85d5c

Please sign in to comment.