Skip to content

Commit 3de3ce8

Browse files
committed
update pages
1 parent ac94015 commit 3de3ce8

21 files changed

+27
-21
lines changed
-236 Bytes
Binary file not shown.
-297 Bytes
Binary file not shown.
44.3 KB
Loading
30.5 KB
Loading
6.82 KB
Loading
45.8 KB
Loading
47.5 KB
Loading

docs/_build/html/_sources/tutorials/get_subinfo.md.txt

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -153,12 +153,12 @@ subinfo = SubInfo(config)
153153
# Show dialog and collect information
154154
subject_data = subinfo.collect()
155155
```
156-
![Collecting subinfo using python dict](/figures/subinfo_dict.png)
156+
![Collecting subinfo using python dict](figures/subinfo_dict.png)
157157

158158

159159
If registration (collection) is failed, the experiment will exit and python enviroment will be closed.
160160

161-
![registration_failed](/subinfo_failed.png)
161+
![registration_failed](figures/subinfo_failed.png)
162162

163163

164164
### 2. Field Types and Constraints
@@ -240,15 +240,17 @@ subinfo = SubInfo(config)
240240
# Show dialog and collect information
241241
subject_data = subinfo.collect()
242242
```
243-
![Collecting subinfo using yaml config](/figures/subinfo_yaml_kr.png)
243+
![Collecting subinfo using yaml config](figures/subinfo_yaml_kr.png)
244244

245245
Following same approach, you can do localization for any language by providing the appropriate translations in the `subinfo_mapping` section.
246246

247-
![Collecting subinfo using yaml config](/figures/subinfo_yaml_cn.png)
247+
![Collecting subinfo using yaml config](figures/subinfo_yaml_cn.png)
248248

249249

250-
```{note}
251-
Make sure the translations are accurate for your target users.
250+
```{Tips}
251+
In addition to using the chatbox from LLM models for translation,
252+
psyflow has a built-in function (`translate_config()`) using LLM APIs for translating the subinfo mapping.
253+
Make sure the translations are accurate if you use an LLM to generate them. Consult a native speaker if possible.
252254
```
253255

254256

@@ -271,6 +273,9 @@ subject_data = subform.collect()
271273
settings = TaskSettings.from_dict(cfg['task_config'])
272274
settings.add_subinfo(subject_data)
273275
```
276+
```{Tips}
277+
`load_config()` is a handy function for loading the configuration stored in `config/config.yaml`in the default TAPS format.
278+
```
274279

275280
## Next Steps
276281

docs/_build/html/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/_build/html/tutorials/get_subinfo.html

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -448,9 +448,9 @@ <h4>Option B: Using a Python Dictionary<a class="headerlink" href="#option-b-usi
448448
<span class="n">subject_data</span> <span class="o">=</span> <span class="n">subinfo</span><span class="o">.</span><span class="n">collect</span><span class="p">()</span>
449449
</pre></div>
450450
</div>
451-
<p><img alt="Collecting subinfo using python dict" src="figures/subinfo_dict.png" /></p>
451+
<p><img alt="Collecting subinfo using python dict" src="../_images/subinfo_dict.png" /></p>
452452
<p>If registration (collection) is failed, the experiment will exit and python enviroment will be closed.</p>
453-
<p><img alt="registration_failed" src="subinfo_failed.png" /></p>
453+
<p><img alt="registration_failed" src="../_images/subinfo_failed.png" /></p>
454454
</section>
455455
</section>
456456
<section id="field-types-and-constraints">
@@ -527,13 +527,9 @@ <h3>3. Localization<a class="headerlink" href="#localization" title="Link to thi
527527
<span class="n">subject_data</span> <span class="o">=</span> <span class="n">subinfo</span><span class="o">.</span><span class="n">collect</span><span class="p">()</span>
528528
</pre></div>
529529
</div>
530-
<p><img alt="Collecting subinfo using yaml config" src="figures/subinfo_yaml_kr.png" /></p>
530+
<p><img alt="Collecting subinfo using yaml config" src="../_images/subinfo_yaml_kr.png" /></p>
531531
<p>Following same approach, you can do localization for any language by providing the appropriate translations in the <code class="docutils literal notranslate"><span class="pre">subinfo_mapping</span></code> section.</p>
532-
<p><img alt="Collecting subinfo using yaml config" src="figures/subinfo_yaml_cn.png" /></p>
533-
<div class="admonition note">
534-
<p class="admonition-title">Note</p>
535-
<p>Make sure the translations are accurate for your target users.</p>
536-
</div>
532+
<p><img alt="Collecting subinfo using yaml config" src="../_images/subinfo_yaml_cn.png" /></p>
537533
</section>
538534
<section id="add-subject-information-to-tasksettings">
539535
<h3>4. Add subject information to TaskSettings<a class="headerlink" href="#add-subject-information-to-tasksettings" title="Link to this heading"></a></h3>

0 commit comments

Comments
 (0)