<commit_before>===============
Reference guide
===============

Toolbox overview
----------------

.. automodule:: pyunlocbox

Functions module
----------------

.. toctree::
    :hidden:

    func
    func_norms
    func_projections

.. automodule:: pyunlocbox.functions

.. inheritance-diagram:: pyunlocbox.functions
    :parts: 2

Solvers module
--------------

.. toctree::
    :hidden:

    solve
    solvers

.. automodule:: pyunlocbox.solvers

.. inheritance-diagram:: pyunlocbox.solvers
    :parts: 2

Acceleration module
-------------------

.. toctree::
    :hidden:

    acceleration

.. automodule:: pyunlocbox.acceleration

.. inheritance-diagram:: pyunlocbox.acceleration
    :parts: 2


Operators module
----------------

.. toctree::
    :hidden:

    operators

.. automodule:: pyunlocbox.operators
<commit_msg>doc: toolbox overview --> package overview<commit_after>===============
Reference guide
===============

Package overview
----------------

.. automodule:: pyunlocbox

Functions module
----------------

.. toctree::
    :hidden:

    func
    func_norms
    func_projections

.. automodule:: pyunlocbox.functions

.. inheritance-diagram:: pyunlocbox.functions
    :parts: 2

Solvers module
--------------

.. toctree::
    :hidden:

    solve
    solvers

.. automodule:: pyunlocbox.solvers

.. inheritance-diagram:: pyunlocbox.solvers
    :parts: 2

Acceleration module
-------------------

.. toctree::
    :hidden:

    acceleration

.. automodule:: pyunlocbox.acceleration

.. inheritance-diagram:: pyunlocbox.acceleration
    :parts: 2


Operators module
----------------

.. toctree::
    :hidden:

    operators

.. automodule:: pyunlocbox.operators

{'fraction_non_alphanumeric': 0.22314540059347182, 'fraction_numerical': 0.0035608308605341245, 'mean_word_length': 2.181132075471698, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 4, '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': '3792007', 'n_tokens_mistral': 553, 'n_tokens_neox': 518, 'n_words': 104}