viqa.utils.export_metadata

viqa.utils.export_metadata(metrics, metrics_parameters, file_path, file_name='metadata.txt')[source]

Export the metadata (custom parameters and package version) to a txt file.

Parameters:
  • metrics (list) – List of metric instances.

  • metrics_parameters (list) – List of dictionaries containing the parameters for the metrics.

  • file_path (str) – Path to the directory where the txt file should be saved.

  • file_name (str, default='metadata.txt') – Name of the txt file. Default is ‘metadata.txt’.

Notes

Attention

The txt file will be overwritten if it already exists.