perun.api.decorator¶

Decorator module.

Attributes¶

Functions¶

`monitor`(→ Callable)	Decorate function to monitor its energy usage.
`perun`(→ Callable)	Decorate function to monitor its energy usage.
`register_callback`(→ None)	Register a function to run after perun has finished collection data.

Module Contents¶

perun.api.decorator.log[source]¶

perun.api.decorator.monitor(region_name: str | None = None) → Callable[source]¶: Decorate function to monitor its energy usage.

perun.api.decorator.perun(configuration_file: str = './.perun.ini', **conf_kwargs: Any) → Callable[source]¶: Decorate function to monitor its energy usage.

perun.api.decorator.register_callback(func: Callable[[perun.data_model.data.DataNode], None]) → None[source]¶

Register a function to run after perun has finished collection data.

Parameters:: func (Callable[[DataNode], None]) – Function to be called.