Задание №1

В файле task-1.rb находится ruby-программа, которая выполняет обработку данных из файла.

В файл встроен тест, который показывает, как программа должна работать.

С помощью этой программы нужно обработать файл данных data_large.txt.

Проблема в том, что это происходит слишком долго, дождаться пока никому не удавалось.

Задача

Оптимизировать эту программу, выстроив процесс согласно "общему фреймворку оптимизации" из первой лекции;
Профилировать программу с помощью инструментов, с которыми мы познакомились в первой лекции;
Добиться того, чтобы программа корректно обработала файл data_large.txt за 30 секунд;
Написать кейс-стади о вашей оптимизации по шаблону case-study-template.md.

Case-study должен получиться рассказом с техническими подробностями о том как вы пришли к успеху в оптимизации. Можно сказать, заготовкой статьи на Хабр/Medium/...

Сдача задания

Для сдачи задания нужно форкнуть этот проект, сделать PR в него и прислать ссылку для проверки.

В PR

должны быть внесены оптимизации в task-1.rb;
должен быть файл case-study.md с описанием проделанной оптимизации;

Задание моделирует такую ситуацию: вы получили неффективную систему, в которой код и производительность оставляет желать лучшего. При этом актуальной проблемой является именно производительность. Вам нужно оптимизировать эту систему.

С какими искушениями вы сталкиваететь:

вы “с ходу” замечаете какие-то непроизводительные идиомы, и у вас возникает соблазн их сразу исправить;

Эти искушения типичны и часто возникают в моделируемой ситуации.

Их риски:

перед рефакторингом “очевидных” косяков не написать тестов и незаметно внести регрессию;
потратить время на рефакторинг, хотя время было только на оптимизацию;
исправить все очевидные на глаз проблемы производительности, не получить заметного результата, решить что наверное просто Ruby слишком медленный для этой задачи, демотивироваться и разочароваться в попытках оптимизации

Советы

Найдите объём данных, на которых программа отрабатывает достаточно быстро - это позволит вам выстроить фидбек-луп; если улучшите метрику для части данных, то улучшите и для полного объёма данных;
Попробуйте прикинуть ассимтотику роста времени работы в зависимости от объёма входных данных (попробуйте объём x, 2x, 4x, 8x)
Оцените, как долго программа будет обрабатывать полный обём данных
Оцените, сколько времени занимает работа GC (попробовав отключить его на небольшом объёме данных)
Вкладывайтесь в удобство работы и скорость получения обратной связи, сделайте себе эффективный фидбек-луп

Советы по профилированию и измерению метрики

Задайте простую и понятную метрику для оптимизируемой системы
При профилировании лучше выключать GC (он может вносить непредсказуемые замедления в рандомные части программы)
Но не отключайте GC при вычислении метрики (в результате мы хотим, чтобы программа работала с включенным GC, значит без него мы будем мерить не то что надо)
Отключайте профилировщики при вычислении метрики (они замедляют работу системы)
Не замеряйте время профилировщиком (при замерах он вообще должен быть отключен)

Совет: как посчитать кол-во строк в файле

wc -l data_large.rb # (3250940)  total line count

Совет: как создать меньший файл из большего, оставив перевые N строк

head -n N data_large.txt > dataN.txt # create smaller file from larger (take N first lines)

Что можно делать

рефакторить код
рефакторить/дописывать тесты
разбивать скрипт на несколько файлов

Что нужно делать

исследовать предложенную вам на рассмотрение систему
построить фидбек-луп, который позволит вам быстро тестировать гипотезы и измерять их эффект
применить инструменты профилирования CPU, чтобы найти главные точки роста
выписывать в case-study несколько пунктов: каким профилировщиком вы нашли точку роста, как её оптимизировали, какой получили прирост метрики, как найденная проблема перестала быть главной точкой роста;

Что не нужно делать

переписывать с нуля
забивать на выстраивание фидбек-лупа
вносить оптимизации по наитию, без профилировщика и без оценки эффективности

Основная польза задания

Главная польза этого задания - попрактиковаться в применении грамотного подхода к оптимизации, почуствовать этот процесс:

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

Checklist

Советую использовать все рассмотренные в лекции инструменты хотя бы по разу - попрактикуйтесь с ними, научитесь с ними работать.

Главное

Нужно потренироваться методично работать по схеме с фидбек-лупом:

построили отчёт каким-то из профилировщиков
осознали его
поняли, какая самая большая точка роста
внесли минимальные изменения, чтобы использовать только эту точку роста
вычислили метрику - оценили, как изменение повлияло на метрику
перестроили отчёт, убедились, что проблема решена
записали полученные результаты
закоммитились
перешли к следующей итерации

alex9spiridonov/rails-optimization-task1

Note