Skip to content

Latest commit

 

History

History
 
 

README.md

Директория с результатами выполнения лабораторных работ

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

.
├── lab1
│   ├── source
│   │   ├── <script_name>.py
│   │   └── ... 
│   └── README.md
├── lab2
│   ├── source
│   │   ├── <script_name>.py
│   │   ├── requirements.txt
│   │   └── ... 
│   └── README.md
└── ...

Требования к структуре проекта

  1. Каждую лабораторную должен сопровождать README.md с отчётом о проделанной работе;
  2. Директория source должна содержать исходный код лабораторной работы;
  3. Рекомендуется включать файл requirements.txt (или аналогичный) с зависимостями проекта.

Требования к отчёту (README.md)

Отчёт по каждой лабораторной работе должен включать следующие разделы:

  1. Описание задания - краткое описание выполненной лабораторной работы
  2. Использованные технологии и инструменты - список использованных библиотек, моделей, датасетов
  3. Результаты работы - описание полученных результатов, метрики качества, визуализации (при необходимости)
  4. Выводы - анализ результатов, выявленные проблемы и способы их решения
  5. Инструкция по запуску - пошаговая инструкция для воспроизведения результатов

Пример структуры отчёта:

# Лабораторная работа №X

## Описание задания
[Краткое описание]

## Использованные технологии и инструменты
- Датасет: ...
- Модели: ...
- Библиотеки: ...

## Результаты работы
[Описание результатов, метрики качества]

## Выводы
[Ваши выводы]

## Инструкция по запуску
1. Установить зависимости: `pip install -r requirements.txt`
2. Загрузить датасет: ...
3. Запустить скрипт: `python source/main.py`
...