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: sampler to experimentalist at the appropriate places #13

Merged
merged 1 commit into from
Sep 2, 2023
Merged
Show file tree
Hide file tree
Changes from all 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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ You will need:
- `graphviz` (optional, required for computation graph visualizations):
[https://graphviz.org/download/](https://graphviz.org/download/)

Install the inequality sampler as part of the `autora` package:
Install the inequality experimentalist as part of the `autora` package:

```shell
pip install -U "autora[experimentalist-inequality]"
Expand Down
6 changes: 3 additions & 3 deletions docs/Basic Usage.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
},
"source": [
"# Basic Usage\n",
"The inequality sampler selects $n$ experimental conditions from a pool of candidate experimental conditions $X'$. The choice is informed based on the similarity of the candidate conditions $X'$ with respect to previously examined experiment conditions $X$.\n",
"The inequality experimentalist selects $n$ experimental conditions from a pool of candidate experimental conditions $X'$. The choice is informed based on the similarity of the candidate conditions $X'$ with respect to previously examined experiment conditions $X$.\n",
"We begin with importing the relevant packages."
]
},
Expand Down Expand Up @@ -100,7 +100,7 @@
"collapsed": false
},
"source": [
"Finally, we can call the inequality sampler. Note that $X'$ is the first argument to the sampler, followed by the \"reference\" conditions $X$, and the number of samples."
"Finally, we can call the inequality experimentalist. Note that $X'$ is the first argument to the experimentalist, followed by the \"reference\" conditions $X$, and the number of samples."
]
},
{
Expand Down Expand Up @@ -128,7 +128,7 @@
"collapsed": false
},
"source": [
"The novelty sampler also works for experiments with multiple indendent variables. In the following example, we define $X$ as a single experimental condition composed of three independent factors. We choose from a pool $X'$ composed of four experimental conditons."
"The inequality experimentalist also works for experiments with multiple independent variables. In the following example, we define $X$ as a single experimental condition composed of three independent factors. We choose from a pool $X'$ composed of four experimental conditions."
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Given:
- A threshold value (default = 0) that determines the maximum allowable distance for two conditions to be considered equal.
- A number $n$ of conditions to sample.

The inequality sampler operates as follows:
The inequality experimentalist operates as follows:

1. For each candidate condition $\vec{x}'$ in $X'$ calculate an $inequality$ $score$:
2. Calculate the distances $d(\vec{x}, \vec{x}')$ between $\vec{x}$ and $\vec{x}'$ using the pairwise distance metric for all $\vec{x}$ in $X$.
Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ You will need:

- `python` 3.8 or greater: [https://www.python.org/downloads/](https://www.python.org/downloads/)

*Inequality sampler* is a part of the `autora` package:
*Inequality experimentalist* is a part of the `autora` package:

```shell
pip install -U autora[experimentalist-inequality]
Expand Down
6 changes: 3 additions & 3 deletions src/autora/experimentalist/inequality/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ def sample(
metric: str = "euclidean",
) -> np.ndarray:
"""
This inequality sampler chooses from the pool of IV conditions according to their
This inequality experimentalist chooses from the pool of IV conditions according to their
inequality with respect to a reference pool reference_conditions. Two IVs are considered
equal if their distance is less than the equality_distance. The IVs chosen first are feed back
into reference_conditions and are included in the summed equality calculation.
Expand Down Expand Up @@ -70,13 +70,13 @@ def sample(
>>> summed_inequality_sampler([1, 2, 3], [1, 1, 1, 2, 2, 2, 3, 3])
array([[3]])

The samplers "fills up" the reference array so the values are contributed evenly
The experimentalist "fills up" the reference array so the values are contributed evenly
>>> summed_inequality_sampler([1, 1, 1, 2, 2, 2, 3, 3, 3], [1, 1, 2, 2, 2, 2, 3, 3, 3], 3)
array([[1],
[3],
[1]])

The sampler samples without replacemnt!
The experimentalist samples without replacemnt!
>>> summed_inequality_sampler([1, 2, 3], [1, 1, 1], 3)
array([[3],
[2],
Expand Down