audEERING audmodel
v1.3.1

Getting started

  • Installation
  • Authentication
  • Usage

API Documentation

  • audmodel
    • author()
    • config
    • date()
    • default_cache_root()
    • exists()
    • header()
    • latest_version()
    • legacy_uid()
    • load()
    • meta()
    • name()
    • parameters()
    • publish()
    • Repository
    • subgroup()
    • uid()
    • update_meta()
    • url()
    • version()
    • versions()
  • Index

Development

  • Contributing
  • Changelog
audmodel
  • »
  • audmodel »
  • header()
  • GitLab

header()¶

audmodel.header(uid, *, cache_root=None, verbose=False)[source]¶

Load model header.

Parameters
  • uid (str) – unique model ID or short ID for latest version

  • cache_root (Optional[str]) – cache folder where models and headers are stored. If not set audmodel.default_cache_root() is used

  • verbose (bool) – show debug messages

Raises
  • audbackend.BackendError – if connection to repository on backend cannot be established

  • RuntimeError – if model does not exist on backend

Return type

dict[str, object]

Returns

dictionary with header fields

Examples

>>> d = header("d4e9c65b-3.0.0")
>>> print(yaml.dump(d))
author: Calvin and Hobbes
date: 1985-11-18
name: torch
parameters:
  model: cnn10
  data: emodb
  feature: melspec
  sampling_rate: 16000
subgroup: audmodel.dummy.cnn
version: 3.0.0
Next Previous

  • Data
  • Docs
  • Infra
  • Models
  • Research
  • Tools

Built with Sphinx on 2025/03/05 using the audEERING theme

© 2019-2025 audEERING GmbH