Publish team projects. Improve project checkpoint and task description.
This commit is contained in:
@@ -10,7 +10,7 @@
|
||||
|
||||
## Сокращённый запуск
|
||||
|
||||
Укажите минимальные требования и команды, которые воспроизводят небольшой сквозной пример на обычной машине.
|
||||
К первой контрольной точке укажите требования к окружению и команды технических проверок или ссылку на них в `nis/checkpoints/01.md`. Ко второй точке добавьте команды запуска небольшого сквозного примера на обычной машине.
|
||||
|
||||
```text
|
||||
команды запуска
|
||||
@@ -18,7 +18,7 @@
|
||||
|
||||
## Навигация
|
||||
|
||||
- [Детализация проекта](nis/project.md)
|
||||
- [Описание проекта](nis/project.md)
|
||||
- [План эксперимента](nis/experiment-plan.md)
|
||||
- [Контрольная точка 1](nis/checkpoints/01.md)
|
||||
- [Контрольная точка 2](nis/checkpoints/02.md)
|
||||
|
||||
@@ -1,29 +1,23 @@
|
||||
# Контрольная точка 1
|
||||
|
||||
## Краткий результат
|
||||
|
||||
[Что проверено и что зафиксировано по итогам этапа.]
|
||||
|
||||
## Проверенные технические предпосылки
|
||||
|
||||
[Сборка, минимальный запуск, прототип, допущения и проверки выбранного пути.]
|
||||
|
||||
## Фактические ресурсы и измеримость показателей
|
||||
|
||||
[Доступные ресурсы и свидетельства того, что требуемые показатели можно измерить.]
|
||||
|
||||
## Инструкция и воспроизводимые свидетельства
|
||||
|
||||
[Команды и ссылки на журналы, тесты, данные или другие материалы.]
|
||||
|
||||
## Ссылки на детализацию и план эксперимента
|
||||
|
||||
- [Детализация проекта](../project.md)
|
||||
- [Описание проекта](../project.md)
|
||||
- [План эксперимента](../experiment-plan.md)
|
||||
|
||||
## Открытые риски и следующие действия
|
||||
## Краткий итог
|
||||
|
||||
[Риски, действия, сроки и ответственные.]
|
||||
[Коротко: что удалось проверить и какие проблемы остались.]
|
||||
|
||||
## Технические проверки
|
||||
|
||||
[Для каждой проверки укажите, что проверяли, команду запуска или ссылку на инструкцию, ожидаемый и полученный результат. Приложите ссылки на материалы проверки. Здесь же покажите, что данные для основных метрик доступны: подойдёт пробный замер, журнал или расчёт.]
|
||||
|
||||
## Ресурсы
|
||||
|
||||
[Какие ресурсы доступны и хватает ли их для запланированной работы. Если конфигурация уже описана в плане эксперимента, дайте ссылку на неё.]
|
||||
|
||||
## Риски и следующие шаги
|
||||
|
||||
[Что может помешать работе, что вы будете делать, кто отвечает и к какому сроку. Уточнения настроек эксперимента можно указать ссылкой на план.]
|
||||
|
||||
## Ответственность участников
|
||||
|
||||
|
||||
@@ -2,31 +2,31 @@
|
||||
|
||||
## Краткий результат
|
||||
|
||||
[Какой сквозной сценарий работает.]
|
||||
[Какой сценарий из задания работает: что подаётся на вход, что выполняется и какой результат получен.]
|
||||
|
||||
## Запуск и конфигурация
|
||||
|
||||
[Команды, версии, параметры и использованные ресурсы.]
|
||||
[Ссылка на команды запуска в README.md. Укажите использованные версии, параметры и ресурсы или дайте ссылку на конфигурацию.]
|
||||
|
||||
## Демонстрация
|
||||
|
||||
[Ссылка на короткую запись.]
|
||||
[Ссылка на короткую запись, показывающую запуск сценария и полученный результат.]
|
||||
|
||||
## Исходные и обработанные данные
|
||||
|
||||
[Ссылки на пример измерений и полученную таблицу или график.]
|
||||
[Ссылки на исходные измерения, команды их обработки и полученную таблицу или график. Кратко поясните, что они показывают.]
|
||||
|
||||
## Проверка корректности
|
||||
|
||||
[Тесты, инварианты, эталоны; для модели — проверка адекватности.]
|
||||
[Что проверили, какой результат ожидали и что получили. Дайте ссылки на команды и результаты проверок. Для симулятора или модели покажите сравнение с выбранным эталоном и объясните расхождения.]
|
||||
|
||||
## Упрощения и отсутствующие обязательные части
|
||||
|
||||
[Что пока ограничено или не реализовано.]
|
||||
[Какие упрощения действуют в показанном сценарии и что из обязательной работы ещё не готово. Можно сослаться на актуальное описание проекта.]
|
||||
|
||||
## Риски и следующие действия
|
||||
|
||||
[Риски, действия, сроки и ответственные.]
|
||||
[Что может помешать работе, что вы будете делать, кто отвечает и к какому сроку.]
|
||||
|
||||
## Ответственность участников
|
||||
|
||||
|
||||
@@ -2,19 +2,19 @@
|
||||
|
||||
## Краткий результат
|
||||
|
||||
[Какое сравнение выполнено.]
|
||||
[На какой вопрос задания отвечает выполненное сравнение и что удалось выяснить.]
|
||||
|
||||
## Метод и baseline
|
||||
|
||||
[Сопоставимые варианты, входы и конфигурации.]
|
||||
[Что сравнивали, на каких входах и с какими настройками. Объясните различия конфигураций и почему сравнение корректно. Дайте ссылки на команды запуска и конфигурации.]
|
||||
|
||||
## Исходные и обработанные данные
|
||||
|
||||
[Ссылки на измерения, повторы, таблицу или график.]
|
||||
[Ссылки на измерения каждого запуска, команды обработки и таблицу или график. Укажите число повторов и покажите разброс результатов. Если измерения детерминированные, поясните это.]
|
||||
|
||||
## Предварительная интерпретация
|
||||
|
||||
[Вывод, сопоставление со статьёй, расхождения, альтернативные объяснения и ограничения.]
|
||||
[Что показывают данные и как результат соотносится с конкретным результатом статьи. Как на сравнение влияют различия оборудования, данных и настроек. Какие объяснения расхождений подтверждены, какие ещё нужно проверить и чего по этим данным заключить нельзя.]
|
||||
|
||||
## Оставшаяся обязательная работа
|
||||
|
||||
@@ -22,7 +22,7 @@
|
||||
|
||||
## Возможное самостоятельное продолжение
|
||||
|
||||
[Отдельный вопрос или технический результат сверх обязательной работы.]
|
||||
[Если планируете продолжение, опишите вопрос или результат сверх обязательного задания. Иначе укажите, что пока не планируете его.]
|
||||
|
||||
## Ответственность участников
|
||||
|
||||
|
||||
@@ -6,28 +6,24 @@
|
||||
|
||||
## Сравниваемые варианты и baseline
|
||||
|
||||
[Основной метод, baseline и условия сопоставимости.]
|
||||
[Какой baseline из задания вы используете и чем сравниваемые варианты отличаются друг от друга. Что будет одинаковым в их запусках: входные данные, доступные ресурсы и остальные условия сравнения.]
|
||||
|
||||
## Данные или нагрузки
|
||||
|
||||
[Источники, подготовка, размеры и правила формирования выборок.]
|
||||
|
||||
## Конфигурации и параметры
|
||||
## Конфигурации и план запусков
|
||||
|
||||
[Среда, версии, ресурсы, фиксированные и изменяемые параметры.]
|
||||
[Среда, версии и ресурсы. Какие параметры остаются постоянными, какие меняются и какие сочетания значений вы проверите. Укажите число повторов и порядок запусков. Если настройки зависят от пробных запусков, опишите, как и когда вы их выберете.]
|
||||
|
||||
## Метрики
|
||||
|
||||
[Определение, единицы измерения и способ сбора каждой метрики.]
|
||||
|
||||
## Серии и повторы
|
||||
|
||||
[Матрица экспериментов, число повторов и порядок запусков.]
|
||||
|
||||
## Проверка корректности
|
||||
|
||||
[Тесты, инварианты, эталоны и проверки адекватности.]
|
||||
[Как вы будете проверять правильность работы реализации: тесты, инварианты, сравнение с эталоном. Для модели опишите, как проверите соответствие моделируемой системе.]
|
||||
|
||||
## Обработка и анализ
|
||||
|
||||
[Команды, статистическая обработка, таблицы, графики и правила интерпретации.]
|
||||
[Как обработаете данные, обобщите результаты повторов и покажете их разброс. Какие таблицы или графики построите и как по ним ответите на проверяемый вопрос. Команды обработки добавляйте по мере реализации.]
|
||||
|
||||
@@ -5,9 +5,7 @@
|
||||
- Команда:
|
||||
- Проектное задание:
|
||||
|
||||
## Оцениваемая версия
|
||||
|
||||
- Полный хеш коммита:
|
||||
Полный хеш оцениваемого коммита укажите в описании итогового PR/MR после публикации коммита.
|
||||
|
||||
## Ключевой результат
|
||||
|
||||
|
||||
@@ -1,25 +1,21 @@
|
||||
# Детализация проекта
|
||||
# Описание проекта
|
||||
|
||||
## Назначенное задание
|
||||
|
||||
[Ссылка на карточку задания и краткое описание обязательного результата.]
|
||||
[Ссылка на карточку задания.]
|
||||
|
||||
## Выбранный технический путь
|
||||
|
||||
[Авторский артефакт, самостоятельная реализация, симулятор или их сочетание.]
|
||||
[Какой путь из предусмотренных заданием вы используете: авторский артефакт, самостоятельную реализацию, симулятор или их сочетание.]
|
||||
|
||||
## Обязательный результат
|
||||
## Что будет сделано и как это проверить
|
||||
|
||||
[Состав реализации и результат, который должен быть проверяемым к итоговой сдаче.]
|
||||
[Перечислите, что должно быть готово к концу проекта по назначенному заданию: что вы реализуете, какие проверки и эксперименты проведёте, какие материалы с результатами и их разбором подготовите. Для каждого пункта укажите, как проверить его выполнение. Например: «Восстановление после сбоя проверяется тестом на пропуски и дубликаты; время восстановления сравнивается с baseline, измерения и их разбор представлены в отчёте».]
|
||||
|
||||
## Поддерживаемые сценарии
|
||||
|
||||
[Входы, режимы работы и границы применимости.]
|
||||
[Опишите ситуации, которые будете исследовать в проекте: какие данные или нагрузки поступают на вход, что происходит во время работы и какого поведения вы ожидаете. Например: «После сохранения контрольной точки один обработчик останавливается. Система восстанавливает его состояние и продолжает обработку потока без потерь и повторного учёта данных». Укажите ограничения сценариев, например число узлов или рассматриваемые виды отказов.]
|
||||
|
||||
## Упрощения
|
||||
|
||||
[Принятые упрощения и их влияние на допустимые выводы.]
|
||||
|
||||
## Критерии завершённости
|
||||
|
||||
[Наблюдаемые условия, по которым можно проверить выполнение обязательной работы.]
|
||||
[Принятые упрощения и их влияние на выводы. Если меняется обязательный объём, укажите согласованное изменение и ссылку на обновлённую карточку задания.]
|
||||
|
||||
@@ -4,24 +4,26 @@
|
||||
|
||||
[Окружение, версии, ресурсы и параметры сравниваемых вариантов.]
|
||||
|
||||
## Исходные данные
|
||||
## Входные данные и измерения
|
||||
|
||||
[Расположение файлов, формат, происхождение и контрольные суммы.]
|
||||
[Где лежат входные данные и исходные измерения каждого запуска. Укажите их формат, происхождение и контрольные суммы; свяжите измерения с вариантом, конфигурацией и номером повтора.]
|
||||
|
||||
## Обработанные данные
|
||||
|
||||
[Расположение таблиц, графиков и промежуточных файлов.]
|
||||
|
||||
## Построение результатов
|
||||
## Повторение экспериментов и обработка данных
|
||||
|
||||
[Команды основных серий или ссылка на инструкцию. Отдельно укажите команды, которые строят таблицы и графики из сохранённых измерений.]
|
||||
|
||||
```text
|
||||
команды, которые строят итоговые таблицы и графики
|
||||
команды запуска и обработки
|
||||
```
|
||||
|
||||
## Внешние материалы
|
||||
|
||||
[Ссылки, условия доступа, версии и контрольные суммы материалов вне репозитория.]
|
||||
[Для материалов вне репозитория укажите ссылки, условия доступа, версии и контрольные суммы файлов. Если таких материалов нет, укажите это.]
|
||||
|
||||
## Ограничения воспроизводимости
|
||||
|
||||
[Ресурсные ограничения, недоступные материалы и допустимый сокращённый запуск.]
|
||||
[Что нужно для повторения полных серий, что проверяет сокращённый запуск и какие результаты он не воспроизводит. Если часть материалов недоступна публично, поясните, как преподаватель сможет их проверить.]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Состояние проекта
|
||||
|
||||
## Лучший полученный результат
|
||||
## Основной полученный результат
|
||||
|
||||
[Краткое описание и ссылки на проверяемые материалы.]
|
||||
|
||||
@@ -14,6 +14,6 @@
|
||||
|
||||
## План до итоговой сдачи
|
||||
|
||||
| Задача | Срок | Ответственный | Ожидаемое свидетельство |
|
||||
| Задача | Срок | Ответственный | Результат и способ проверки |
|
||||
|---|---|---|---|
|
||||
| | | | |
|
||||
|
||||
Reference in New Issue
Block a user