Identity

This hook just passes the inputs to the outputs without any modification.

For someone who wants to understand how hooks work or wants to implement their own hook, this is the best point to start, as it is the simplest hook possible.

It is also very useful for testing and debugging.

Installation

To install this hook along with the metatrain package, run:

pip install metatrain[hook-identity]

where the square brackets indicate that you want to install the optional dependencies required for the identity hook.

Hook hyperparameters

The default hyperparameters for this hook are:

identity:
  inputs: null
  outputs: null

and here is the documentation for each hyperparameter:

Hypers.inputs: str | list[str] | None = None

The names of the inputs to be passed to the outputs.

If None, they will be set as mtt::aux::identity::{output_name.replace('mtt::', '')} for each output name.

Hypers.outputs: str | list[str] | None = None

The names of the outputs to be produced by the hook.

References