Skip to content

IrinaGoloshchapova/ml_system_design_doc_ru

Repository files navigation

ML System Design Doc - Reliable ML

Шаблон документа для дизайна ML-систем от телеграм-канала Reliable ML

Что такое ML System Design Doc

ML System Design документ - это по сути сводный план по построению системы машинного обучения для решения конкретного запроса бизнеса в вашей компании. Его стоит применять на этапе дизайна вашей системы, чтобы в итоге ваше решение было полезным для бизнеса, а именно: могло быть внедрено, работало после внедрения и приносило реальную пользу.

А для того, чтобы этот план было проще построить, и чтобы итоговая система, действительно, приводила к результату, мы в сообществе Reliable ML разработали шаблон такого документа.

Шаблон был успешно адаптирован уже в более 10 крупных компаниях на российском рынке, а также внедрен Университетом ИТМО в программу онлайн-магистратуры по ML-инженерии как ключевой инструмент планирования ML-проектов.

image

Зачем нужен ML System Design Doc

Дизайн-документ, созданный на этапе проектирования системы, помогает Data Science подразделению:

  • Структурировать собственные мысли: БТ, архитектура решения, результат, применение
  • Задать все критические вопросы бизнесу, уточнить бизнес-требования
  • Понять бизнес-процесс и нюансы применения ML-системы
  • Понять, что реализация проекта возможна и какие ожидают трудности
  • Синхронизировать ожидания технической и бизнес-команд
  • Установить стандарты работы

Как составить ML System Design Doc

  • Скачать шаблон документа от Reliable ML и загрузить его в общее рабочее пространство вашей компании или сделать форк репозитория и работать в нем
  • Прочитать краткие рекомендации по процессу заполнения документа (workflow) - здесь.
  • Посмотреть детальный доклад о том, что такое ML System Design Doc и о том, как, когда и зачем его составлять - тут.
  • Если остались вопросы - заглянуть в раздел допматериалов.
  • Приступить к работе!

Примеры дизайн-документов по шаблону Reliable ML

Как обратиться в Reliable ML за поддержкой

  • Команда Reliable ML готова помочь вам с работой над составлением дизайн-документа - включая ревью самой системы.
  • В приоритете проекты, которые готовы выложить финальный документ в открытый доступ (без NDA части) - как в разделе выше.
  • Пишите @irina_goloshchapova и @promsoft

Материалы для дополнительного погружения в тему

Материалы по ML System Design от Reliable ML

Международная практика по ML System Design Docs