Skip to content

Latest commit

 

History

History
76 lines (59 loc) · 1.89 KB

index.rst

File metadata and controls

76 lines (59 loc) · 1.89 KB

The :mod:`bipartiteSBM` User Guide

If you have any questions, please contact tzuchi.yen@colorado.edu.

.. toctree::
   :maxdepth: 2
   :caption: Contents

.. toctree::
   :maxdepth: 1
   :caption: Quick start

   usage/why-should-i-use-bipartiteSBM
   usage/installation
   usage/kl-inference
   usage/mcmc-inference
   usage/more-mcmc-inference
   usage/explore-consistency
   usage/generate-synthetic-networks
   usage/make-plots
   usage/parallel
   usage/interpret-entropy

.. toctree::
   :maxdepth: 1
   :caption: Dataset

   dataset/format
   dataset/node-type-ordering
   dataset/southern-women
   dataset/malaria
   dataset/ancient-metabolic

.. toctree::
   :maxdepth: 1
   :caption: Module documentation

   src/biSBM
   src/engines

.. toctree::
   :maxdepth: 2
   :caption: Frequently Asked Questions (FAQ)

   frequently-asked-questions/local-minima
   frequently-asked-questions/choosing-parameters
   frequently-asked-questions/detectability


.. toctree::
   :maxdepth: 2
   :caption: Additional resources

   additional-resources/slides

Acknowledgements

The bipartiteSBM is inspired and supported by the following great humans, Daniel B. Larremore, Tiago de Paula Peixoto, Jean-Gabriel Young, Pan Zhang, and Jie Tang. Thanks Valentin Haenel who helped debug and fix the Numba code.