Skip to content

Latest commit

 

History

History
63 lines (34 loc) · 6.4 KB

recommendations.md

File metadata and controls

63 lines (34 loc) · 6.4 KB

Рекомендации и комментарии для выполнения лабораторного практимума по курсу «Распознавание диктора», Университет ИТМО, 2021

Организация проекта

Проект, содержащий задания для выполнения лабораторных работ, организован следующим образом:

  1. Задания для выполнения конкретной лабораторной работы находятся в соответствующей поддиректории (./lab1, ./lab2 и т.д.) настоящего проекта. Выполнение каждого задания предполагается в соответствующей поддиректории:

    • ./labN/main.py – исполняемый файл, выполняющий все задания лабораторной работы. Разработка ведется в нем и в файлах, содержащих требуемый функционал и импортированных в main.py. Файл main.py требуется создать самостоятельно.
    • ./labN/labN_blank.ipynb – Jupiter Notebook файл, можно использовать (и будет использоваться преподавателями курса) для проверки правильности выполнения заданий лабораторной работы. Данный файл содержит теоретическую часть и более конкретные комментарии, что и где должно выполняться и какой функционал должен за это отвечать. Этот файл может изменяться в процессе выполнения задания только в крайнем случае, когда очевидно, что изменения необходимы.

  2. Поддиректория ./common содержит общий функционал, который может быть импортирован при выполнение отдельных лабораторных работ. Расширение функционала общего назначения желательно делать именно в этой поддиректории.

Общие рекомендации

При выполнении лабораторных работ рекомендуется:

  1. Использовать Python 3.8. Файл ./requirements.txt содержит минимальный набор рекомендованных пакетов. В случае, если для выполнения лабораторных используюся иные пакеты, requirements.txt должен быть обновлен соответствующим образом.

  2. Стандартизация кода или «читабельность имеет значение»: настоятельно рекомендуется использовать единый стиль кода, описанный в PEP8. Особое внимание необходимо уделить именованию сущностей и модульности кода. В качестве примера можно использовать заготоки в лабораторных работах.

Технические рекомендации

Перед началом выполнения лабораторного практикума требуется осуществить следующую последовательность действий (рекомендации приведены для случая использования Linux-подобной операционной системы):

  1. Используя команду cd перейти в раздел, где будет создан рабочий директорий.

  2. Создать рабочий директорий, например, с именем work_dir: mkdir -m777 work_dir

  3. Перейти в рабочий директорий: cd work_dir

  4. Клонировать репозиторий с кодами.

    • Проверить наличие Git: git --version
    • Если Git не установлен, выполнить следующие команды: sudo apt-get update и sudo apt-get install git
    • Выполнить клонирование репозитория следующей командой: git clone https://github.com/va-volokhov/itmo_speaker_recognition_course.git

  5. Проверить, что репозиторий склонирован, используя команду ll или ls.

  6. Установить Wget, чтобы иметь возможность скачивания данных из сети.

    • Проверить наличие Wget следующей командой: wget --version
    • В случае, если Wget отсутствует, выполнить установку так: sudo apt-get install wget

  7. Создать виртуальное окружение Python.

    • Проверить наличие virtualenv: virtualenv --version
    • Если virtualenv не установлен, выполнить следующую команду: sudo apt install virtualenv
    • Создать виртуальное окружение, например, с именем srlab_venv: virtualenv srlab_venv --python=python3.8

  8. Активировать виртуальное окружение следующей командой, находясь в рабочем директории work_dir: source ./srlab_venv/bin/activate

  9. Проверить следующей командой, что интерпретатор Python привязан к созданному виртуальному окружению: which python

  10. Перейти в директорий, который содержит клонированный репозиторий: cd itmo_speaker_recognition_course

  11. Выполнить установку необходимых модулей Python для запуска программных кодов: pip install -r requirements.txt -f https://download.pytorch.org/whl/lts/1.8/torch_lts.html