redback.model_metadata.ModelMetadata

class redback.model_metadata.ModelMetadata(name: str, model_type: str, source_module: str | None = None, output_formats: tuple[str, ...] = (), default_output_format: str | None = None, required_kwargs: tuple[str, ...] = (), optional_dependencies: tuple[str, ...] = (), has_prior: bool = False, is_public: bool = True, supports_extinction: bool = False, supports_constraints: bool = False, speed: str = 'unknown', max_time_days: float | None = None)

Bases: object

Structured metadata for a redback model function.

__init__(name: str, model_type: str, source_module: str | None = None, output_formats: tuple[str, ...] = (), default_output_format: str | None = None, required_kwargs: tuple[str, ...] = (), optional_dependencies: tuple[str, ...] = (), has_prior: bool = False, is_public: bool = True, supports_extinction: bool = False, supports_constraints: bool = False, speed: str = 'unknown', max_time_days: float | None = None) → None

__call__(**kwargs)

Call self as a function.

Methods

__init__(name, model_type[, source_module, ...])

Attributes

default_output_format
has_prior
is_public
max_time_days
optional_dependencies
output_formats
required_kwargs
source_module
speed
supports_constraints
supports_extinction
name
model_type