From 4f4c01b102ea514d4240a6b8aaac648f2d15a1c9 Mon Sep 17 00:00:00 2001 From: Sebastian Musslick Date: Tue, 20 Jun 2023 10:26:00 -0400 Subject: [PATCH 1/3] fixed bulleted list which wasn't displayed correctly --- docs/contribute/index.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/contribute/index.md b/docs/contribute/index.md index fc8956ec5..b248710ad 100644 --- a/docs/contribute/index.md +++ b/docs/contribute/index.md @@ -33,9 +33,12 @@ You may contribute to any of the core packages or develop your own module as a s 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](module.md) for modules, which you can use to get started quickly -- *Independence*: You can develop and maintain your package independently of other modules 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 From 74dae184797695e2ac3e49489d3f98f37fefdf3d Mon Sep 17 00:00:00 2001 From: Sebastian Musslick Date: Tue, 20 Jun 2023 10:26:57 -0400 Subject: [PATCH 2/3] switched from experiment condition to experimental condition --- docs/experimentalist/index.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/experimentalist/index.md b/docs/experimentalist/index.md index c80896679..6382c8227 100644 --- a/docs/experimentalist/index.md +++ b/docs/experimentalist/index.md @@ -4,8 +4,8 @@ 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 @@ -13,18 +13,18 @@ with two lines of different lengths, and are asked to indicate which line is lon 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. From 5bc640e7e4473b7af3dde8a0259ade1e749e8901 Mon Sep 17 00:00:00 2001 From: Younes Strittmatter Date: Sat, 24 Jun 2023 17:35:35 -0400 Subject: [PATCH 3/3] Update index.md --- docs/contribute/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/contribute/index.md b/docs/contribute/index.md index 4f23dd257..5e9b3fe03 100644 --- a/docs/contribute/index.md +++ b/docs/contribute/index.md @@ -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`