Skip to content

00. Git и структура рабочего пространства ​

В этом уроке мы подготовим «рабочую мастерскую»: клонируем репозиторий задания, разберём его структуру и настроим git так, чтобы каждое решение TODO было отдельным коммитом. Это не «вводный урок по git» — только те команды, которые мы будем использовать постоянно.

Зачем git здесь вообще нужен ​

Задание — это скелет с TODO: вы будете менять knn.py, metrics.py, gradient_check.py, linear_classifer.py и ноутбуки. Без истории версий вы не ответите на два вопроса:

  1. «Что именно я изменил с прошлого рабочего варианта?» — git diff;
  2. «К какой версии кода относятся мои цифры accuracy?» — git log.

Сдавать задание (если требуется) — это ссылка на ваш коммит, а не zip-архив.

Шаг 1. Клонируем репозиторий ​

Репозиторий задания: https://github.com/sim0nsays/dlcourse_ai

bash
# Клонируем репозиторий задания
git clone https://github.com/sim0nsays/dlcourse_ai.git
cd dlcourse_ai
git log --oneline -3   # последние 3 коммита: проверим, что клонился

Если вы работаете с копией исходников из этого модуля (assignment_source/), то просто создайте собственную папку dlcourse_ai/, скопируйте туда файлы из assignment_source/ и выполните git init + первый коммит — структура та же.

Шаг 2. Смотрим, что внутри ​

Нас интересует только assignments/assignment1:

bash
ls assignments/assignment1
# dataset.py
# download_data.sh
# gradient_check.py
# knn.py
# KNN.ipynb
# Linear classifier.ipynb
# linear_classifer.py
# metrics.py
# README.md
# requirements.txt

Два файла уже готовы и не требуют решения: dataset.py (загрузка данных) и download_data.sh (скрипт скачивания).

Шаг 3. Настройка git для начала работы ​

Перед любыми правками зафиксируем стартовое состояние — это «нулевой коммит», к которому можно откатиться:

bash
git status           # что изменилось (пока ничего)
git add -A
git commit -m "assignment1: starting point"

Конфигурация (однократно) ​

Git обязан знать, от чьего имени делать коммиты. Если git commit ругается — выполните один раз:

bash
git config --global user.name "Your Name"
git config --global user.email "you@example.com"

Шаг 4. .gitignore: большие файлы не коммитим ​

В папку data/ лягут train_32x32.mat (~180 МБ) и test_32x32.mat (~60 МБ). Никогда не коммитьте в git многомегабайтные данные — репозиторий раздуется, а git push станет мучением. Данные — это «артефакт сборки», который всегда можно скачать заново.

Создайте в корне репозитория файл .gitignore:

text
# Data files (regenerable via download_data.sh)
data/
data_stub/

# Python
__pycache__/
*.pyc

# Jupyter
.ipynb_checkpoints/

Проверка:

bash
mkdir -p data
git status
# data/ не должна появляться в списке изменений

Почему data_stub/ тоже игнорируем? Стаб (синтетические цифры) генерируется скриптом make_svhn_stub.py за секунды — смысла хранить его в git нет.

Как мы будем коммитить в этом курсе ​

Каждый урок решает 1–3 TODO. После решения каждого TODO — отдельный коммит с осмысленным сообщением. Это дисциплина: сообщение коммита описывает, что изменилось, а не что мы делали весь вечер.

bash
# Примеры хороших сообщений для этого задания
git commit -m "knn: implement compute_distances_two_loops"
git commit -m "knn: implement vectorized distances with broadcasting"
git commit -m "metrics: binary precision/recall/F1 with zero-division guard"
git commit -m "linear: softmax_with_cross_entropy + gradient check green"

Частые ошибки новичков ​

ОшибкаСимптомЛечение
Коммит данныхgit status показывает train_32x32.matдобавьте data/ в .gitignore, git rm --cached data/*
Потеря изменений«Я переписал файл, где было старое?»git diff до правки, git checkout -- knn.py для отката
Коммит «fix»сообщение без смыслапишите что: knn: vectorized distances
git add -A «по привычке»в коммит уехали мусорные файлыgit add <файл> точечно

Практика: мини-таск на git ​

Выполните в своей копии репозитория и ответьте на вопросы (решение — в раскрывающемся блоке):

1. Создайте файл notes.md с текстом «KNN part». Выполните git add notes.md, git status, затем git commit -m "add notes". Что показал git status после коммита?

2. Добавьте в notes.md строку «Linear part». Не коммитя, выполните git diff notes.md. Что показывает diff? А что будет, если выполнить git diff --staged после git add notes.md?

3. Удалите notes.md (git rm notes.md), скоммитьте. Убедитесь через git log --oneline и git show --stat HEAD, что файл удалён в последнем коммите.

Показать решения

1. После коммита git status показывает «nothing to commit, working tree clean» — рабочее дерево совпадает с последним коммитом.

2. git diff notes.md показывает изменение в рабочем дереве (строка добавлена, маркер +). После git add notes.md обычный git diff пуст, а git diff --staged показывает то же самое изменение, но теперь в индексе.

3. git show --stat HEAD содержит блок notes.md | 1 - (один удалённый символ), файл в списке дерева отсутствует.

Что дальше ​

Среда готова: есть клон, есть .gitignore, вы умеете коммитить. Следующий урок — 01. Окружение и данные: Python, venv, установка зависимостей и загрузка SVHN (или генерация стаба).

Итоги урока ​

  • Git нужен, чтобы каждая правка была откатываемой и атрибутируемой;
  • data/ и data_stub/ — в .gitignore, данные не коммитим;
  • Дисциплина курса: решили TODO → проверили → один коммит с осмысленным сообщением;
  • Основные команды: git status, git add <file>, git commit -m, git diff, git log --oneline, git show --stat HEAD.