SuperAPI AI 工具集

karpathy-guidelines

编程与开发

查看项目

更新于 11-12 06:46

技能介绍

Karpathy Guidelines 是一套行为准则,用于减少大语言模型在编程中常见的错误,其内容源自 Andrej Karpathy 对 LLM 编码陷阱的观察。

用途 该准则用于在使用 LLM 编写、审查或重构代码时约束其行为,降低过度设计、擅自扩展和无关改动等问题。其取舍是偏向谨慎而非速度;对于琐碎任务,需自行判断是否适用。

主要能力(四项准则)

  1. 编码前先思考:不作假设,不隐藏困惑,明确呈现权衡。实现前应明确说明假设,不确定时提问;存在多种解释时全部列出而非默默选择;有更简单方案时主动提出,必要时提出反对意见;遇到不清楚之处应停下,指出困惑点并提问。
  2. 简单优先:只写解决问题所需的最少代码,不做任何推测性设计。不添加未被要求的功能;不为一次性代码做抽象;不添加未被要求的“灵活性”或“可配置性”;不为不可能发生的场景编写错误处理;若写了 200 行而可缩减为 50 行,则重写。并以“资深工程师是否会认为这过于复杂”为自检标准。
  3. 最小改动:只触碰必须修改的部分,只清理自己造成的混乱。编辑现有代码时不“改进”相邻代码、注释或格式;不重构未损坏的部分;即使个人风格不同也沿用现有风格;发现无关的死代码时只提及、不删除。当自身改动产生孤立代码时,移除因自己改动而变得未使用的导入、变量和函数;未经要求不删除既有死代码。检验标准是每一行改动都能直接追溯到用户请求。
  4. 目标驱动执行:定义成功标准并循环验证。将任务转化为可验证目标,例如把“添加校验”转为“为无效输入编写测试并使其通过”,把“修复缺陷”转为“编写复现该缺陷的测试并使其通过”,把“重构 X”转为“确保重构前后测试均通过”。多步骤任务应给出简要计划,逐步列出步骤与对应的验证检查。明确而有力的成功标准能让模型独立循环推进,而弱标准(如“让它能跑”)则需不断澄清。

使用方式 将上述准则作为编写、审查或重构代码时的行为约束,在实现前先陈述假设与计划,在改动后按可验证目标检查结果。

适用场景 适用于 LLM 辅助的代码编写、代码审查和重构等任务,尤其是需要控制改动范围、避免过度工程的场合。

限制 资料未提供具体的安装命令、调用接口、平台支持或收费信息;准则本身偏保守,可能牺牲速度,琐碎任务需自行判断是否采用。