<commit_before>.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.

.. include:: ../Includes.txt


.. _config-options:


Configuration options
=====================

You do not have to configure kreXX. It works very well out of the box.

These settings can be used in the configuration file editor, as well as in the configuration cookie editor.

Render
------
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+---------------------------+
| Option                         | Description                                                                                                                            | Possible values / example |
+================================+========================================================================================================================================+===========================+
| Skin                           | You can change the CSS/HTML skin.                                                                                                      | - hans                    |
|                                |                                                                                                                                        | - schablon                |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+---------------------------+
| Path to jQuery                 | | The path of the used js library.                                                                                                     | jquery-1.11.0.js          |
|                                | When it is not found, it will not get rendered. Normally, you want to point it to your jQuery file. The standard setting will use the  |                           |
|                                | bundled file, but you might want to use the one from your project, or none at all                                                      |                           |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+---------------------------+
| Minimum amout of memory [MB]   | kreXX checks regularly how much memory is left. Here you can adjust the amount where it will trigger an emergengy break. Unit of       | 64                        |
|                                | measurement is MB.                                                                                                                     |                           |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+---------------------------+
| Maximum Runtime [Seconds]      | kreXX checks during the analysis how much time has elapsed since start. Here you can adjust how many seconds can pass until an         | 60                        |
|                                | emergency break will be triggered. Unit of measurement is seconds.                                                                     |                           |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+---------------------------+

Logging
-------
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+---------------------------+
| Option                         | Description                                                                                                                            | Possible values / example |
+================================+========================================================================================================================================+===========================+
| Folder                         | Where shall kreXX save it's logfiles?                                                                                                  | log                       |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+---------------------------+
| Maximum files in the logfolder | How many files should it keep? Files will only get deleted, when a new one is created.                                                 | 10                        |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+---------------------------+


Output
------
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+---------------------------+
| Option                         | Description                                                                                                                            | Possible values / example |
+================================+========================================================================================================================================+===========================+
| Destination                    | Will the output be sent to the frontend or the logfolder?                                                                              | - file                    |
|                                |                                                                                                                                        | - frontend                |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+---------------------------+
| Maximum amount of calls        | | How often can you call kreXX in one run?                                                                                             | 10                        |
|                                | kreXX can generate a lot of data, and depending on your settings increasing this number might not be a good idea.                      |                           |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+---------------------------+<commit_msg>- Fixed a minor typo in the Documentation/ConfigOptions/Index.rst<commit_after>.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.

.. include:: ../Includes.txt


.. _config-options:


Configuration options
=====================

You do not have to configure kreXX. It works very well out of the box.

These settings can be used in the configuration file editor, as well as in the configuration cookie editor.

Render
------
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+---------------------------+
| Option                         | Description                                                                                                                            | Possible values / example |
+================================+========================================================================================================================================+===========================+
| Skin                           | You can change the CSS/HTML skin.                                                                                                      | - hans                    |
|                                |                                                                                                                                        | - schablon                |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+---------------------------+
| Path to jQuery                 | | The path of the used js library.                                                                                                     | jquery-1.11.0.js          |
|                                | When it is not found, it will not get rendered. Normally, you want to point it to your jQuery file. The standard setting will use the  |                           |
|                                | bundled file, but you might want to use the one from your project, or none at all.                                                     |                           |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+---------------------------+
| Minimum amout of memory [MB]   | kreXX checks regularly how much memory is left. Here you can adjust the amount where it will trigger an emergengy break. Unit of       | 64                        |
|                                | measurement is MB.                                                                                                                     |                           |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+---------------------------+
| Maximum Runtime [Seconds]      | kreXX checks during the analysis how much time has elapsed since start. Here you can adjust how many seconds can pass until an         | 60                        |
|                                | emergency break will be triggered. Unit of measurement is seconds.                                                                     |                           |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+---------------------------+

Logging
-------
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+---------------------------+
| Option                         | Description                                                                                                                            | Possible values / example |
+================================+========================================================================================================================================+===========================+
| Folder                         | Where shall kreXX save it's logfiles?                                                                                                  | log                       |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+---------------------------+
| Maximum files in the logfolder | How many files should it keep? Files will only get deleted, when a new one is created.                                                 | 10                        |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+---------------------------+


Output
------
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+---------------------------+
| Option                         | Description                                                                                                                            | Possible values / example |
+================================+========================================================================================================================================+===========================+
| Destination                    | Will the output be sent to the frontend or the logfolder?                                                                              | - file                    |
|                                |                                                                                                                                        | - frontend                |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+---------------------------+
| Maximum amount of calls        | | How often can you call kreXX in one run?                                                                                             | 10                        |
|                                | kreXX can generate a lot of data, and depending on your settings increasing this number might not be a good idea.                      |                           |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+---------------------------+
{'fraction_non_alphanumeric': 0.4430607543910164, 'fraction_numerical': 0.0018715807659084366, 'mean_word_length': 0.4471875, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 160, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '129391', 'n_tokens_mistral': 1456, 'n_tokens_neox': 1268, 'n_words': 559}