mlcheck

mlcheck 是一个命令行工具，用于检查不同编码文档中的机器学习最佳实践。

可以将此工具视为机器学习最佳实践的拼写检查器。

当前版本可以检测 .py 或 .ipynb (Jupyter Notebook) 文件中的 scikit-learn 风格 Python 代码和 .R 或 .Rmd 文件中的 tidymodels 风格 R 代码。

安装

如果您已安装 Rust 和 Cargo（如果您还没有，请参阅 此资源），您可以使用以下命令从 crates.io 安装 mlcheck

cargoinstall mlcheck

运行 mlcheck

要在文件上运行 mlcheck，可以运行以下终端命令

mlcheck --path path/to/your_file_name.py

要在包含 .py 和/或 .ipynb 文件的文件夹上运行 mlcheck，可以运行以下终端命令

mlcheck--path path/to/folder/

分析 mlcheck 结果

要查看使用 mlcheck 运行的所有过去检查，您可以查询在第一次运行 mlcheck 时自动创建的 mlcheck_output.db sqlite 数据库。只要您在相同的文件夹中运行 mlcheck，新的检查将附加到数据库中。

sqlite3 mlcheckoutput.db

sqlite>select*from mlcheck_results

如果您希望将 mlcheck 结果保存为 csv，请按以下方式运行您的命令

mlcheck--path path/to/your_file_name.py--output csv

免责声明

注意： mlcheck 处于一个非常初级的阶段，并且正在积极开发中。可能存在破坏性更改。

致谢

此工具的概念部分受到 statcheck 项目的启发。

潜在的未来功能

• 在所有样式之间添加更多特定、复杂的正则表达式