medcat.utils.regression.regression_checker

Module Contents

Functions

show_description()

main(model_pack_dir, test_suite_file[, phrases, ...])

Check test suite against the specifeid model pack.

tuple3_parser(arg)

Attributes

logger

DEFAULT_TEST_SUITE_PATH

parser

medcat.utils.regression.regression_checker.logger
medcat.utils.regression.regression_checker.DEFAULT_TEST_SUITE_PATH
medcat.utils.regression.regression_checker.show_description()
medcat.utils.regression.regression_checker.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.

Parameters:

  • model_pack_dir (Path) – The path to the model pack

  • test_suite_file (Path) – The path to the test suite YAML

  • phrases (bool) – Whether to show per-phrase information in a report

  • hide_empty (bool) – Whether to hide empty cases in a report

  • examples_strictness_str (str) – The example strictness string. Defaults to STRICTEST. NOTE: If you set this to ‘None’, examples will be omitted.

  • jsonpath (Optional[Path]) – The json path to save the report to (if specified)

  • overwrite (bool) – Whether to overwrite the file if it exists. Defaults to False

  • jsonindent (int) – The indentation for json objects. Defaults to 0

  • strictness_str (str) – The strictness name. Defaults to NORMAL.

  • max_phrase_length (int) – The maximum phrase length in examples. Defaults to 80.

  • use_mct_export (bool) – Whether to use a MedCATtrainer export as input. Defaults to False.

  • mct_export_yaml_path (str) – 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.

  • only_mct_export_conversion (bool) – Whether to only deal with the MCT export conversion. I.e exit when MCT export conversion is done. Defaults to False.

  • only_describe (bool) – Whether to only describe the finding options and exit. Defaults to False.

  • require_fully_correct (bool) – 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.

  • edit_distance (Tuple[int, int, int]) – 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).

Raises:

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

Return type:

None

medcat.utils.regression.regression_checker.tuple3_parser(arg)
Parameters:

arg (str) –

Return type:

Tuple[int, int, int]

medcat.utils.regression.regression_checker.parser