Алексей Забашта

Типичные ошибки в оформлении

Тире vs дефис

Тире (длинная черта) используется между словами, например: «Лондон — столица Великобритании». Дефис (короткая черта) используется внутри кое‐каких слов. Ещё существует короткое тире (средняя черта), которое используется для числовых диапазонов, например: «2017–2020».

В качестве дефиса можно использовать обыкновенный дефис-минус (U+002D).

Подробнее:

• https://ru.wikipedia.org/wiki/Тире
• https://ru.wikipedia.org/wiki/Дефис
• https://www.artlebedev.ru/kovodstvo/sections/97/

Кавычки

В русской типографике принято использовать кавычки «ёлочки», а в качестве вложенных кавычек — „лапки“, но не стоит их путать с “английскими лапками”!

Word сам умеет исправлять "программистские" кавычки на нужные. А вот в LaTex ни в коем случае не используйте "программистские" кавычки, так как из-за них съедается последующий пробел! Внутри item[] ёлочки могут сломать LaTex. В этом случае используйте команды \guillemotleft и \guillemotright

Пример:

Подробнее:

• https://ru.wikipedia.org/wiki/Кавычки
• https://legart.livejournal.com/512486.html
• https://www.artlebedev.ru/kovodstvo/sections/104/

Число vs количество

Всюду, где речь идёт об исчисляемых объектах, следует использовать слово число, а не количество. Например: «число объектов в наборе данных», а не «количество объектов в наборе данных».

Подробнее:

• http://is.ifmo.ru/belletristic/kolvo/
• http://is.ifmo.ru/belletristic/rusporno/

Англицизмы

Старайтесь не использовать англицизмы в тексте, если у них есть адекватный перевод на русский язык. Например: «набор данных», а не «датасет».

Специальные символы, функции и знаки

В LaTex используйте специальные команды для функций \log, \exp, \sin и т.д. Ещё там есть специальные команды для скобок \left ( \right ), чтобы их высота подстраивалась под высоту содержимого. Если лень писать формулу руками, то её можно «накликать» мышкой здесь: https://latex.codecogs.com/eqneditor/editor.php

Не ленитесь использовать особые буквы для математического ожидания 𝔼 (команда \mathbb{E} в LaTex), множества натуральных чисел и т.д. Не используйте звёздочку * для умножения, для этого существует \cdot · или \times ×

Word умеет автоматически преобразовывать в формулах некоторые команды в символы, например: \cdot \times \in \to и т.д.

Десятичные разделитель

В русской типографике принято использовать запятую в качестве десятичного разделителя дробной частей вещественного числа. Word умеет с ними работать, а вот в LaTex требуется подключить пакет \usepackage{icomma}, но после этого, в формулах где запятая используется как запятая, нужно обязательно после неё ставить пробел.

Неразрывные пробелы

Используйте неразрывные пробелы перед тире и скобками от цитирования [], чтобы новая строка не начиналась с них. В Word для этого используется комбинация Ctrl+Shift+Space, а в LaTex специальный символ ~ (тильда). Например:

Лондон~--- столица Великобритании~\cite{some1707book}.

Математическое ожидание

Пишется в два слова. Писать «матожидание» неправильно! Использовать сокращение «мат. ожидание» тоже не рекомендуется.

Названия глав

Названия номерных глав не должны быть общими. Они должны быть специализированы под вашу работу. Например:

Названия неномерных глав, таких как введение и заключение, должны оставаться общими.

Прописной шрифт названий глав

Если названия глав требуется писать ПРОПИСНЫМИ БУКВАМИ, то не стоит это делать в явном виде. Напишите их как обычно. Если вы используете Word, в диалоговом окне Шрифт в разделе Видоизменение установите флажок ВСЕ ПРОПИСНЫЕ. Если вы используете LaTex, то в шаблоне уже должна быть необходимая настройка.

Падежные окончания

Не используйте длинные наращённые падежные окончания.

Переменные в тексте

Переменные в тексте следует выделять курсивом, а ещё лучше писать их в режиме формулы, чтобы они всюду выглядели одинаково. Ещё режим формулы спасает от бага в некоторых продуктах Microsoft Office, иногда при сохранении текста с дефисом после курсива, дефис исчезает. Например: а и б сидели на трубе. Также рекомендуется выделять названия написанные латиницей.

Типичные ошибки в содержании

Случайные величины

Если результат ваших измерений это случайная величина (например: время работы программы, качество классификатора), то необходимо подтвердить её статистическую значимость.

• Случайная величина должна быть измерена несколько раз.
• Если вы указываете её в тексте (в таблице), то необходимо указать соответствующий доверительный интервал через ±. Не забывайте округлять среднее до значащих цифр, например 46,40±0,15 вместо 46,40183±0,15.
• Если вы изображаете её на графике, то для этого следует использовать хотя бы Error Bar plot, ещё лучше Box plot, а если достаточно места на графике и измерений, то ещё лучше Violin plot.

Время работы

Реальное время работы (wall-clock time) программ может быть не так просто сравнить. Современные процессоры способны динамически ускоряться и замедляться в зависимости от температуры или потребляемого напряжения. И при неправильном дизайне эксперимента вас не спасут никакие статистические тесты.

Например: вы решили сравнить реальное время работы двух программ, которое на самом деле одинаково и равно 20 секундам. У вас установлена ширина окна (Tau) в 30 секунд, и краткосрочный лимит (PL2) напряжения не равен долгосрочному (PL1). Вы последовательно запускаете обе программы. Тогда время работы первой программы будет меньше чем у второй, так как процессор потратил на неё почти весь краткосрочный лимит напряжения, во время которого он работал на повышенных частотах. Если у вас не установлены эти лимиты, но установлена плохая система охлаждения, то процессор может успеть перегреться за эти 30 секунд и всё равно начнёт сбрасывать частоту работы или пропускать такты (тротлить).

https://vk.com/@1077823-universalnye-sovety-zaschischauschimsya

https://news.itmo.ru/ru/blog/303/

http://is.ifmo.ru/projects/req/