:py:mod:`medcat.utils.regression.regression_checker`
====================================================

.. py:module:: medcat.utils.regression.regression_checker


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


Functions
~~~~~~~~~

.. autoapisummary::

   medcat.utils.regression.regression_checker.main



Attributes
~~~~~~~~~~

.. autoapisummary::

   medcat.utils.regression.regression_checker.logger
   medcat.utils.regression.regression_checker.parser


.. py:data:: logger

   

.. py:function:: main(model_pack_dir, test_suite_file, total = None, phrases = False, hide_empty = False, hide_failures = False, jsonpath = None, overwrite = False, jsonindent = None)

   Check test suite against the specifeid model pack.

   :param model_pack_dir: The path to the model pack
   :type model_pack_dir: Path
   :param test_suite_file: The path to the test suite YAML
   :type test_suite_file: Path
   :param total: The total number of (sub)cases to be tested (for progress bar)
   :type total: Optional[int]
   :param phrases: Whether to show per-phrase information in a report
   :type phrases: bool
   :param hide_empty: Whether to hide empty cases in a report
   :type hide_empty: bool
   :param hide_failures: Whether to hide failures in a report
   :type hide_failures: bool
   :param jsonpath: The json path to save the report to (if specified)
   :type jsonpath: Optional[Path]
   :param overwrite: Whether to overwrite the file if it exists. Defaults to False
   :type overwrite: bool
   :param jsonindent: The indentation for json objects. Defaults to 0
   :type jsonindent: int

   :raises ValueError: If unable to overwrite file or folder does not exist.


.. py:data:: parser