BadThings
@BadThings

Как правильно написать отчет по обучающему проекту пре-джуна?

Собственно после летней практики (универ) продолжил делать проект по нейронкам. Сейчас он закончен и, соответственно, необходимо предоставить небольшой отчет. Не стандартный по практике (он сделан, но там по классике много воды и описана только 1/3 сделанной работы), а с содержанием кода.
Проект очень кусочный и разбит на несколько jupyter-notebook'ов. Половина кода повторяется, еще треть с минимальными изменениями, оставшиеся 20-30% отличается почти во всех ноутбуках, но они по сути являются основными - обучение и все связанное

Если оставлю только "основную" часть, получится в районе строк 50, что как мне кажется достаточно спорно можно будет назвать отчетом за более чем 1 месяц работы
А, ну и говнокод, да. Лютый. Ибо питон был не основным языком и на нем всего 1 небольшой проект

Алсо была мысль взять только последние два ноутбука, уже менее говнокодные и уже написанные с большим пониманием происходящего. Хотя это все равно достаточно мало кода. Однако все еще остается вопрос в каком виде правильно представить эти ноутбуки в качестве отчета? Сделать читаемым (как тут https://habr.com/ru/post/87530/), комментарии в коде, добавить описания на предложения-два перед содержательными кусками?

Хотя зная свою любовь к беспокойству по пустякам, может вовсе не стоит так беспокоится и написать маленький отчет?
  • Вопрос задан
  • 163 просмотра
Пригласить эксперта
Ответы на вопрос 1
Robur
@Robur
Знаю больше чем это необходимо
Отчет то для кого нужен?
Если формальный с водой уже сделан - напишите нормальный, конкретный, что было сделано, зачем и какие результаты получились. Чем конкретнее тем лучше. Если останется 50 строк но по каждой вы ответите и будет понятно что за этим кодом стоит - это отлично. Видимость "побольше работы" и напустить важности - это вы уже сделали в первом отчете.
Ответ написан
Комментировать
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы