HuggingFace

To use a ML model hosted on HuggingFace, specify the huggingface.co path in from along with the files to include.

Example:

models:
  - from: huggingface:huggingface.co/spiceai/darts:latest
    name: hf_model
    files:
      - path: model.onnx
    datasets:
      - taxi_trips

from Format

The from key follows the following regex format:

\A(huggingface:)(huggingface\.co\/)?(?<org>[\w\-]+)\/(?<model>[\w\-]+)(:(?<revision>[\w\d\-\.]+))?\z

Examples

• huggingface:username/modelname: Implies the latest version of modelname hosted by username.
• huggingface:huggingface.co/username/modelname:revision: Specifies a particular revision of modelname by username, including the optional domain.

Specification

1. Prefix: The value must start with huggingface:.
2. Domain (Optional): Optionally includes huggingface.co/ immediately after the prefix. Currently no other Huggingface compatible services are supported.
3. Organization/User: The HuggingFace organization (org).
4. Model Name: After a /, the model name (model).
5. Revision (Optional): A colon (:) followed by the git-like revision identifier (revision).

Access Tokens

Access tokens can be provided for Huggingface models in two ways:

1. In the Huggingface token cache (i.e. ~/.cache/huggingface/token). Default.
2. Via model params (see below).

models:
  - name: llama_3.2_1B
    from: huggingface:huggingface.co/meta-llama/Llama-3.2-1B
    params:
      hf_token: ${ secrets:HF_TOKEN }

Limitations

• ML models currently only support ONNX file format.