.. image:: https://raw.githubusercontent.com/zizhongyan/StataImproved/master/pictures/networkfmlogo6.png
   :width: 500px
   :align: center


Welcome to the **Documentation for NetworkFm**!

**NetworkFm** is a Python package for the econometric analysis of the **dyadic network formation models** with **degree heterogeneity**.

This package accompanies the paper:
    Yan, Zizhong; Li, Jingrong; Zhang, Yi (2026). 
    *Penalized Likelihood for Dyadic Network Formation Models with Degree Heterogeneity*.
    *arXiv e-prints*, arXiv:2605.00771.

Project’s GitHub homepage:
`github.com/zizhongyan/networkfm <https://github.com/zizhongyan/networkfm>`_

If you are new to the package, I recommend starting with **Getting started**, then working through the **Examples** section. The **API reference** section for detailed function/class documentation.


Table of Contents
=================

.. toctree::
   :maxdepth: 3

   install/install

.. toctree::
   :maxdepth: 3

   examples/examples

.. toctree::
   :maxdepth: 3

   api/api




Code maintainer
---------------

**Zizhong Yan**, Institute for Economic and Social Research (IESR), Jinan University, Guangzhou, China.  
Email: `helloyzz@gmail.com <mailto:helloyzz@gmail.com>`_