<commit_before>.. _enc-polar-encoder-parameters:

Polar Encoder parameters
------------------------

.. _enc-polar-enc-type:

``--enc-type``
""""""""""""""

   :Type: text
   :Allowed values: ``POLAR`` ``AZCW`` ``COSET`` ``USER``
   :Default: ``POLAR``
   :Examples: ``--enc-type AZCW``

|factory::Encoder::parameters::p+type|

Description of the allowed values:

+-----------+------------------------+
| Value     | Description            |
+===========+========================+
| ``POLAR`` | |enc-type_descr_polar| |
+-----------+------------------------+
| ``AZCW``  | |enc-type_descr_azcw|  |
+-----------+------------------------+
| ``COSET`` | |enc-type_descr_coset| |
+-----------+------------------------+
| ``USER``  | |enc-type_descr_user|  |
+-----------+------------------------+

.. |enc-type_descr_polar| replace:: Select the standard Polar encoder.
.. |enc-type_descr_azcw| replace:: See the common :ref:`enc-common-enc-type`
   parameter.
.. |enc-type_descr_coset| replace:: See the common :ref:`enc-common-enc-type`
   parameter.
.. |enc-type_descr_user| replace:: See the common :ref:`enc-common-enc-type`
   parameter.

.. _enc-polar-enc-no-sys:

``--enc-no-sys``
""""""""""""""""

|factory::Encoder_polar::parameters::p+no-sys|

.. _enc-polar-enc-fb-gen-method:

``--enc-fb-gen-method``
"""""""""""""""""""""""

   :Type: text
   :Allowed values: ``FILE`` ``GA`` ``TV`` ``BEC``
   :Examples: ``--enc-fb-gen-method FILE``

|factory::Frozenbits_generator::parameters::p+gen-method|

Description of the allowed values:

+----------+-------------------------------------------------------------------+
| Value    | Description                                                       |
+==========+===================================================================+
| ``GA``   | Select the |GA| method from :cite:`Trifonov2012`.                 |
+----------+-------------------------------------------------------------------+
| ``TV``   | Select the |TV| method which is based on Density Evolution (|DE|) |
|          | approach from :cite:`Tal2013`, to use with the                    |
|          | :ref:`enc-polar-enc-fb-awgn-path` parameter.                      |
+----------+-------------------------------------------------------------------+
| ``FILE`` | Read the best channels from an external file, to use with the     |
|          | :ref:`enc-polar-enc-fb-awgn-path` parameter.                      |
+----------+-------------------------------------------------------------------+
| ``BEC``  | Generate frozen bits for the |BEC| channel from                   |
|          | :cite:`Arikan2009`.                                               |
+----------+-------------------------------------------------------------------+
| ``5G``   | Generate the frozen bits as described in the 5G standard          |
|          | :cite:`3GPP2017`.                                                 |
+----------+-------------------------------------------------------------------+

.. note:: By default, when using the |GA| or the |TV| method, the frozen bits
   are optimized for each |SNR| point. To override this behavior you can use
   the :ref:`enc-polar-enc-fb-noise` parameter.<commit_msg>Add forgotten 5G in parameters list for enc-fb-gen-method.<commit_after>.. _enc-polar-encoder-parameters:

Polar Encoder parameters
------------------------

.. _enc-polar-enc-type:

``--enc-type``
""""""""""""""

   :Type: text
   :Allowed values: ``POLAR`` ``AZCW`` ``COSET`` ``USER``
   :Default: ``POLAR``
   :Examples: ``--enc-type AZCW``

|factory::Encoder::parameters::p+type|

Description of the allowed values:

+-----------+------------------------+
| Value     | Description            |
+===========+========================+
| ``POLAR`` | |enc-type_descr_polar| |
+-----------+------------------------+
| ``AZCW``  | |enc-type_descr_azcw|  |
+-----------+------------------------+
| ``COSET`` | |enc-type_descr_coset| |
+-----------+------------------------+
| ``USER``  | |enc-type_descr_user|  |
+-----------+------------------------+

.. |enc-type_descr_polar| replace:: Select the standard Polar encoder.
.. |enc-type_descr_azcw| replace:: See the common :ref:`enc-common-enc-type`
   parameter.
.. |enc-type_descr_coset| replace:: See the common :ref:`enc-common-enc-type`
   parameter.
.. |enc-type_descr_user| replace:: See the common :ref:`enc-common-enc-type`
   parameter.

.. _enc-polar-enc-no-sys:

``--enc-no-sys``
""""""""""""""""

|factory::Encoder_polar::parameters::p+no-sys|

.. _enc-polar-enc-fb-gen-method:

``--enc-fb-gen-method``
"""""""""""""""""""""""

   :Type: text
   :Allowed values: ``FILE`` ``GA`` ``TV`` ``BEC`` ``5G``
   :Examples: ``--enc-fb-gen-method FILE``

|factory::Frozenbits_generator::parameters::p+gen-method|

Description of the allowed values:

+----------+-------------------------------------------------------------------+
| Value    | Description                                                       |
+==========+===================================================================+
| ``GA``   | Select the |GA| method from :cite:`Trifonov2012`.                 |
+----------+-------------------------------------------------------------------+
| ``TV``   | Select the |TV| method which is based on Density Evolution (|DE|) |
|          | approach from :cite:`Tal2013`, to use with the                    |
|          | :ref:`enc-polar-enc-fb-awgn-path` parameter.                      |
+----------+-------------------------------------------------------------------+
| ``FILE`` | Read the best channels from an external file, to use with the     |
|          | :ref:`enc-polar-enc-fb-awgn-path` parameter.                      |
+----------+-------------------------------------------------------------------+
| ``BEC``  | Generate frozen bits for the |BEC| channel from                   |
|          | :cite:`Arikan2009`.                                               |
+----------+-------------------------------------------------------------------+
| ``5G``   | Generate the frozen bits as described in the 5G standard          |
|          | :cite:`3GPP2017`.                                                 |
+----------+-------------------------------------------------------------------+

.. note:: By default, when using the |GA| or the |TV| method, the frozen bits
   are optimized for each |SNR| point. To override this behavior you can use
   the :ref:`enc-polar-enc-fb-noise` parameter.
{'fraction_non_alphanumeric': 0.38368860055607046, 'fraction_numerical': 0.006178560395427865, 'mean_word_length': 1.3067331670822944, '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': 12, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4940678', 'n_tokens_mistral': 1763, 'n_tokens_neox': 1649, 'n_words': 373}