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

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


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


Functions
~~~~~~~~~

.. autoapisummary::

   medcat.utils.regression.regression_checker.show_description
   medcat.utils.regression.regression_checker.main
   medcat.utils.regression.regression_checker.tuple3_parser



Attributes
~~~~~~~~~~

.. autoapisummary::

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


.. py:data:: logger

   

.. py:data:: DEFAULT_TEST_SUITE_PATH

   

.. py:function:: show_description()


.. py:function:: main(model_pack_dir, test_suite_file, phrases = False, hide_empty = False, examples_strictness_str = 'STRICTEST', jsonpath = None, overwrite = False, jsonindent = None, strictness_str = 'NORMAL', max_phrase_length = 80, use_mct_export = False, mct_export_yaml_path = None, only_mct_export_conversion = False, only_describe = False, require_fully_correct = False, edit_distance = (0, 0, 0))

   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 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 examples_strictness_str: The example strictness string. Defaults to STRICTEST.
                                   NOTE: If you set this to 'None', examples will be omitted.
   :type examples_strictness_str: str
   :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
   :param strictness_str: The strictness name. Defaults to NORMAL.
   :type strictness_str: str
   :param max_phrase_length: The maximum phrase length in examples. Defaults to 80.
   :type max_phrase_length: int
   :param use_mct_export: Whether to use a MedCATtrainer export as input. Defaults to False.
   :type use_mct_export: bool
   :param mct_export_yaml_path: The (optional) path the converted MCT export should be saved as YAML at.
                                If not set (or None), the MCT export is not saved in YAML format. Defaults to None.
   :type mct_export_yaml_path: str
   :param only_mct_export_conversion: Whether to only deal with the MCT export conversion.
                                      I.e exit when MCT export conversion is done. Defaults to False.
   :type only_mct_export_conversion: bool
   :param only_describe: Whether to only describe the finding options and exit.
                         Defaults to False.
   :type only_describe: bool
   :param require_fully_correct: Whether all cases are required to be correct.
                                 If set to True, an exit-status of 1 is returned unless all (sub)cases are correct.
                                 Defaults to False.
   :type require_fully_correct: bool
   :param edit_distance: The edit distance, the random seed, and the number
                         of edited names to pick for each of the names. If set to non-0, the specified number
                         of splits, deletes, transposes, replaces, or inserts are done to the each name. This
                         can be useful for looking at the capability of identifying typos in text. However,
                         this can make hte process a lot slower as a resullt. Defaults to (0, 0, 0).
   :type edit_distance: Tuple[int, int, int]

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


.. py:function:: tuple3_parser(arg)


.. py:data:: parser