mcpField
A
algorithm-design

algorithm-design

github.com/lingzhi227开发4401.7k 次安装35 周前更新
代码仓库

关于 algorithm-design

algorithm-design 可将方法描述或实现整理为算法伪代码和 UML 图，适用于研究人员与开发者，并提供与代码核对的一致性检查。

主要功能

  1. 01定义算法输入、输出和参数
  2. 02编写带编号的 LaTeX 伪代码
  3. 03生成 Mermaid 类图和时序图
  4. 04核对图示与记法是否符合实现
  5. 05加入复杂度分析

适用场景

  1. 01为论文形式化描述方法
  2. 02用 UML 图记录代码结构
  3. 03检查伪代码是否与实现一致

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/lingzhi227/agent-research-skills --skill algorithm-design

安装后在 Claude Code 中输入/algorithm-design确认已加载。

附带文件references/algorithm-templates.md

详细介绍

算法设计

将方法形式化为算法伪代码和系统架构图。

输入

  • $0 — 待形式化的方法描述或实现

参考资料

  • 算法和图表模板：~/.claude/skills/algorithm-design/references/algorithm-templates.md

工作流

步骤 1：形式化算法
  1. 定义清晰的输入和输出
  2. 确定主循环／递归结构
  3. 指定所有参数及其类型
  4. 编写分步伪代码
步骤 2：生成 LaTeX 伪代码

使用 algorithm + algpseudocode 环境：

\begin{algorithm}[t]
\caption{Method Name}
\label{alg:method}
\begin{algorithmic}[1]
\Require Input $x$, parameters $\theta$
\Ensure Output $y$
\State Initialize ...
\For{$t = 1$ to $T$}
    \State $z_t \gets f(x_t; \theta)$
    \If{convergence criterion met}
        \State \textbf{break}
    \EndIf
\EndFor
\State \Return $y$
\end{algorithmic}
\end{algorithm}
步骤 3：生成 UML 图（Mermaid）
类图
classDiagram
    class Model {
        +forward(x: Tensor) Tensor
        +train_step(batch) float
    }
时序图
sequenceDiagram
    participant M as Main
    participant D as DataLoader
    M->>D: load_data()
    D-->>M: batches
步骤 4：验证一致性
  • 每个伪代码步骤都必须对应一个代码模块
  • UML 中的每个类都必须存在于实现中
  • 伪代码与代码中的参数名称必须一致

规则

  • 使用标准算法表示法（而非代码语法）
  • 为行编号，以便查阅
  • 将复杂度分析作为注释或命题
  • 使用 \Require / \Ensure 表示输入／输出
  • 将伪代码控制在恰当的抽象层级——既不过于详细，也不过于笼统

相关技能

评论

支持 Markdown