Logging functions

LoggingFunction base class

To develop custom loggers, we need to write a class that inherits from the base class LoggingFunction. Then, those custom loggers can be mapped to events of the user choice in the parameter mapping of the PyPads class.

Pre and Post run loggers

Another type of logging functions supported by Pypads is the pre/post run loggers which are executed before and after the run execution respectively.

• Pre Run loggers

class pypads.app.injections.run_loggers.PreRunFunction(*args, **kwargs)

This class should be used to define new pre run functions

_call(pads, *args, **kwargs)

Function where to add you custom code to execute before starting or ending the run.

Parameters:pads – the current instance of PyPads.

_check_dependencies()

Raise error if dependencies are missing.

static _needed_packages()

Overwrite this to provide your package names. :return: List of needed packages by the logger.

• Post Run loggers

class pypads.app.injections.run_loggers.PostRunFunction(*args, **kwargs)

This class should be used to define new post run functions

_call(pads, *args, **kwargs)

Function where to add you custom code to execute before starting or ending the run.

Parameters:pads – the current instance of PyPads.

_check_dependencies()

Raise error if dependencies are missing.

static _needed_packages()

Overwrite this to provide your package names. :return: List of needed packages by the logger.

Mlflow autolog (experimental)

Pypads also support mlflow autologging functionalities. More on that can be found at MLflow.

class pypads.injections.loggers.mlflow.mlflow_autolog.MlflowAutologger(*args, order=-1, **kwargs)

MlflowAutologger is the intergration of the mlflow autologging functionalities into PyPads tracking system.

__call_wrapped__(ctx, *args, _args, _kwargs, _pypads_autologgers=None, _pypads_env=<class 'pypads.injections.analysis.call_tracker.LoggingEnv'>, **kwargs)

Note

Experimental: This method may change or be removed in a future release without warning.

Function used to enable autologgers of mlflow.

identity

Return the identity of the logger. This should be unique for the same functionality across multiple versions. :return: