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: reorganized behavioral experiment runner doc #675

Merged
merged 1 commit into from
Nov 10, 2024
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
3 changes: 3 additions & 0 deletions docs/experiment-runner/behavioral/example.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Example: Closed-Loop Behavioral Study

For a detailed example of setting up a closed-loop behavioral study with an online experiment, see the [Basic Closed-Loop Psychophysics Study](../../examples/closed-loop-basic/index.md).
8 changes: 8 additions & 0 deletions docs/experiment-runner/behavioral/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Online Experiments To Collect AutoRA Observations

AutoRA provides functionality for running closed-loop behavioral studies with online experiments. This functionality allows researchers to set up websites that integrate with AutoRA workflows. These websites allow observations gathered from participants online.

![System Overview](../../examples//img/system_overview.png)

To enable this functionality, AutoRA can interface with databases, such as Firebase for hosting the website and storing data. In addition, AutoRA can recruit participants through platforms like Prolific.

4 changes: 0 additions & 4 deletions docs/online-experiments/index.md

This file was deleted.

14 changes: 7 additions & 7 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -257,18 +257,18 @@ nav:
- 'synthetic/docs/Examples/Psychology/Q-Learning.ipynb'
- Psychophysics:
- 'synthetic/docs/Examples/Psychophysics/Weber-Fechner-Law.ipynb'
- Firebase-Prolific: '!import https://github.com/autoresearch/autora-experiment-runner-firebase-prolific/?branch=main&extra_imports=["mkdocs/base.yml"]'
- Firebase: '!import https://github.com/autoresearch/autora-experiment-runner-experimentation-manager-firebase/?branch=main&extra_imports=["mkdocs/base.yml"]'
- Prolific: '!import https://github.com/autoresearch/autora-experiment-runner-recruitment-manager-prolific/?branch=main&extra_imports=["mkdocs/base.yml"]'
- Behavioral Web Experiments:
- Home: 'experiment-runner/behavioral/index.md'
- Example: 'experiment-runner/behavioral/example.md'
- Using Firebase: 'experiment-runner/behavioral/firebase.md'
- Firebase-Prolific Runner: '!import https://github.com/autoresearch/autora-experiment-runner-firebase-prolific/?branch=main&extra_imports=["mkdocs/base.yml"]'
- Firebase Experimentation Manager: '!import https://github.com/autoresearch/autora-experiment-runner-experimentation-manager-firebase/?branch=main&extra_imports=["mkdocs/base.yml"]'
- Prolific Recruitment Manager: '!import https://github.com/autoresearch/autora-experiment-runner-recruitment-manager-prolific/?branch=main&extra_imports=["mkdocs/base.yml"]'
- "Command Line Interface":
- "Home": "core/docs/cli/index.md"
- "Basic Usage": "core/docs/cli/basic-usage/README.md"
- "Using Cylc": "core/docs/cli/cylc-pip/README.md"
- "Using Cylc and Slurm": "core/docs/cli/cylc-slurm-pip/README.md"
- Online Experiments:
- Home: 'online-experiments/index.md'
- Firebase: 'online-experiments/firebase.md'
- Example: 'user-cookiecutter/docs/index.md'
- Contributor Guide:
- Home: 'contribute/index.md'
- Modules:
Expand Down
Loading