数据科学项目的Python文件命名约定

Question

数据科学和机器学习项目中文件的正确命名约定是什么？在

Python文件名应该是。但是，我想弄清楚是将类命名为主语名词还是宾语名词。在

我应该用哪一个？在

1）输出绘图的类。在

visualization.py，visualizer.py，vis.py，或。。。在

2）分析数据集并输出包含结果的文件的类。在

analysis.py，analyzer.py，或。。。在

3）将数据集转换为pickle files的类。在

preprocessor.py，preprocessing.py，prepare.py，或。。。在

（我检查了PEP8，但找不到文件名的明确命名转换）

Answer 1

它主要是关于使用什么类型的数据或采样，或者特定类文件的结果是什么 下面是可能对结构和命名有帮助的示例。 https://github.com/uwescience/shablona

数据集的文件命名约定

最佳做法是名称是描述性的-它们反映了文件的内容。保持一致–对项目中的所有文件使用相同的格式，包括数据集文件和zip或tar文件。一些建议的属性包括：

唯一标识符或项目名称/首字母缩略词 圆周率 位置/空间坐标 学习年限 数据类型 版本号 文件类型 使用不超过32个字符。只使用数字、字母和下划线。不要使用特殊字符、破折号、空格或多个点或句号。避免使用常用术语（“数据”、“样本”、“最终”或“修订版”）。使用统一大小写–全部小写，或全部大写，或小写。日期应采用YYYY-MDA标准格式进行排序。在

顺序编号应考虑增长，并包括前导零。你有100份文件吗？编号应从001到100。在

Answer 2

在PEP-8命名约定部分，您将找到正确的方法。在

pep-8中也讨论了命名约定的模糊性。在

所以，如果你想要一个正确的方法（另一个组织遵循这个方法），那么就去GitHub（例如，tensorflow）看看他们是如何为维护的项目维护那里的命名约定的。在

你可以按照这个结构开始做这个项目。在

没有什么是固定的。这完全取决于你想如何构建它。更好的是它应该是，易于阅读和维护。在