API Documentation
=================

This section contains the complete API documentation for py3plex, automatically generated from docstrings.

For auto-generated module documentation, run::

    cd docfiles
    sphinx-apidoc -o AUTOGEN_results -f ../py3plex
    make html

Core Modules
------------

.. automodule:: py3plex.core.multinet
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: py3plex.core.parsers
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: py3plex.core.converters
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: py3plex.core.random_generators
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: py3plex.core.supporting
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: py3plex.core.nx_compat
   :members:
   :undoc-members:
   :show-inheritance:

HINMINE Network Decomposition
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: py3plex.core.HINMINE.decomposition
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: py3plex.core.HINMINE.IO
   :members:
   :undoc-members:
   :show-inheritance:

Configuration and Utilities
----------------------------

.. automodule:: py3plex.config
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: py3plex.utils
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: py3plex.exceptions
   :members:
   :undoc-members:
   :show-inheritance:

Algorithms
----------

Community Detection
~~~~~~~~~~~~~~~~~~~

.. automodule:: py3plex.algorithms.community_detection.community_wrapper
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: py3plex.algorithms.community_detection.multilayer_modularity
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: py3plex.algorithms.community_detection.community_louvain
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: py3plex.algorithms.community_detection.community_measures
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: py3plex.algorithms.community_detection.multilayer_benchmark
   :members:
   :undoc-members:
   :show-inheritance:

Statistics
~~~~~~~~~~

.. automodule:: py3plex.algorithms.statistics.statistics
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: py3plex.algorithms.statistics.multilayer_statistics
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: py3plex.algorithms.statistics.topology
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: py3plex.algorithms.statistics.enrichment
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: py3plex.algorithms.statistics.correlation_networks
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: py3plex.algorithms.statistics.basic_statistics
   :members:
   :undoc-members:
   :show-inheritance:

Multilayer Algorithms
~~~~~~~~~~~~~~~~~~~~~

.. automodule:: py3plex.algorithms.multilayer_algorithms.centrality
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: py3plex.algorithms.multilayer_algorithms.multixrank
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: py3plex.algorithms.multilayer_algorithms.entanglement
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: py3plex.algorithms.multilayer_algorithms.supra_matrix_function_centrality
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: py3plex.algorithms.multicentrality
   :members:
   :undoc-members:
   :show-inheritance:

General Algorithms
~~~~~~~~~~~~~~~~~~

.. automodule:: py3plex.algorithms.general.walkers
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: py3plex.algorithms.general.benchmark_classification
   :members:
   :undoc-members:
   :show-inheritance:

Node Ranking
~~~~~~~~~~~~

.. automodule:: py3plex.algorithms.node_ranking.node_ranking
   :members:
   :undoc-members:
   :show-inheritance:

Network Classification
~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: py3plex.algorithms.network_classification.label_propagation
   :members:
   :undoc-members:
   :show-inheritance:

Visualization
-------------

.. automodule:: py3plex.visualization.multilayer
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: py3plex.visualization.drawing_machinery
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: py3plex.visualization.colors
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: py3plex.visualization.layout_algorithms
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: py3plex.visualization.bezier
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: py3plex.visualization.benchmark_visualizations
   :members:
   :undoc-members:
   :show-inheritance:

Wrappers
--------

.. automodule:: py3plex.wrappers.node2vec_embedding
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: py3plex.wrappers.benchmark_nodes
   :members:
   :undoc-members:
   :show-inheritance:

I/O Operations
--------------

.. automodule:: py3plex.io.input_output
   :members:
   :undoc-members:
   :show-inheritance:

For the complete auto-generated API documentation, see the AUTOGEN_results directory after building the docs.