Skip to content

Commit 6726afc

Browse files
committed
Update documentation
1 parent 80b2fed commit 6726afc

21 files changed

+423
-586
lines changed

_modules/index.html

Lines changed: 6 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -210,25 +210,10 @@
210210
<li class="toctree-l1"><a class="reference internal" href="../tutorials/build_blocks.html">BlockUnit: Managing Trials</a></li>
211211
<li class="toctree-l1"><a class="reference internal" href="../tutorials/build_stimulus.html">StimBank: Flexible Stimulus Management</a></li>
212212
<li class="toctree-l1"><a class="reference internal" href="../tutorials/build_stimunit.html">StimUnit: Modular Stimulus &amp; Response Handler</a></li>
213-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/send_trigger.html">Overview</a></li>
214-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/send_trigger.html#key-features">Key Features</a></li>
215-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/send_trigger.html#quick-reference">Quick Reference</a></li>
216-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/send_trigger.html#detailed-usage-guide">Detailed Usage Guide</a></li>
217-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/send_trigger.html#integration-with-stimunit">5. Integration with <code class="docutils literal notranslate"><span class="pre">StimUnit</span></code></a></li>
218-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/send_trigger.html#next-steps">Next Steps</a></li>
219-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/cli_usage.html">Overview</a></li>
220-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/cli_usage.html#quick-reference">Quick Reference</a></li>
221-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/cli_usage.html#creating-a-new-project">1. Creating a New Project</a></li>
222-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/cli_usage.html#inplace-initialization">2. In‑Place Initialization</a></li>
223-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/cli_usage.html#how-it-works-internally">3. How It Works Internally</a></li>
224-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/cli_usage.html#next-steps">Next Steps</a></li>
213+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/send_trigger.html">TriggerSender: Sending Hardware Triggers</a></li>
214+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/cli_usage.html">psyflow-init: Command-Line Interface</a></li>
225215
<li class="toctree-l1"><a class="reference internal" href="../tutorials/utilities.html">Utility Functions</a></li>
226-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/llm_client.html">Overview</a></li>
227-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/llm_client.html#supported-providers">Supported Providers</a></li>
228-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/llm_client.html#key-features">Key Features</a></li>
229-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/llm_client.html#quick-reference">Quick Reference</a></li>
230-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/llm_client.html#detailed-usage-guide">Detailed Usage Guide</a></li>
231-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/llm_client.html#next-steps">Next Steps</a></li>
216+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/llm_client.html">LLMClient: Using Large Language Models</a></li>
232217
</ul>
233218
<p class="caption" role="heading"><span class="caption-text">中文教程(Chinese Tutorials)</span></p>
234219
<ul>
@@ -238,24 +223,9 @@
238223
<li class="toctree-l1"><a class="reference internal" href="../tutorials/build_blocks_cn.html">BlockUnit: 组织和运行试验</a></li>
239224
<li class="toctree-l1"><a class="reference internal" href="../tutorials/build_stimulus_cn.html">StimBank:灵活的刺激管理</a></li>
240225
<li class="toctree-l1"><a class="reference internal" href="../tutorials/build_stimunit_cn.html">StimUnit:模块化的刺激呈现与反应处理单元</a></li>
241-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/send_trigger_cn.html">概述</a></li>
242-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/send_trigger_cn.html#id2">主要功能</a></li>
243-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/send_trigger_cn.html#id3">快速参考</a></li>
244-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/send_trigger_cn.html#id4">详细使用指南</a></li>
245-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/send_trigger_cn.html#stimunit">5. 与 <code class="docutils literal notranslate"><span class="pre">StimUnit</span></code> 集成</a></li>
246-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/send_trigger_cn.html#id8">后续步骤</a></li>
247-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/cli_usage_cn.html">概述</a></li>
248-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/cli_usage_cn.html#id2">快速参考</a></li>
249-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/cli_usage_cn.html#id3">1. 创建一个新项目</a></li>
250-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/cli_usage_cn.html#id4">2. 就地初始化</a></li>
251-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/cli_usage_cn.html#id5">3. 内部工作原理</a></li>
252-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/cli_usage_cn.html#id6">后续步骤</a></li>
253-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/llm_client_cn.html">概述</a></li>
254-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/llm_client_cn.html#id2">支持的提供商</a></li>
255-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/llm_client_cn.html#id3">主要功能</a></li>
256-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/llm_client_cn.html#id4">快速参考</a></li>
257-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/llm_client_cn.html#id5">详细使用指南</a></li>
258-
<li class="toctree-l1"><a class="reference internal" href="../tutorials/llm_client_cn.html#id9">后续步骤</a></li>
226+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/send_trigger_cn.html">TriggerSender: 发送硬件触发器</a></li>
227+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/cli_usage_cn.html">psyflow-init: 命令行界面</a></li>
228+
<li class="toctree-l1"><a class="reference internal" href="../tutorials/llm_client_cn.html">LLMClient: 使用大型语言模型</a></li>
259229
</ul>
260230

261231
</div>

_sources/index.rst.txt

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
1+
Welcome to psyflow
2+
===================================
3+
4+
**psyflow** is a modular framework for building cognitive and behavioral tasks using PsychoPy and Python code.
5+
16
.. image:: _static/flowchart.png
27
:alt: flowchart
38
:height: 300px
49
:align: center
510

6-
Welcome to psyflow
7-
===================================
8-
9-
**psyflow** is a modular framework for building cognitive and behavioral tasks using PsychoPy and Python code.
1011

1112
Features
1213
--------

_sources/tutorials/cli_usage.md.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# psyflow-init: Command-Line Interface
2+
13
## Overview
24

35
`psyflow-init` is the command-line interface (CLI) entrypoint for scaffolding new PsychoPy experiments using the built‑in template. It uses Cookiecutter under the hood to generate a standardized project layout, so you can focus on your task logic rather than boilerplate.

_sources/tutorials/cli_usage_cn.md.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# psyflow-init: 命令行界面
2+
13
## 概述
24

35
`psyflow-init` 是用于使用内置模板搭建新的 PsychoPy 实验的命令行界面 (CLI) 入口点。它在底层使用 Cookiecutter 生成标准化的项目布局,因此您可以专注于任务逻辑而不是样板文件。

_sources/tutorials/llm_client.md.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# LLMClient: Using Large Language Models
2+
13
## Overview
24

35
The `LLMClient` class in `psyflow` offers a lightweight, unified interface for interacting with various Large Language Model (LLM) backends, including Google Gemini, OpenAI, Deepseek, and Moonshot. Instead of relying on heavy frameworks like LangChain, we built a minimal wrapper to keep things simple: no extra dependencies beyond provider SDKs, a clean API (e.g., `generate()`, `translate()`, `count_tokens()`), and fast, low-overhead execution.

_sources/tutorials/llm_client_cn.md.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# LLMClient: 使用大型语言模型
2+
13
## 概述
24

35
`psyflow` 中的 `LLMClient` 类提供了一个轻量级、统一的界面,用于与各种大型语言模型(LLM)后端进行交互,包括 Google Gemini、OpenAI、Deepseek 和 Moonshot。我们没有依赖像 LangChain 这样沉重的框架,而是构建了一个最小化的包装器来保持简单:除了提供商的 SDK 之外,没有额外的依赖项,一个干净的 API(例如 `generate()`、`translate()`、`count_tokens()`),以及快速、低开销的执行。

_sources/tutorials/send_trigger.md.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# TriggerSender: Sending Hardware Triggers
2+
13
## Overview
24

35
The `TriggerSender` class provides a flexible, device-independent way to send event codes (triggers) to external recording equipment (e.g., EEG, MEG, eye‐trackers). By wrapping your device-specific send function, it keeps experiment code clean, adds optional pre- and post-hooks, enforces precise timing delays, and even supports a mock mode for development without hardware.

_sources/tutorials/send_trigger_cn.md.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# TriggerSender: 发送硬件触发器
2+
13
## 概述
24

35
`TriggerSender` 类提供了一种灵活、独立于设备的方式,用于向外部记录设备(例如 EEG、MEG、眼动仪)发送事件代码(触发器)。通过包装特定于设备的发送功能,它可以保持实验代码的整洁,添加可选的前置和后置钩子,强制执行精确的计时延迟,甚至支持在没有硬件的情况下进行开发的模拟模式。

genindex.html

Lines changed: 6 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -209,25 +209,10 @@
209209
<li class="toctree-l1"><a class="reference internal" href="tutorials/build_blocks.html">BlockUnit: Managing Trials</a></li>
210210
<li class="toctree-l1"><a class="reference internal" href="tutorials/build_stimulus.html">StimBank: Flexible Stimulus Management</a></li>
211211
<li class="toctree-l1"><a class="reference internal" href="tutorials/build_stimunit.html">StimUnit: Modular Stimulus &amp; Response Handler</a></li>
212-
<li class="toctree-l1"><a class="reference internal" href="tutorials/send_trigger.html">Overview</a></li>
213-
<li class="toctree-l1"><a class="reference internal" href="tutorials/send_trigger.html#key-features">Key Features</a></li>
214-
<li class="toctree-l1"><a class="reference internal" href="tutorials/send_trigger.html#quick-reference">Quick Reference</a></li>
215-
<li class="toctree-l1"><a class="reference internal" href="tutorials/send_trigger.html#detailed-usage-guide">Detailed Usage Guide</a></li>
216-
<li class="toctree-l1"><a class="reference internal" href="tutorials/send_trigger.html#integration-with-stimunit">5. Integration with <code class="docutils literal notranslate"><span class="pre">StimUnit</span></code></a></li>
217-
<li class="toctree-l1"><a class="reference internal" href="tutorials/send_trigger.html#next-steps">Next Steps</a></li>
218-
<li class="toctree-l1"><a class="reference internal" href="tutorials/cli_usage.html">Overview</a></li>
219-
<li class="toctree-l1"><a class="reference internal" href="tutorials/cli_usage.html#quick-reference">Quick Reference</a></li>
220-
<li class="toctree-l1"><a class="reference internal" href="tutorials/cli_usage.html#creating-a-new-project">1. Creating a New Project</a></li>
221-
<li class="toctree-l1"><a class="reference internal" href="tutorials/cli_usage.html#inplace-initialization">2. In‑Place Initialization</a></li>
222-
<li class="toctree-l1"><a class="reference internal" href="tutorials/cli_usage.html#how-it-works-internally">3. How It Works Internally</a></li>
223-
<li class="toctree-l1"><a class="reference internal" href="tutorials/cli_usage.html#next-steps">Next Steps</a></li>
212+
<li class="toctree-l1"><a class="reference internal" href="tutorials/send_trigger.html">TriggerSender: Sending Hardware Triggers</a></li>
213+
<li class="toctree-l1"><a class="reference internal" href="tutorials/cli_usage.html">psyflow-init: Command-Line Interface</a></li>
224214
<li class="toctree-l1"><a class="reference internal" href="tutorials/utilities.html">Utility Functions</a></li>
225-
<li class="toctree-l1"><a class="reference internal" href="tutorials/llm_client.html">Overview</a></li>
226-
<li class="toctree-l1"><a class="reference internal" href="tutorials/llm_client.html#supported-providers">Supported Providers</a></li>
227-
<li class="toctree-l1"><a class="reference internal" href="tutorials/llm_client.html#key-features">Key Features</a></li>
228-
<li class="toctree-l1"><a class="reference internal" href="tutorials/llm_client.html#quick-reference">Quick Reference</a></li>
229-
<li class="toctree-l1"><a class="reference internal" href="tutorials/llm_client.html#detailed-usage-guide">Detailed Usage Guide</a></li>
230-
<li class="toctree-l1"><a class="reference internal" href="tutorials/llm_client.html#next-steps">Next Steps</a></li>
215+
<li class="toctree-l1"><a class="reference internal" href="tutorials/llm_client.html">LLMClient: Using Large Language Models</a></li>
231216
</ul>
232217
<p class="caption" role="heading"><span class="caption-text">中文教程(Chinese Tutorials)</span></p>
233218
<ul>
@@ -237,24 +222,9 @@
237222
<li class="toctree-l1"><a class="reference internal" href="tutorials/build_blocks_cn.html">BlockUnit: 组织和运行试验</a></li>
238223
<li class="toctree-l1"><a class="reference internal" href="tutorials/build_stimulus_cn.html">StimBank:灵活的刺激管理</a></li>
239224
<li class="toctree-l1"><a class="reference internal" href="tutorials/build_stimunit_cn.html">StimUnit:模块化的刺激呈现与反应处理单元</a></li>
240-
<li class="toctree-l1"><a class="reference internal" href="tutorials/send_trigger_cn.html">概述</a></li>
241-
<li class="toctree-l1"><a class="reference internal" href="tutorials/send_trigger_cn.html#id2">主要功能</a></li>
242-
<li class="toctree-l1"><a class="reference internal" href="tutorials/send_trigger_cn.html#id3">快速参考</a></li>
243-
<li class="toctree-l1"><a class="reference internal" href="tutorials/send_trigger_cn.html#id4">详细使用指南</a></li>
244-
<li class="toctree-l1"><a class="reference internal" href="tutorials/send_trigger_cn.html#stimunit">5. 与 <code class="docutils literal notranslate"><span class="pre">StimUnit</span></code> 集成</a></li>
245-
<li class="toctree-l1"><a class="reference internal" href="tutorials/send_trigger_cn.html#id8">后续步骤</a></li>
246-
<li class="toctree-l1"><a class="reference internal" href="tutorials/cli_usage_cn.html">概述</a></li>
247-
<li class="toctree-l1"><a class="reference internal" href="tutorials/cli_usage_cn.html#id2">快速参考</a></li>
248-
<li class="toctree-l1"><a class="reference internal" href="tutorials/cli_usage_cn.html#id3">1. 创建一个新项目</a></li>
249-
<li class="toctree-l1"><a class="reference internal" href="tutorials/cli_usage_cn.html#id4">2. 就地初始化</a></li>
250-
<li class="toctree-l1"><a class="reference internal" href="tutorials/cli_usage_cn.html#id5">3. 内部工作原理</a></li>
251-
<li class="toctree-l1"><a class="reference internal" href="tutorials/cli_usage_cn.html#id6">后续步骤</a></li>
252-
<li class="toctree-l1"><a class="reference internal" href="tutorials/llm_client_cn.html">概述</a></li>
253-
<li class="toctree-l1"><a class="reference internal" href="tutorials/llm_client_cn.html#id2">支持的提供商</a></li>
254-
<li class="toctree-l1"><a class="reference internal" href="tutorials/llm_client_cn.html#id3">主要功能</a></li>
255-
<li class="toctree-l1"><a class="reference internal" href="tutorials/llm_client_cn.html#id4">快速参考</a></li>
256-
<li class="toctree-l1"><a class="reference internal" href="tutorials/llm_client_cn.html#id5">详细使用指南</a></li>
257-
<li class="toctree-l1"><a class="reference internal" href="tutorials/llm_client_cn.html#id9">后续步骤</a></li>
225+
<li class="toctree-l1"><a class="reference internal" href="tutorials/send_trigger_cn.html">TriggerSender: 发送硬件触发器</a></li>
226+
<li class="toctree-l1"><a class="reference internal" href="tutorials/cli_usage_cn.html">psyflow-init: 命令行界面</a></li>
227+
<li class="toctree-l1"><a class="reference internal" href="tutorials/llm_client_cn.html">LLMClient: 使用大型语言模型</a></li>
258228
</ul>
259229

260230
</div>

0 commit comments

Comments
 (0)