MLflow 仓库拼写检查实战使用 typos 查找、修复与忽略拼写错误【免费下载链接】mlflowThe open source AI engineering platform for agents, LLMs, and ML models. MLflow enables teams of all sizes to debug, evaluate, monitor, and optimize production-quality AI applications while controlling costs and managing access to models and data.项目地址: https://gitcode.com/GitHub_Trending/ml/mlflow本指南面向 MLflow 项目贡献者与希望在自己仓库中落地拼写检查的开发者系统讲解如何借助typos工具完成拼写错误的查找、批量修复与误报忽略。文章以 dev/typos.md 为骨架结合 MLflow 仓库中真实的 pyproject.toml 配置与 .pre-commit-config.yaml 钩子定义帮助你理解这套检查机制在 MLflow 中的完整落地方式并掌握可直接复用的配置写法。typos 在 MLflow 仓库中的角色typos是一个基于预置词典的拼写检查工具它只报告词典中已知的拼写错误不依赖语法分析因此误报率低、执行速度快非常适合作为 CI / pre-commit 检查的一部分。在 MLflow 仓库中typos被注册为 pre-commit 钩子定义于 .pre-commit-config.yaml- id: typos name: typos entry: bin/typos --format brief --color never files: \.(py$|mdx?$) language: system stages: [pre-commit] require_serial: true pass_filenames: false这段配置揭示了两个关键事实检查范围files: \.(py$|mdx?$)意味着typos只扫描 Python.py、Markdown.md与 MDX.mdx文件其他类型的文件不参与检查。执行方式entry: bin/typos --format brief --color never使用--format brief输出简洁的检查结果并关闭颜色输出以便日志归档pass_filenames: false表示整个仓库作为一个整体被扫描而非逐文件传入。安装 typos在本地开发环境中MLflow 推荐通过 Homebrew 安装与 CI 一致的版本# 将 version 替换为 dev/install-typos.sh 中安装的版本 brew install typos-cliversion使用带版本号的安装方式可以保证本地检查结果与 CI 完全一致避免因工具版本差异导致本地通过、CI 失败的困扰。除 Homebrew 外typos官方还提供了cargo install typos-cli、预编译二进制等安装途径可按需选用。查找拼写错误查找仓库中的拼写错误只需一行命令pre-commit run --all-files typos这条命令通过 pre-commit 框架调用上一节定义的typos钩子对全仓库范围内符合\.(py$|mdx?$)规则的文件执行检查并以brief格式输出命中项及对应文件位置。由于钩子配置了require_serial: true检查会在单个进程中串行执行避免并发扫描带来的资源竞争。若你尚未配置 pre-commit 环境也可以直接调用typos二进制typos [PATH]不带路径时默认扫描当前目录并自动遵守 pyproject.toml 中的[tool.typos.*]配置段。修复拼写错误找到错误后可以手动逐一修改也可以借助typos的自动写入能力typos --write-changes [PATH]--write-changes会把检查到的拼写错误按词典中的正确拼写直接改写回文件中。[PATH]是可选参数用于把修改限定在指定路径范围内——例如只想修正mlflow/store/目录下的文件时传入该目录即可。需要留意的是自动改写适用于词典中明确给出的修正项对于人工扩展词表或正则忽略的误报见下文--write-changes不会触碰。批量改写前建议先跑一次不带--write-changes的检查人工确认命中清单再执行写入。忽略误报typos依赖内置词典难免会把代码中合法的变量名、缩写、专有名词判定为错误。MLflow 提供了两种处理误报的方式分别对应一次性与全局性两种场景。方式一行内 / 块级忽略注释当误报只是个别文件中的偶发情况时推荐直接在源码中注释标记让检查器跳过该行或该代码块# 忽略包含拼写错误的单行 false_positive # spellchecker: disable-line # 忽略一整块包含拼写错误的代码 # spellchecker: off false_positive another_false_positive # spellchecker: on这两种注释指令之所以生效是因为 MLflow 在 pyproject.toml 的[tool.typos.default]段用正则将其显式纳入忽略范围[tool.typos.default] extend-ignore-re [ # 行级忽略以 # spellchecker: disable-line 结尾的行 (?Rm)^.*#\\s*spellchecker: disable-line$, # 块级忽略# spellchecker: off 与 # spellchecker: on 之间的内容 (?s)(#|//)\\s*spellchecker: off.*?\\n\\s*(#|//)\\s*spellchecker: on, ... ]其中(?Rm)表示多行 无换行匹配的修正标志(?s)表示.可跨行匹配从而让off与on之间的任意文本含换行整体被跳过。这意味着这两条注释约定是 MLflow 自定义并全局生效的规则你在仓库中看到这类注释时应理解为这里经过人工确认、属于合法内容。方式二扩展全局忽略列表当同一个误报反复出现在多个文件、多行代码中时逐行加注释显然不经济。此时应在pyproject.toml的[tool.typos.default]段扩展extend-ignore-re正则列表# pyproject.toml [tool.typos.default] extend-ignore-re [ ..., false_positive, ]MLflow 仓库中实际维护的忽略正则极具代表性涵盖了大量领域术语与测试文本例如[tool.typos.default] extend-ignore-re [ # numpy.arangetypos 曾误报 arange (?i)(numpy|np)\\.arange, # nd array 相关写法 (?i)nd( |_|\\.)?array, # 用于测试的德语 / 法语句子 MLflow ist, Ich habe eine schöne Haufe von Kokos, Apple Inc. ist ein, Apple Inc. est une entreprise technologique, # pytorch-lightning lightning, # typos 会把 lok 误判为 look 的拼写错误 (?i)daniel lok, # GitHub 用户名提及 [a-z0-9-], # Azure 容器实例 / Kubernetes 服务缩写 \\(ACI\\), \\(AKS\\), AKS, # Journey 乐队歌词 Dont Stop Believin livin, ]上述完整列表见 pyproject.toml#L516-L547。可以看出这类忽略条目往往带有明确注释说明为何它是合法的便于后续维护者理解取舍依据。新增忽略项时建议遵循同样的注释习惯。发现拼写错误但 typos 不识别typos的词典覆盖范围有限某些仓库特有拼写如缩写、内部术语即使拼写正确也会被误报而某些真实拼写错误也可能因不在词典中而被漏报。此时可以扩展extend-words词表把词汇加入[tool.typos.default.extend-words]段# pyproject.toml [tool.typos.default.extend-words] ... mflow mlflowextend-words的键值语义为如果文本中出现键mflow则视为mlflow的拼写错误并按其修正。MLflow 仓库自身的词表定义于 pyproject.toml#L483-L497充分体现了领域术语 内部缩写的典型用法[tool.typos.default.extend-words] aimd aimd # additive increase multiplicative decreaseAIMD 拥塞控制 als als # alternating least squares交替最小二乘 mape mape # mean absolute percentage error平均绝对百分比误差 fpr fpr # false positive rate假阳性率 gam gam # generalized additive models广义加性模型 ser ser # serialization yhat yhat # ŷ预测值符号 iternal internal # internal 的拼写错误 instumentation instrumentation # instrumentation 的拼写错误 selectin selectin # SQLAlchemy 懒加载策略 tpe tpe # Tree-structured Parzen Estimatorhyperopt/optuna TPE TPE # Tree-structured Parzen Estimator indx indx # 索引的有意简写 Tru Tru # TruLens 库名前缀这里存在两类语义截然不同的条目值得区分修正真实错误如iternal internal、instumentation instrumentation作用是让typos --write-changes能自动修正仓库中残留的真实拼写错误宣告合法词汇如tpe、ser、indx等作用是向词典登记这些在 MLflow 上下文中合法且意图明确的写法避免它们被误报或误改。两种用法共用同一配置段新增条目时应根据意图附上注释方便后续维护。控制扫描的文件范围typos默认会扫描仓库中几乎所有文本文件但 MLflow 通过 pyproject.toml#L499-L514 的[tool.typos.files]段做了精细的白名单 例外管理[tool.typos.files] extend-exclude [ # 白名单只检查下列扩展名 *, !*/, !*.py, !*.md, !*.mdx, # proto 文件虽然匹配 *.py但这里再次排除 mlflow/protos/**/*, # 第三方 vendor 代码不改动 mlflow/utils/gorilla.py, # 子模块内容应在上游修复而非在此修改 mlflow/assistant/skills/**/*, ]配置逻辑为先用*排除一切文件再用!*.py、!*.md、!*.mdx反向加入允许检查的类型随后进一步排除三组例外——自动生成的 proto 代码、vendored 的gorilla.py、以及作为子模块引入的mlflow/assistant/skills目录。这与你此前看到的 pre-commit 钩子files规则\.(py$|mdx?$)相互印证构成钩子入口 工具内层的双重范围控制。延伸MLflow 品牌拼写的专项检查除了通用拼写检查MLflow 还维护了一个针对品牌名拼写的专项脚本 dev/mlflow-typo.sh。它用正则 \bM(lf|LF|lF)low\b扫描代码揪出把MLflow误写成Mlflow的拼写错误允许的例外模式为Mlflow\(|Mlflow|import Mlflow$例如字符串常量或 import 语句中的大小写通过EXCLUDED_FILES数组跳过不受控制的 i18n JSON 文件、StringUtils.ts及对应测试文件命中时输出提示并返回退出码 1在 CI 中使检查失败。它适用于typos词典未必覆盖的大小写语义问题是通用拼写检查之外的有效补充。总结MLflow 拼写检查的完整工作流结合上述内容MLflow 仓库的拼写检查体系可以归纳为一条完整链路安装brew install typos-cliversion与 CI 版本保持一致触发通过.pre-commit-config.yaml中的typos钩子执行bin/typos --format brief --color never仅扫描.py/.md/.mdx文件范围控制[tool.typos.files]段通过白名单 例外排除 proto、vendored 与子模块代码误报处理偶发误报用# spellchecker: disable-line/off/on注释就地跳过全局误报在extend-ignore-re中添加正则词表扩展真实错误在extend-words中登记以启用自动修正合法术语同样在此登记以防误报批量修复确认命中清单后执行typos --write-changes [PATH]自动改写品牌专项用 dev/mlflow-typo.sh 额外拦截Mlflow大小写误写。对于任何希望把拼写检查集成进日常开发流程的团队这套通用工具 精细配置 专项脚本的组合方式都值得直接借鉴它既保证了检查的自动化与一致性又通过词典扩展、正则忽略和范围白名单把误报干扰降到最低让拼写检查真正成为提升代码库质量与可检索性的可靠一环。如果你想进一步了解各配置项的完整语义可直接阅读仓库根目录的 pyproject.toml[tool.typos.*]三段配置以及 .pre-commit-config.yaml 中的钩子定义。【免费下载链接】mlflowThe open source AI engineering platform for agents, LLMs, and ML models. MLflow enables teams of all sizes to debug, evaluate, monitor, and optimize production-quality AI applications while controlling costs and managing access to models and data.项目地址: https://gitcode.com/GitHub_Trending/ml/mlflow创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
MLflow 仓库拼写检查实战：使用 typos 查找、修复与忽略拼写错误
MLflow 仓库拼写检查实战使用 typos 查找、修复与忽略拼写错误【免费下载链接】mlflowThe open source AI engineering platform for agents, LLMs, and ML models. MLflow enables teams of all sizes to debug, evaluate, monitor, and optimize production-quality AI applications while controlling costs and managing access to models and data.项目地址: https://gitcode.com/GitHub_Trending/ml/mlflow本指南面向 MLflow 项目贡献者与希望在自己仓库中落地拼写检查的开发者系统讲解如何借助typos工具完成拼写错误的查找、批量修复与误报忽略。文章以 dev/typos.md 为骨架结合 MLflow 仓库中真实的 pyproject.toml 配置与 .pre-commit-config.yaml 钩子定义帮助你理解这套检查机制在 MLflow 中的完整落地方式并掌握可直接复用的配置写法。typos 在 MLflow 仓库中的角色typos是一个基于预置词典的拼写检查工具它只报告词典中已知的拼写错误不依赖语法分析因此误报率低、执行速度快非常适合作为 CI / pre-commit 检查的一部分。在 MLflow 仓库中typos被注册为 pre-commit 钩子定义于 .pre-commit-config.yaml- id: typos name: typos entry: bin/typos --format brief --color never files: \.(py$|mdx?$) language: system stages: [pre-commit] require_serial: true pass_filenames: false这段配置揭示了两个关键事实检查范围files: \.(py$|mdx?$)意味着typos只扫描 Python.py、Markdown.md与 MDX.mdx文件其他类型的文件不参与检查。执行方式entry: bin/typos --format brief --color never使用--format brief输出简洁的检查结果并关闭颜色输出以便日志归档pass_filenames: false表示整个仓库作为一个整体被扫描而非逐文件传入。安装 typos在本地开发环境中MLflow 推荐通过 Homebrew 安装与 CI 一致的版本# 将 version 替换为 dev/install-typos.sh 中安装的版本 brew install typos-cliversion使用带版本号的安装方式可以保证本地检查结果与 CI 完全一致避免因工具版本差异导致本地通过、CI 失败的困扰。除 Homebrew 外typos官方还提供了cargo install typos-cli、预编译二进制等安装途径可按需选用。查找拼写错误查找仓库中的拼写错误只需一行命令pre-commit run --all-files typos这条命令通过 pre-commit 框架调用上一节定义的typos钩子对全仓库范围内符合\.(py$|mdx?$)规则的文件执行检查并以brief格式输出命中项及对应文件位置。由于钩子配置了require_serial: true检查会在单个进程中串行执行避免并发扫描带来的资源竞争。若你尚未配置 pre-commit 环境也可以直接调用typos二进制typos [PATH]不带路径时默认扫描当前目录并自动遵守 pyproject.toml 中的[tool.typos.*]配置段。修复拼写错误找到错误后可以手动逐一修改也可以借助typos的自动写入能力typos --write-changes [PATH]--write-changes会把检查到的拼写错误按词典中的正确拼写直接改写回文件中。[PATH]是可选参数用于把修改限定在指定路径范围内——例如只想修正mlflow/store/目录下的文件时传入该目录即可。需要留意的是自动改写适用于词典中明确给出的修正项对于人工扩展词表或正则忽略的误报见下文--write-changes不会触碰。批量改写前建议先跑一次不带--write-changes的检查人工确认命中清单再执行写入。忽略误报typos依赖内置词典难免会把代码中合法的变量名、缩写、专有名词判定为错误。MLflow 提供了两种处理误报的方式分别对应一次性与全局性两种场景。方式一行内 / 块级忽略注释当误报只是个别文件中的偶发情况时推荐直接在源码中注释标记让检查器跳过该行或该代码块# 忽略包含拼写错误的单行 false_positive # spellchecker: disable-line # 忽略一整块包含拼写错误的代码 # spellchecker: off false_positive another_false_positive # spellchecker: on这两种注释指令之所以生效是因为 MLflow 在 pyproject.toml 的[tool.typos.default]段用正则将其显式纳入忽略范围[tool.typos.default] extend-ignore-re [ # 行级忽略以 # spellchecker: disable-line 结尾的行 (?Rm)^.*#\\s*spellchecker: disable-line$, # 块级忽略# spellchecker: off 与 # spellchecker: on 之间的内容 (?s)(#|//)\\s*spellchecker: off.*?\\n\\s*(#|//)\\s*spellchecker: on, ... ]其中(?Rm)表示多行 无换行匹配的修正标志(?s)表示.可跨行匹配从而让off与on之间的任意文本含换行整体被跳过。这意味着这两条注释约定是 MLflow 自定义并全局生效的规则你在仓库中看到这类注释时应理解为这里经过人工确认、属于合法内容。方式二扩展全局忽略列表当同一个误报反复出现在多个文件、多行代码中时逐行加注释显然不经济。此时应在pyproject.toml的[tool.typos.default]段扩展extend-ignore-re正则列表# pyproject.toml [tool.typos.default] extend-ignore-re [ ..., false_positive, ]MLflow 仓库中实际维护的忽略正则极具代表性涵盖了大量领域术语与测试文本例如[tool.typos.default] extend-ignore-re [ # numpy.arangetypos 曾误报 arange (?i)(numpy|np)\\.arange, # nd array 相关写法 (?i)nd( |_|\\.)?array, # 用于测试的德语 / 法语句子 MLflow ist, Ich habe eine schöne Haufe von Kokos, Apple Inc. ist ein, Apple Inc. est une entreprise technologique, # pytorch-lightning lightning, # typos 会把 lok 误判为 look 的拼写错误 (?i)daniel lok, # GitHub 用户名提及 [a-z0-9-], # Azure 容器实例 / Kubernetes 服务缩写 \\(ACI\\), \\(AKS\\), AKS, # Journey 乐队歌词 Dont Stop Believin livin, ]上述完整列表见 pyproject.toml#L516-L547。可以看出这类忽略条目往往带有明确注释说明为何它是合法的便于后续维护者理解取舍依据。新增忽略项时建议遵循同样的注释习惯。发现拼写错误但 typos 不识别typos的词典覆盖范围有限某些仓库特有拼写如缩写、内部术语即使拼写正确也会被误报而某些真实拼写错误也可能因不在词典中而被漏报。此时可以扩展extend-words词表把词汇加入[tool.typos.default.extend-words]段# pyproject.toml [tool.typos.default.extend-words] ... mflow mlflowextend-words的键值语义为如果文本中出现键mflow则视为mlflow的拼写错误并按其修正。MLflow 仓库自身的词表定义于 pyproject.toml#L483-L497充分体现了领域术语 内部缩写的典型用法[tool.typos.default.extend-words] aimd aimd # additive increase multiplicative decreaseAIMD 拥塞控制 als als # alternating least squares交替最小二乘 mape mape # mean absolute percentage error平均绝对百分比误差 fpr fpr # false positive rate假阳性率 gam gam # generalized additive models广义加性模型 ser ser # serialization yhat yhat # ŷ预测值符号 iternal internal # internal 的拼写错误 instumentation instrumentation # instrumentation 的拼写错误 selectin selectin # SQLAlchemy 懒加载策略 tpe tpe # Tree-structured Parzen Estimatorhyperopt/optuna TPE TPE # Tree-structured Parzen Estimator indx indx # 索引的有意简写 Tru Tru # TruLens 库名前缀这里存在两类语义截然不同的条目值得区分修正真实错误如iternal internal、instumentation instrumentation作用是让typos --write-changes能自动修正仓库中残留的真实拼写错误宣告合法词汇如tpe、ser、indx等作用是向词典登记这些在 MLflow 上下文中合法且意图明确的写法避免它们被误报或误改。两种用法共用同一配置段新增条目时应根据意图附上注释方便后续维护。控制扫描的文件范围typos默认会扫描仓库中几乎所有文本文件但 MLflow 通过 pyproject.toml#L499-L514 的[tool.typos.files]段做了精细的白名单 例外管理[tool.typos.files] extend-exclude [ # 白名单只检查下列扩展名 *, !*/, !*.py, !*.md, !*.mdx, # proto 文件虽然匹配 *.py但这里再次排除 mlflow/protos/**/*, # 第三方 vendor 代码不改动 mlflow/utils/gorilla.py, # 子模块内容应在上游修复而非在此修改 mlflow/assistant/skills/**/*, ]配置逻辑为先用*排除一切文件再用!*.py、!*.md、!*.mdx反向加入允许检查的类型随后进一步排除三组例外——自动生成的 proto 代码、vendored 的gorilla.py、以及作为子模块引入的mlflow/assistant/skills目录。这与你此前看到的 pre-commit 钩子files规则\.(py$|mdx?$)相互印证构成钩子入口 工具内层的双重范围控制。延伸MLflow 品牌拼写的专项检查除了通用拼写检查MLflow 还维护了一个针对品牌名拼写的专项脚本 dev/mlflow-typo.sh。它用正则 \bM(lf|LF|lF)low\b扫描代码揪出把MLflow误写成Mlflow的拼写错误允许的例外模式为Mlflow\(|Mlflow|import Mlflow$例如字符串常量或 import 语句中的大小写通过EXCLUDED_FILES数组跳过不受控制的 i18n JSON 文件、StringUtils.ts及对应测试文件命中时输出提示并返回退出码 1在 CI 中使检查失败。它适用于typos词典未必覆盖的大小写语义问题是通用拼写检查之外的有效补充。总结MLflow 拼写检查的完整工作流结合上述内容MLflow 仓库的拼写检查体系可以归纳为一条完整链路安装brew install typos-cliversion与 CI 版本保持一致触发通过.pre-commit-config.yaml中的typos钩子执行bin/typos --format brief --color never仅扫描.py/.md/.mdx文件范围控制[tool.typos.files]段通过白名单 例外排除 proto、vendored 与子模块代码误报处理偶发误报用# spellchecker: disable-line/off/on注释就地跳过全局误报在extend-ignore-re中添加正则词表扩展真实错误在extend-words中登记以启用自动修正合法术语同样在此登记以防误报批量修复确认命中清单后执行typos --write-changes [PATH]自动改写品牌专项用 dev/mlflow-typo.sh 额外拦截Mlflow大小写误写。对于任何希望把拼写检查集成进日常开发流程的团队这套通用工具 精细配置 专项脚本的组合方式都值得直接借鉴它既保证了检查的自动化与一致性又通过词典扩展、正则忽略和范围白名单把误报干扰降到最低让拼写检查真正成为提升代码库质量与可检索性的可靠一环。如果你想进一步了解各配置项的完整语义可直接阅读仓库根目录的 pyproject.toml[tool.typos.*]三段配置以及 .pre-commit-config.yaml 中的钩子定义。【免费下载链接】mlflowThe open source AI engineering platform for agents, LLMs, and ML models. MLflow enables teams of all sizes to debug, evaluate, monitor, and optimize production-quality AI applications while controlling costs and managing access to models and data.项目地址: https://gitcode.com/GitHub_Trending/ml/mlflow创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
