Skip to content

docs: 在 docs/tutorial 下新增核心功能模块整理文档#283

Draft
Copilot wants to merge 2 commits intomasterfrom
copilot/create-md-document-for-czsc-tools
Draft

docs: 在 docs/tutorial 下新增核心功能模块整理文档#283
Copilot wants to merge 2 commits intomasterfrom
copilot/create-md-document-for-czsc-tools

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 9, 2026

为帮助用户快速了解 CZSC 工具库的完整工具价值,在 docs/tutorial/ 目录下新建 核心功能模块整理.md,对全部模块和功能函数进行系统化梳理。

文档覆盖范围

  • 核心分析 (czsc/core.py, czsc/py/) — 数据结构(RawBar/FX/BI/ZS)、CZSC 分析引擎、BarGenerator 多级别K线合成
  • 交易框架 (czsc/traders/) — CzscSignalsCzscTraderDummyBacktest、绩效分析、权重回测
  • 信号函数 (czsc/signals/) — 11 个子模块 200+ 信号函数分类索引(tas/bar/cxt/jcc/vol/pos 等)
  • 工具函数 (czsc/utils/) — 技术指标、信号工具、I/O、可视化
  • 其他模块 — 研究传感器 (sensors/)、Streamlit 组件 (svc/)、数据连接器 (connectors/)、特征工程 (features/)、飞书集成 (fsa/)

文档特性

  • 整体架构数据流图(原始K线 → 信号层 → 交易框架 → 可视化)
  • 4 个端到端快速入门代码示例(缠论分析 → 多级别信号 → 完整回测 → Streamlit 可视化)
  • 按使用需求分类的交叉索引表(数据处理 / 缠论分析 / 策略回测 / 可视化 / 缓存存储等)
  • 信号命名规范、频率枚举、环境变量配置等附录说明
Original prompt

This section details on the original issue you should resolve

<issue_title>核心功能模块整理</issue_title>
<issue_description>在 docs/tutorial 下创建一个md文档。整理一下你认为 czsc 工具库模块和功能函数。让用户能快速了解整个项目的工具价值</issue_description>

<agent_instructions>你必须深度阅读一下 czsc 库的全部源码。</agent_instructions>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: zengbin93 <24988472+zengbin93@users.noreply.github.com>
Copilot AI changed the title [WIP] Add documentation for czsc tool library modules docs: 在 docs/tutorial 下新增核心功能模块整理文档 Mar 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

核心功能模块整理

2 participants