Соглашение об именах файлов Python для проектов по науке о данных

Question

Какое соглашение о присвоении имен файлам в проекте по науке о данных и машинном обучении?

Я считаю, что имя файла классов Python должно быть существительным . Тем не менее, я хочу пояснить, следует ли называть класс существительным или объектом существительным.

Какой из них мне следует использовать?

1) Класс, который выводит графики.

visualization.py, visualizer.py, vis.py или ...

2) Класс, который анализирует набор данных и выводит файлы, содержащие результаты.

analysis.py, analyzer.py или ...

3) Класс, который охватывает набор данных для pickle файлов .

preprocessor.py, preprocessing.py, prepare.py или ...

(я проверил PEP8 , но не смог найти четкое преобразование имен файлов)

Answer 1

В основном это зависит от того, какой тип данных или выборки используется или каков результат конкретного файла класса. Ниже приведен пример, который может быть полезен для структуры и наименования. https://github.com/uwescience/shablona

Соглашение об именовании файлов для наборов данных

Рекомендуется, чтобы имена были описательными - они отражали содержимое файла. Будьте последовательны - используйте один и тот же формат для всех файлов в проекте, включая файлы набора данных и файлы zip или tar. Некоторые предлагаемые атрибуты включают:

уникальный идентификатор или название проекта / аббревиатура ЧИСЛО ПИ местоположение / пространственные координаты год обучения тип данных номер версии тип файла Используйте не более 32 символов. Используйте только цифры, буквы и подчеркивания. Не используйте специальные символы, тире, пробелы или несколько точек или остановок. Избегайте использования общих терминов («данные», «образец», «окончательный» или «пересмотр»). Используйте последовательный регистр - все строчные буквы, или все верхний регистр, или нижний регистр. Даты должны быть в стандартном формате - ГГГГММДД, что позволит их сортировать в хронологическом порядке.

Последовательная нумерация должна учитывать рост и включать ведущие нули. У вас есть 100 файлов? Нумерация должна быть от 001 до 100.

Answer 2

здесь, в PEP-8 разделе соглашения об именах, ВЫ найдете правильный путь.

в pep-8 также обсуждается, что соглашение об именах неоднозначно.

поэтому, если вы хотите выбрать правильный путь (которому следует другая организация), перейдите на GitHub (например, тензорный поток ) и посмотрите, как они поддерживают соглашение об именах для поддерживаемого проекта.

Вы можете следить за структурой и начинать делать проект.

Ничего не исправлено. все зависит от того, как вы хотите его структурировать. Лучше так и должно быть, легко читать и поддерживать.