rinkorn/dummy-model

Описание модели

Описание модели предоставляет основные сведения о модели. Это включает архитектуру, версию, была ли она представлена в какой-либо научной статье, доступна ли оригинальная реализация, автор и общая информация о модели. Здесь следует указать любые авторские права. Общая информация о процедурах обучения, параметрах и важных оговорках также может быть упомянута в этом разделе.

Предполагаемые использования и ограничения

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

Как использовать

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

Тренировочные данные

В этой части следует указать, на каком(их) наборе(ах) данных модель была обучена. Краткое описание набора(ов) данных также приветствуется.

Процедура обучения

В этом разделе вы должны описать все соответствующие аспекты обучения, которые полезны с точки зрения воспроизводимости. Это включает любую предварительную обработку и пост-обработку, которые были выполнены на данных, а также такие детали, как количество эпох обучения модели, размер партии, скорость обучения и т. д.

Переменные и метрики

Здесь следует описать метрики, которые вы используете для оценки, и различные факторы, которые вы измеряете. Упоминание о том, какие метрики были использованы, на каком наборе данных и каком разделе данных модель была обучена, позволяет легко сравнивать производительность вашей модели с производительностью других моделей. Эти данные должны быть основаны на предыдущих разделах, таких как предполагаемые пользователи и варианты использования.

Результаты оценки

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