<commit_before>Welcome to rf's documentation!
===============================

.. currentmodule:: rf
.. automodule:: rf

    .. comment to end block

    Classes & Functions
    -------------------
    .. autosummary::
       :toctree:
       :nosignatures:

       ~rfstream.RFStream
       ~rfstream.rfstats

    .. comment to end block

    Modules
    -------
    .. autosummary::
       :toctree:
       :nosignatures:

       rfstream
       batch
       deconvolve
       simple_model

    .. comment to end block

Module Reference
----------------

:mod:`rfstream` Module
^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: rf.rfstream

:mod:`batch` Module
^^^^^^^^^^^^^^^^^^^

.. automodule:: rf.batch

:mod:`deconvolve` Module
^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: rf.deconvolve

:mod:`simple_model` Module
^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: rf.simple_model<commit_msg>change structure of doc<commit_after>Welcome to rf's documentation!
===============================

.. currentmodule:: rf
.. automodule:: rf

Classes & Functions
-------------------
.. autosummary::
    :toctree:
    :nosignatures:

    ~rfstream.RFStream
    ~rfstream.rfstats

Modules
-------
.. autosummary::
    :toctree:
    :nosignatures:

    rfstream
    batch
    deconvolve
    simple_model

Module Reference
================

:mod:`rfstream` Module
----------------------

.. automodule:: rf.rfstream

:mod:`batch` Module
-------------------

.. automodule:: rf.batch

:mod:`deconvolve` Module
------------------------

.. automodule:: rf.deconvolve

:mod:`simple_model` Module
--------------------------

.. automodule:: rf.simple_model
{'fraction_non_alphanumeric': 0.29097605893186, 'fraction_numerical': 0.0, 'mean_word_length': 2.140655105973025, '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': '3656701', 'n_tokens_mistral': 519, 'n_tokens_neox': 493, 'n_words': 96}