Welcome to BiFuncLib's Documentation!
=====================================

**BiFuncLib** is a Python library that aggregates multiple biclustering methods mainly for functional data.
This documentation aims to help users get a comprehensive understanding of all the methods, and get started quickly with this package.

In this documentation, you can obtain:

- The introduction and framework of this package

- Details of methods

- Examples for main functions and plot results

This package has been uploaded to PyPI with previous versions, and the web page is available at
`PyPI package <https://pypi.org/project/bifunclib/>`_. 
Users can also check `releases <https://github.com/XMU-Kuangnan-Fang-Team/BiFuncLib/releases>`_  to get historical versions.
Welcome to provide your feedback and make contributions to our package, we will be grateful for all the contributors. 
The ways to contact us are provided in :ref:`contributing to BiFuncLib <contribution-label>`.


.. toctree::
   :maxdepth: 2

   introduction
   installation
   methods and main functions/methods and main functions
   references
   contribution