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: added complete closed-loop example for psychophysics study #668

Merged
merged 32 commits into from
Oct 20, 2024

Conversation

musslick
Copy link
Collaborator

@musslick musslick commented Oct 18, 2024

Description

Includes two complete examples for

  • a closed-loop psychophysics study,
  • a closed-loop reinforcement learning study.

Also restructures tutorial section, now including two subtutorials for the components:

  • Theorist Tutorial
  • Experimentalist Tutorial

The documentation titles for "Tutorials" and "Examples" have been replaced with "Basic Tutorials" and "Use Case Tutorials", respectively.

The "Use Case Tutorials" now only include the examples listed above.

The enumeration has changed, from roman enumeration to alphanumerical.

Updated the some index pages to reflect the new tutorial structure.

Type of change

Delete as appropriate:

  • docs: Documentation only changes.

Features

The example addresses the following learning goals:

  • Set up a closed-loop AutoRA workflow: Learn how to create an automated discovery process, iterating between hypothesis generation and data collection.
  • Automate experimental design with SweetPea: Use SweetPea to generate experimental designs that adapt as the study progresses.
  • Generate behavioral experiments with SweetBean: Automate the creation of simple behavioral experiments, minimizing the need for manual coding.
  • Host experiments using Google Firebase: Set up a server for hosting your behavioral experiments, making them accessible to participants.
  • Store experimental data with Google Firestore: Efficiently manage and store participant data collected from your experiment.
  • Collect data from real participants with Prolific: Recruit and manage participants through Prolific, ensuring high-quality behavioral data.

Questions

  • Which configuration is optimal for the firebase_runner to ensure robust performance? Specifically:
experiment_runner = firebase_runner(
    firebase_credentials=firebase_credentials,
    time_out=100,
    sleep_time=5)
  • How is the completion_code in the firebase_prolific_runner determined? Is it arbitrary?

Remarks

  • Still need to validate the RL-closed loop tutorial
  • Images specific to the closed-loop psychophysics study were moved to a sub folder in that example. The "general" images (used across examples) were moved in the example folder above.
  • Before merging, I need to update the corresponding template repository for the pyschophysics example; same goes for the rl-bandit-example

@musslick musslick added the documentation Improvements or additions to documentation. label Oct 18, 2024
@musslick musslick added this to the JOSS Revision milestone Oct 18, 2024
@musslick musslick self-assigned this Oct 18, 2024
Copy link
Collaborator

@younesStrittmatter younesStrittmatter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks super good! This is great!!!

@musslick musslick added this pull request to the merge queue Oct 20, 2024
Merged via the queue into main with commit ea48f30 Oct 20, 2024
16 checks passed
@musslick musslick deleted the doc/closed-loop-example-basic branch October 20, 2024 20:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

closed-loop tutorial for perceptual decision-making task Tutorial for RNN-SINDY-theorist
2 participants