Skip to content

StubLoader

Bases: IDMixin

Vector loader for vectors with no layers

Experimental

StubLoader is experimental since 1.4.0 and may change without notice.

Implements the VectorLoader protocol.

PARAMETER DESCRIPTION
delay

Delay in seconds

TYPE: float DEFAULT: 0.0

jitter

Jitter in seconds

TYPE: float DEFAULT: 0.0

id property

RETURNS DESCRIPTION
uuid.UUID

ID

from_config classmethod

Creates a stub loader from the configuration.

PARAMETER DESCRIPTION
config

Configuration

TYPE: StubLoaderConfig

RETURNS DESCRIPTION
StubLoader

Stub loader

__call__

Loads a vector with no layers.

RETURNS DESCRIPTION
Vector

Vector


StubLoaderConfig

Bases: pydantic.BaseModel

Configuration for the from_config class method of StubLoader

Usage

You can create the configuration from a config file.

config.yaml
package: 'aviary'
name: 'StubLoader'
config:
  delay: 0.
  jitter: 0.
ATTRIBUTE DESCRIPTION
delay

Delay in seconds - defaults to 0.

TYPE: float

jitter

Jitter in seconds - defaults to 0.

TYPE: float