<commit_before>r'''
Runtime Configuration
=====================

To configure the runtime behavior like logging system or parameters for the
Java/Python bridge, the configuration module reads several config files to build
its final set of settings. It searches for the file 'pyemma.cfg' in several
locations with different priorities:

1. $CWD/pyemma.cfg
2. /etc/pyemma.cfg
3. ~/pyemma.cfg
4. $PYTHONPATH/pyemma/pyemma.cfg (always taken as default configuration file)

The default values are stored in later file to ensure these values are always
defined. This is preferred over hardcoding them somewhere in the Python code.


Default configuration file
--------------------------

Default settings are stored in a provided pyemma.cfg file, which is included in
the Python package:

.. literalinclude:: ../../pyemma/pyemma.cfg
    :language: ini

To access the config at runtime eg. the logging section:

.. code-block:: python

    from pyemma.util.config import config
    print config.Logging.level

Notes
-----
All values are being stored as strings, so to compare eg. if a value is True,
compare for

.. code-block:: python

    if config['section].my_bool == 'True':
        pass


.. codeauthor:: <NAME> <m.scherer at fu-berlin.de>
<commit_msg>[config] minor docstring change<commit_after>r'''
Runtime Configuration
=====================

To configure the runtime behavior like logging system or parameters for the
Java/Python bridge, the configuration module reads several config files to build
its final set of settings. It searches for the file 'pyemma.cfg' in several
locations with different priorities:

1. $CWD/pyemma.cfg
2. /etc/pyemma.cfg
3. ~/pyemma.cfg
4. $PYTHONPATH/pyemma/pyemma.cfg (always taken as default configuration file)

The default values are stored in later file to ensure these values are always
defined. This is preferred over hardcoding them somewhere in the Python code.


Default configuration file
--------------------------

Default settings are stored in a provided pyemma.cfg file, which is included in
the Python package:

.. literalinclude:: ../../pyemma/pyemma.cfg
    :language: ini

To access the config at runtime eg. the logging section:

.. code-block:: python

    from pyemma.util.config import config
    print config.Logging.level

Notes
-----
All values are being stored as strings, so to compare eg. if a value is True,
compare for

.. code-block:: python

    if config['section'].my_bool == 'True':
        pass


.. codeauthor:: <NAME> <m.scherer at fu-berlin.de>

{'fraction_non_alphanumeric': 0.11384371281237604, 'fraction_numerical': 0.0031733439111463705, 'mean_word_length': 3.471631205673759, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7182110', 'n_tokens_mistral': 707, 'n_tokens_neox': 679, 'n_words': 311}