Skip to content

Latest commit

 

History

History
 
 

projects

Директория с проектами студентов

Данная директория содержит результаты выполнения лабораторных работ студентами. Каждый каталог содержит результаты прохождения курса конкретным студентом, внутренняя структура каталогов унифицирована и выглядит следующим образом:

.
├── assets
├── README.md
└── source

2 directories, 1 file

Так, назначение приведенных файлов и директорий следующее:

  1. директория assets содержит вспомогательные и конфигурационные файлы проекта (не являющиеся исходным кодом), в том числе - результаты обработки исходных датасетов. Сами исходные датасеты загружать не нужно. Внутренняя структура файлов и каталогов в данной директории не регламентируется, за исключением уточнений в инструкции по выполнению той или иной лабораторной работы. При создании файлов и каталогов рекомендуется следовать конвенции kebab-case, поддерживаемой в данном репозитории;
  2. файл README.md содержит общее описание проекта, инструкцию по запуску программных модулей и тестов для них. Рекомендуется соблюдать структуру, приведенную в примере оформления проекта;
  3. директория source содержит файлы с исходным кодом проекта. Внутренняя структура файлов и каталогов в данной директории зависит от правил наименования и организации файлов при разработке систем с использованием той или иной программной платформы, фреймворка и экосистемы. Для языка программирования python необходимо соблюдать структуру, реализованную в примере проекта.

Пример полной структуры файлов и каталогов проекта:

.
├── assets
│   ├── emoji-to-label.yml
│   └── environment.yml
├── README.md
└── source
    ├── classifier
    │   ├── __init__.py
    │   ├── __main__.py
    │   ├── reader.py
    │   └── tokenizer.py
    ├── __init__.py
    └── tests
        ├── __init__.py
        ├── test_classification.py
        └── test_tokenization.py

4 directories, 11 files