You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/tutorials/task_settings.md
+18-17Lines changed: 18 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,26 +2,27 @@
2
2
3
3
## Overview
4
4
5
-
The `TaskSettings` class provides a centralized way to manage experiment configuration, including paths, timing parameters, window settings, and more. It helps standardize experiment setup and ensures consistent configuration across different parts of your experiment.
5
+
The `TaskSettings` class provides a centralized way to manage experiment configuration, including collected subject information, data paths, timing parameters, window settings, and more. It helps standardize experiment setup and ensures consistent configuration across different parts of the experiment.
6
+
7
+
Under the hood, `TaskSettings` is used throughout your code wherever you need to read or write experiment parameters. For example:
8
+
- In `run_trial.py`, to retrieve the duration of a specific stimulus
9
+
- During block creation in `main.py`, to determine the number of blocks and trials and to seed the randomization of conditions
6
10
7
-
`TaskSettings` solves several common challenges in experiment configuration:
8
11
9
-
-**Centralization**: Maintain all experiment parameters in one place
10
-
-**Standardization**: Create consistent configuration across experiments
11
-
-**Path management**: Automatically generate file paths based on subject information
12
-
-**Seed control**: Manage random seeds for reproducible experiments
13
-
-**Integration**: Connect with other psyflow components seamlessly
14
12
15
13
## Key Features
16
14
17
-
| Feature | Description |
18
-
|---------|-------------|
19
-
| Dictionary initialization | Create settings from Python dictionaries or YAML files |
20
-
| Subject integration | Incorporate subject information for personalized paths |
21
-
| Path generation | Automatically create data and resource paths |
22
-
| Seed management | Control random seeds for reproducible experiments |
23
-
| Attribute access | Access settings using dot notation for cleaner code |
24
-
| Default values | Provide sensible defaults for common parameters |
0 commit comments