<commit_before>==================
Settings Reference
==================

.. module:: gmc.conf
.. currentmodule:: gmc.conf

This document covers the features of :class:`~gmc.conf.Settings` class.
It also covers the options available for environment settings. ``settings``
can be used by other modules by directing importing them from :mod:`gmc.conf`
module.

.. _settings-overview:

``Overview``
============

After installation of :mod:`gmc` module, a :mod:`settings` module is
important to configure ``gmc``. The ``settings`` module path can be
explicitly provided to ``gmc-main`` command. If not provided, then the
current working directory will be assumed to have the ``settings``
module.

The ``gmc-main`` command can work in he following way:

.. code-block:: console

	$ gmc-main
	$ gmc-main path/to/my/settings.py

.. _settings-module:

``settings.py`` module
======================

To configure ``gmc``, it is important to create a ``settings.py`` module
which is importable. You can create a ``settings.py`` file in the directory
from where the ``gmc`` command is to be run for convinience.


.. _settings-options

``Settings`` Options
====================

Currently, there are only 3 available options for ``gmc``.

``DATASET_DIR``

This setting specifies the path where the dataset is stored. It is important
that the dataset format is same as the one mentioned in dataset documentation.
By default, it is set to ``/tmp``


``BRAIN_DIR``

This setting will specify the directory where ``GMC`` will store its results
files, feature files and other important files. By default, it is set to ``/tmp``
<commit_msg>Updated label typo in settings.txt<commit_after>==================
Settings Reference
==================

.. module:: gmc.conf
.. currentmodule:: gmc.conf

This document covers the features of :class:`~gmc.conf.Settings` class.
It also covers the options available for environment settings. ``settings``
can be used by other modules by directing importing them from :mod:`gmc.conf`
module.

.. _settings-overview:

``Overview``
============

After installation of :mod:`gmc` module, a :mod:`settings` module is
important to configure ``gmc``. The ``settings`` module path can be
explicitly provided to ``gmc-main`` command. If not provided, then the
current working directory will be assumed to have the ``settings``
module.

The ``gmc-main`` command can work in he following way:

.. code-block:: console

	$ gmc-main
	$ gmc-main path/to/my/settings.py

.. _settings-module:

``settings.py`` module
======================

To configure ``gmc``, it is important to create a ``settings.py`` module
which is importable. You can create a ``settings.py`` file in the directory
from where the ``gmc`` command is to be run for convinience.


.. _settings-options:

``Settings`` Options
====================

Currently, there are only 3 available options for ``gmc``.

``DATASET_DIR``

This setting specifies the path where the dataset is stored. It is important
that the dataset format is same as the one mentioned in dataset documentation.
By default, it is set to ``/tmp``


``BRAIN_DIR``

This setting will specify the directory where ``GMC`` will store its results
files, feature files and other important files. By default, it is set to ``/tmp``

{'fraction_non_alphanumeric': 0.1536107711138311, 'fraction_numerical': 0.0006119951040391676, 'mean_word_length': 4.695121951219512, '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': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7638630', 'n_tokens_mistral': 903, 'n_tokens_neox': 874, 'n_words': 412}