:py:mod:`medcat`
================

.. py:module:: medcat


Subpackages
-----------
.. toctree::
   :titlesonly:
   :maxdepth: 3

   datasets/index.rst
   linking/index.rst
   ner/index.rst
   pipeline/index.rst
   preprocessing/index.rst
   stats/index.rst
   tokenizers/index.rst
   utils/index.rst


Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   cat/index.rst
   cdb/index.rst
   cdb_maker/index.rst
   config/index.rst
   config_meta_cat/index.rst
   config_rel_cat/index.rst
   config_transformers_ner/index.rst
   meta_cat/index.rst
   pipe/index.rst
   rel_cat/index.rst
   vocab/index.rst


Package Contents
----------------


Functions
~~~~~~~~~

.. autoapisummary::

   medcat.add_default_log_handlers



Attributes
~~~~~~~~~~

.. autoapisummary::

   medcat.logger
   medcat.name
   medcat.distribution


.. py:data:: logger

   

.. py:function:: add_default_log_handlers(log = logger, target_file = 'medcat.log')

   Add default log handlers to the specified logger.
   This method will add a file handler that will write
   into `target_file` (defaults to 'medcat.log') and
   a console handler that outputs to the console.

   :param log: The logger to add the handlers to. Defaults to logger.
   :type log: logging.Logger
   :param target_file: The target file for file handler. Defaults to 'medcat.log'.
   :type target_file: str


.. py:data:: name
   :value: 'medcat'

   

.. py:data:: distribution