Стиль оформления

Текст* Разделы

* В начале каждого раздела делается вводное описание всего раздела
* Установленная структура заголовков
    * Подведение итогов
    * Упражнения
    * QR-код для перехода к обсуждению
    * Ссылки на источники (если есть)
* Цитирование
    * Цитирование в конце каждой секции

• Строка

  • Используются двойные кавычки кириллицей

• Описание символов

  • Время (t) (не (t) время)
  • Фигуры используют английскую пунктуацию
    • ((10, 20)) вместо ((10, 20))

• Пробелы:

  • Между кириллицей и латиницей, цифрами, математическими формулами, специальными шрифтами пробелы не нужны
  • Для :numref: и :cite: перед ними оставляем один пробел (иначе страница не отображается)
  • Примечания к коду аналогично

• Лица

  • Первое лицо → мы
  • Второе лицо → читатель, вы, все

• Инструменты или части

  • Gluon, MXNet, NumPy, spaCy, ResNet-18, Fashion-MNIST, matplotlib
    • Эти слова пишутся как единое слово, без ударений
  • Функция backward
    • Не "функция backward()" (без скобок)
  • Цикл for

• Термины

  • Единство использования
    • Функция (не метод)
    • Экземпляр (не объект)
    • Отличие: гиперпараметры и параметры
    • Отличие: мини-батч стохастический градиентный спуск и стохастический градиентный спуск
    • Веса, смещения, метки
    • Обучение модели, прогнозирование модели (вывод)
    • Обучающий набор данных, проверочный набор данных, тестовый набор данных * Кириллица предпочитается латинице
    • При первом упоминании указывается оригинальное английское название термина
      • Без полужирного начертания
      • Без кавычек
  • Единые стандарты для кириллицы и латиницы
    • https://github.com/mli/gluon-tutorials-zh/blob/master/README.md## Математика

• Единый стиль математических символов

  • https://github.com/goodfeli/dlbook_notation/blob/master/notation_example.pdf

• Ограничение ширины страницы книги

  • Длина строки

• Цитирование

  • Вышеуказанное выражение и нижеуказанное выражение
  • Вышеуказанное (N) выражение, нижеуказанное (N) выражение

• Заключительные знаки препинания после формул

  • Запятая: ,
  • Точка: .

• Знак присваивания

  • (\leftarrow)

Изображения

• Программное обеспечение
  • Создание диаграмм с помощью OmniGraffle, экспортировать pdf (бесконечное полотно) в размере 100%, затем преобразовать pdf в svg с помощью pdf2svg
• Стили
  • Формат:
    • svg
    • png
      • Экспортное разрешение: 144
  • Размер:
    • Ширина: не более 400 пикселей
    • Высота: не более 200 пикселей
  • Толщина линий:
    • StickArrow
    • 1pt
    • Размер головки стрелки: 50%
  • Шрифты:
    • Английский: STIXGeneral, 9pt (низкие индексы и верхние индексы: 6pt)
    • Китайский: PingFang SC, 9pt
    • Нижний и верхний индексы должны быть без курсива для цифр и скобок
  • Цвета:
    • Темно-синий (близкий к черному):
      • 5B7DAA
    • Синий (в контрасте с черным):
      • Темный: 66BFFF
      • Светлый: B2D9FF
• Авторское право
  • Не использовать изображения из интернета
• Расположение
  • Два изображения не должны располагаться рядом друг с другом
    • Объедините два изображения вместе
• Цитирование
  • Ручное цитирование (например, рисунок 7.1)
• Matplotlib
  • Размер
  • Разрешение

Код* Используйте utils.py для упаковки часто используемых функций

* При первом появлении функции, приведите её реализацию в книге

• Соответствие Python стандартам

  • PEP8
    • Разбиение строк для двоичных операторов: оператор и следующий аргумент должны переходить на новую строку (https://www.python.org/dev/peps/pep-0008/#should-a-line-break-before-or-after-a-binary-operator)

• Объединение смежных операторов присваивания в одну строку

  • Например num_epochs, lr = 5, 0.1

• Одинаковое использование названий переменных

  • num_epochs
    • Число эпох
  • num_hiddens
    • Количество скрытых единиц
  • num_inputs
    • Количество входных данных
  • num_outputs
    • Количество выходных данных
  • net
    • Модель
  • lr
    • Скорость обучения
  • acc
    • Точность
  • В процессе обучения
    • Характеристики: features или images
    • Метки: labels, y, y_hat или Y, Y_hat
    • for X, y in data_iter
  • Датасеты:
    • Характеристики: features или images
    • Метки: labels
    • Экземпляр DataLoader: train_iter, test_iter, data_iter

• Комментарии

  • На китайском языке
  • Без точки в конце предложения

• Ограничение ширины строки

  • Не более 78 символов на строку
    • In [X]: 79 символов не будут автоматически переноситься (X = 1,...,9)
    • In [XX]: 78 символов не будут автоматически переноситься (XX = 10, 11,...,99)
  • Автоматический перенос вывода

• Импорты

  • Импортирование алфавитно
  • from mxnet.gluon import data as gdata, loss as gloss, nn, utils as gutils

• Названия для печати

  • epoch (начиная с 1), lr, loss, train_acc, время
  • 5-6 строк* Переменные для печати
  • Последняя строка блока кода должна избегать использования print(), например x, y вместо print('x:', x, 'y:', y)

• Строка

  • Использование одинарных кавычек

• Другое

  • nd.f(x) → x.nd
  • random_normal → random.normal
  • множественные импорты
  • . 1 → 1.0
  • 1. → 1.0
  • удаление namescope## Гиперссылки

• Внутренние ссылки

  • «Линейная регрессия» раздел

• Внешние ссылки

  • слои
  • Не требуется отображение URL## Часто задаваемые вопросы при переводе с английского на китайский*

При возникновении неопределённостей можно обратиться к методам обработки в первом издании на китайском языке (то есть тем публикационным стандартам, которые нам следует соблюдать), а также воспользоваться машинным переводом с сайта http://www.jukuu.com/.

Создайте таблицу соответствия терминов на китайском и английском языках; все термины должны быть переведены строго одинаково на протяжении всего документа.

Грамматика должна быть правильной (например, предложения не могут быть неполными), предложения должны быть гладкими (если буквальный перевод некорректен, используйте смысловой перевод), не должно быть пропущенного контента.

Комментарии к коду должны быть переведены. Обратите внимание: i) каждая строка не должна превышать 78 символов, конец строки не требует точки; ii) после знака решётки (#) должен следовать пробел (английский); iii) если комментарий находится на одной строке с кодом, перед решёткой должно быть два пробела (английских); iv) сохраните символы в комментариях (чтобы указать части кода, такие как имена переменных или функций); v) между китайским и английским языками в комментариях пробелы не нужны; vi) применяйте алгоритм "жадного" переноса строк: переходите на новую строку только при достижении 78 символов.* Не добавляйте лишние пустые строки (это создаст новый абзац).

• Термины должны содержать английскую версию. Сейчас многие места недостаточно переведены на английский. Формат: термин (terminology)
• Основной текст и комментарии к коду должны использовать русские знаки препинания. Например, круглые скобки должны быть полноконечными (), а не английскими полуразмерными (). Исключение: все фигурные скобки и запятые (запятая должна быть заанглицирована и отделена от слова одним пробелом) используются английскими полуразмерными, например "(размер батча, количество слов)" вместо "（размер батча，количество слов）".
• Английские слова в заголовках или в начале предложения не должны начинаться с большой буквы (кроме случаев, когда это само собой является термином с большой буквой).
• Будьте прямыми. "Вы" -> "ты", удалите "пожалуйста".