Руководство по версионированию ELL

v1.0.0

Версионирование ELL следует стандарту Semantic Versioning 2.0.0 и имеет формат xx.yy.nn. Номер версии влияет на

• цепочку инструментов ELL
• Python API ELL ("ELL API")
• сгенерированный API, который является результатом компиляции модели ("сгенерированный API"). В настоящее время это может быть либо C++ API, либо Python API.

xx - представляет номер основной версии.

yy - представляет номер дополнительной версии.

nn - представляет номер патч-версии.

Отсутствие компонента номера версии указывает на то, что он применим ко всем сериям версий, удовлетворяющим данному ограничению. Например, версия 2 означает все версии вида 2.yy.nn с использованием вышеупомянутого представления. Аналогично, версия 1.3 означает все версии вида 1.3.nn.Увеличение номера основной версии следует выполнять, когда

• добавляется значительная новая функция в цепочку инструментов ELL и демонстрируется новым учебником, если применимо
  • например, "Начало работы с обнаружением ключевых слов в аудио на Raspberry Pi" вызовет увеличение, но "Активное охлаждение Raspberry Pi 3" не вызовет, так как это не связано с цепочкой инструментов ELL.
• произошли значительные внутренние изменения в цепочке инструментов ELL
  • например, изменение используемых алгоритмов, которое приводит к значительному улучшению производительности сгенерированных моделей
• добавляется значительная функция в ELL API или сгенерированный API
• ELL API или сгенерированный API изменены таким образом, что они не совместимы с предыдущими версиями
• сделаны изменения, которые нарушают сериализацию модели ELLУвеличение номера дополнительной версии следует выполнять, когда
• поведение, которое видят пользователи, изменилось при компиляции моделей
  • такие вещи, как изменение способа (д)сериализации модели
  • новые типы моделей могут быть скомпилированы
  • например, изменение метода по умолчанию для конволюции, который выбирается, потребует увеличения.
• добавляются новые функции в ELL API или сгенерированный API, которые совместимы с предыдущими версияи

Увеличение номера патч-версии следует выполнять, когда

• произошли любые другие изменения в цепочке инструментов ELL, Python API или сгенерированном API
  • исправления ошибок, улучшения производительности, рефакторинг кода
• изменения в тестовом коде
• обновления скриптов, которые не влияют на использование ELL toolchain
• реформатирование кода для стилистических изменений
• обновления туториалов или документации, которые сводятся к исправлению опечаток или стилистическим изменениям

Обновление версии также может быть сделано вне вышеупомянутых причин как способ указать значительное развитие.Цель обратной совместимости ELL API состоит в поддержке кода, написанного против ELL API более ранней версии ELL. Пока основная версия ELL остаётся той же, код будет продолжать работать так, как задумано. Например, код, написанный против ELL v1.2 API, будет продолжать работать для ELL v1.8 API, но не для ELL v2.0 API.Цель обратной совместимости издаваемого API состоит в поддержке кода, написанного против издаваемого API, созданного более ранней версией ELL. Пока основная версия ELL остаётся той же, код будет продолжать компилироваться и работать так, как задумано. Например, код, написанный против издаваемого API модели, скомпилированной с v1.2 ELL toolchain, будет продолжать компилироваться и работать против издаваемого API модели, скомпилированной с v1.8 ELL toolchain, но не против издаваемого API модели (предполагая, что модель правильно обновлена), скомпилированной с v2.0 ELL toolchain.

Цель обратной совместимости ELL toolchain состоит в поддержке компиляции моделей, созданных более ранней версией ELL. Пока основная версия ELL остаётся той же, toolchain более новой версии ELL может компилировать модель, созданную для более ранней версии ELL. Обратите внимание, что поддержка совместимости вперёд не предусмотрена, то есть версия, использованная для создания модели, является минимальной требуемой версией ELL для компиляции модели.