Быстрый старт

Если артефакт относительно небольшой, его можно разместить "рядом" с исходным кодом. Под небольшим мы понимаем файл размером до 10мб. Большие размеры будут замедлять загрузку информации о модели, поэтому нужно использовать второй способ.

mmf.artifact('model') # (1)

with open('model', 'br') as f:
    model = pickle.load(f)

1. Помечаем файл 'model' как артефакт

Альтернативный способ (на одну строку меньше, смысл не меняется)

with mmf.artifact('model', 'br') as f: # (1)
    model = pickle.load(f)

1. with mmf.artifact полностью заменяет with open без потери функционала.

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

@mmf.artifact('model') # (1)
def model(): # (2)
    with open('model', 'br') as f:
        return pickle.load(f) # (3) 

1. Декоратор, помечающий функцию как загрузчик модели
2. Функция, которая отвечает за загрузку модели
3. Важно, модель теперь не записывается в переменную, а возвращается как результат работы функции model()

MMF поддерживает работу с табличными данными. Автоматически преобразует поддерживаемые типы в DataFrame.

@mmf.target(returns=mmf.DataFrame(format=mmf.XLSX)) # (1)
def score(
    data = mmf.DataFrame(description='Данные для модели') # (2)
):
    return model.predict(data) # (3)

1. Декоратор, помечающий функцию как target. Если функция возвращает какой-то результат, тип результата нужно пометить с помощью параметра returns, в данном примере модель возвращает DataFrame, при этом MMF преобразует его в формат .XLSX перед отправкой пользователю.
2. Дескриптор, помогающий MMF понять, какие данные ожидаются от пользователя. Подробнее про дескрипторы
3. Вызов модели. Независимо от того, как был оформлен артефакт model, для таргета - это всегда один и тот же объект, те в нашем примере - результат работы pickle.load

Работа с данными в формате объектов (python dict). MMF может принимать от пользователя json, xml, protobuf и автоматически преобразовывать их в dict.

@mmf.target(returns=mmf.Dict(format=mmf.JSON)) # (1)
def score(
    data = mmf.Dict(description='Данные для модели в формате JSON') # (2)
):
    return model.predict(data)

1. В данном случае мы сообщаем MMF, что модель возвращает данные как dict и просим MMF по-умолчанию конвертировать его в JSON.
2. Дескриптор, указывающий на использование данных в формате dict. MMF автоматически распакует json-совместимый объект, полученный от клиента. Для распаковки используется высокопроизводительная библиотека orjson

MMF способен работать с любыми данными, в том числе смешивать разные типы. На примере работы с изображением:

@mmf.target(returns=mmf.String()) # (1)
def score(
    img = mmf.Img( # (2)
        format='rgb', 
        description='Файл изображения, совместимый с opencv'
    ), 
    model_id = mmf.String( # (3)
        description='ID модели, которую нужно использовать для классификации'
    ),
):
    return model[model_id].predict(data) # (4)

1. Сообщаем, что модель возвращает строку
2. На вход ожидаем изображение. При этом MMF автоматически преобразует его в numpy-массив, в данном случае в формате rgb.
3. Дополнительный параметр - id модели, в этом вымышленном сценарии у нас есть несколько моделей, которые могут классифицировать изображение
4. Модель возвращает рассчитанный класс как текст.