kozmoserver-huggingface 0.1.0.dev1

HuggingFace runtime for KozmoServer

HuggingFace runtime for KozmoServer

This package provides a KozmoServer runtime compatible with HuggingFace Transformers.

Usage

You can install the runtime, alongside kozmoserver, as:

pip install kozmoserver kozmoserver-huggingface

For further information on how to use KozmoServer with HuggingFace, you can check out this worked out example.

Content Types

The HuggingFace runtime will always decode the input request using its own built-in codec. Therefore, content type annotations at the request level will be ignored. Note that this doesn't include input-level content type annotations, which will be respected as usual.

Settings

The HuggingFace runtime exposes a couple extra parameters which can be used to customise how the runtime behaves. These settings can be added under the parameters.extra section of your model-settings.json file, e.g.

---
emphasize-lines: 5-8
---
{
  "name": "qa",
  "implementation": "kozmoserver_huggingface.HuggingFaceRuntime",
  "parameters": {
    "extra": {
      "task": "question-answering",
      "optimum_model": true
    }
  }
}

These settings can also be injected through environment variables prefixed with `KOZMOSERVER_MODEL_HUGGINGFACE_`, e.g.

```bash
KOZMOSERVER_MODEL_HUGGINGFACE_TASK="question-answering"
KOZMOSERVER_MODEL_HUGGINGFACE_OPTIMUM_MODEL=true
```

Loading models

Local models

It is possible to load a local model into a HuggingFace pipeline by specifying the model artefact folder path in parameters.uri in model-settings.json.

HuggingFace models

Models in the HuggingFace hub can be loaded by specifying their name in parameters.extra.pretrained_model in model-settings.json.

If `parameters.extra.pretrained_model` is specified, it takes precedence over `parameters.uri`.

Reference

You can find the full reference of the accepted extra settings for the HuggingFace runtime below:

.. autopydantic_settings:: kozmoserver_huggingface.settings.HuggingFaceSettings