apache_beam.ml.anomaly.specifiable module

A module that provides utilities to turn a class into a Specifiable subclass.

class apache_beam.ml.anomaly.specifiable.Spec(type: str, config: ~typing.Dict[str, ~typing.Any] | None = <factory>)

Bases: object

Dataclass for storing specifications of specifiable objects. Objects can be initialized using the data in their corresponding spec.

type: str

A string indicating the concrete Specifiable class

config: Dict[str, Any] | None

An optional dictionary of keyword arguments for the __init__ method of the class. If None, when we materialize this Spec, we only return the class without instantiate any objects from it.

class apache_beam.ml.anomaly.specifiable.Specifiable(*args, **kwargs)

Bases: Protocol

Protocol that a specifiable class needs to implement.

classmethod spec_type() → str

classmethod from_spec(spec: Spec, _run_init: bool = True) → Self | type[Self]

Generate a Specifiable subclass object based on a spec.

Parameters:

• spec – the specification of a Specifiable subclass object

• _run_init – whether to call __init__ or not for the initial instantiation

Returns:

the Specifiable subclass object

Return type:

Self

to_spec() → Spec

Generate a spec from a Specifiable subclass object.

Returns:

The specification of the instance.

Return type:

Spec

run_original_init() → None

Invoke the original __init__ method with original keyword arguments

classmethod unspecifiable() → None

Resume the class structure prior to specifiable

apache_beam.ml.anomaly.specifiable.specifiable(my_cls: None = None, /, *, spec_type: str | None = None, on_demand_init: bool = True, just_in_time_init: bool = True) → Callable[[T], T]

apache_beam.ml.anomaly.specifiable.specifiable(my_cls: T, /, *, spec_type: str | None = None, on_demand_init: bool = True, just_in_time_init: bool = True) → T

A decorator that turns a class into a Specifiable subclass by implementing the Specifiable protocol.

To use the decorator, simply place @specifiable before the class definition:

@specifiable
class Foo():
  ...

For finer control, the decorator can accept arguments:

@specifiable(spec_type="My Class", on_demand_init=False)
class Bar():
  ...

Parameters:

• spec_type – The value of the type field in the Spec of a Specifiable subclass. If not provided, the class name is used. This argument is useful when registering multiple classes with the same base name; in such cases, one can specify spec_type to different values to resolve conflict.

• on_demand_init – If True, allow on-demand object initialization. The original __init__ method will be called when _run_init=True is passed to the object’s initialization function.

• just_in_time_init – If True, allow just-in-time object initialization. The original __init__ method will be called when the first time an attribute is accessed.