medcat.utils.defaults
=====================

.. py:module:: medcat.utils.defaults


Attributes
----------

.. autoapisummary::

   medcat.utils.defaults.DEFAULT_SPACY_MODEL
   medcat.utils.defaults.DEFAULT_PACK_NAME
   medcat.utils.defaults.COMPONENTS_FOLDER
   medcat.utils.defaults.AVOID_LEGACY_CONVERSION_ENVIRON


Classes
-------

.. autoapisummary::

   medcat.utils.defaults.StatusTypes


Functions
---------

.. autoapisummary::

   medcat.utils.defaults.default_weighted_average
   medcat.utils.defaults.workers


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

.. py:data:: DEFAULT_SPACY_MODEL
   :value: 'en_core_web_md'


.. py:data:: DEFAULT_PACK_NAME
   :value: 'medcat2_model_pack'


.. py:data:: COMPONENTS_FOLDER
   :value: 'saved_components'


.. py:data:: AVOID_LEGACY_CONVERSION_ENVIRON
   :value: 'MEDCAT_AVOID_LECACY_CONVERSION'


.. py:function:: default_weighted_average(step, factor = 0.0004)

.. py:function:: workers(workers_override = None)

   Get number of workers.

   Either the number of workers specified (if done so).
   Or the number of workers available (i.e cpu count - 1).

   :param workers_override: The number of workers to use. Defaults to None.
   :type workers_override: Optional[int], optional

   :Returns: **int** -- _description_


.. py:class:: StatusTypes

   .. py:attribute:: PRIMARY_STATUS_NO_DISAMB
      :value: 'P'



   .. py:attribute:: PRIMARY_STATUS_W_DISAMB
      :value: 'PD'



   .. py:attribute:: PRIMARY_STATUS
      :type:  set[str]


   .. py:attribute:: MUST_DISAMBIGATE
      :value: 'N'



   .. py:attribute:: AUTOMATIC
      :value: 'A'



   .. py:attribute:: ALLOWED_STATUS


   .. py:attribute:: DO_DISAMBUGATION