<commit_before>.. _api:

API
---

.. module:: trendpy

This part of the documentation covers all the interfaces of trendpy. Whenever an external library is used
the most relevent part are documented and we provide links to the respective documentations.


factory
======

Factory class handling the creation of bayesian algorithms.

.. autoclass:: StrategyFactory
    :members:

    .. automethod:: add
	
	.. automethod:: create


globals
=======

A collection of functions used to perform estimations.

.. autofunction:: derivative_matrix

mcmc
====

.. autoclass:: MCMC
    :members:

    .. automethod:: __init__

series
=====

.. autoclass:: Series
    :members:

    .. automethod:: __init__

strategies
==========

Strategies tell the mcmc algorithm how to simulate the Markov chain. 

.. autoclass:: Parameter
    :members:

    .. automethod:: __init__


.. autoclass:: Parameters
    :members:

    .. automethod:: __init__


.. autoclass:: Strategy
    :members:

    .. automethod:: __init__


.. autoclass:: L1Filter
    :members:

    .. automethod:: __init__<commit_msg>Update api.rst<commit_after>.. _api:

API
===

.. module:: trendpy

This part of the documentation covers all the interfaces of trendpy. Whenever an external library is used
the most relevent part are documented and we provide links to the respective documentations.


factory
-------

Factory class handling the creation of bayesian algorithms.

.. autoclass:: StrategyFactory
    :members:

    .. automethod:: add
	
	.. automethod:: create


globals
-------

A collection of functions used to perform estimations.

.. autofunction:: derivative_matrix

mcmc
====

.. autoclass:: MCMC
    :members:

    .. automethod:: __init__

series
=====

.. autoclass:: Series
    :members:

    .. automethod:: __init__

strategies
----------

Strategies tell the mcmc algorithm how to simulate the Markov chain. 

.. autoclass:: Parameter
    :members:

    .. automethod:: __init__


.. autoclass:: Parameters
    :members:

    .. automethod:: __init__


.. autoclass:: Strategy
    :members:

    .. automethod:: __init__


.. autoclass:: L1Filter
    :members:

    .. automethod:: __init__
{'fraction_non_alphanumeric': 0.11889400921658987, 'fraction_numerical': 0.0009216589861751152, 'mean_word_length': 2.9329710144927534, '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': '2298817', 'n_tokens_mistral': 666, 'n_tokens_neox': 605, 'n_words': 214}