mmgp.postprocessing
===================

.. py:module:: mmgp.postprocessing


Functions
---------

.. autoapisummary::

   mmgp.postprocessing.compute_metrics
   mmgp.postprocessing.export_predictions


Module Contents
---------------

.. py:function:: compute_metrics(configuration: dict, problem: plaid.problem_definition.ProblemDefinition) -> dict

   Compute and print various metrics for a given ProblemDefinition instance and configuration settings.

   :param configuration: A dictionary containing various parameters and settings for the metric computation. It should include the following keys:
                         - 'generated_data_folder' (str): A string representing the folder where the predicted data is stored.
                         - 'regression' (dict): A dictionary containing regression-related parameters with the following keys:
   :type configuration: dict
   :param problem: An instance of the ProblemDefinition class containing problem-specific information, including output scalars and fields.
   :type problem: ProblemDefinition

   .. caution:: This function will load all the predicted data. Make sure it has been created and is located correctly.


.. py:function:: export_predictions(configuration: dict, problem: plaid.problem_definition.ProblemDefinition) -> plaid.containers.dataset.Dataset