Skip to content

Commit

Permalink
deploy: 9434986
Browse files Browse the repository at this point in the history
  • Loading branch information
jcpassy committed Jan 31, 2025
0 parents commit d8427b0
Show file tree
Hide file tree
Showing 372 changed files with 79,787 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: e2c36d49dfbfe6a435adb30b39dee074
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added .doctrees/api.doctree
Binary file not shown.
Binary file added .doctrees/contributing.doctree
Binary file not shown.
Binary file added .doctrees/environment.pickle
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/generated/probinet.evaluation.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/generated/probinet.input.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/generated/probinet.input.stats.doctree
Binary file not shown.
Binary file added .doctrees/generated/probinet.main.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/generated/probinet.models.base.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/generated/probinet.models.crep.doctree
Binary file not shown.
Binary file added .doctrees/generated/probinet.models.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/generated/probinet.models.mtcov.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/generated/probinet.synthetic.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/generated/probinet.utils.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/generated/probinet.utils.tools.doctree
Binary file not shown.
Binary file added .doctrees/generated/probinet.version.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/index.doctree
Binary file not shown.
Binary file added .doctrees/references.doctree
Binary file not shown.
Binary file added .doctrees/start.doctree
Binary file not shown.
Binary file added .doctrees/tutorials/ACD.doctree
Binary file not shown.
Binary file added .doctrees/tutorials/CRep.doctree
Binary file not shown.
Binary file added .doctrees/tutorials/DynCRep.doctree
Binary file not shown.
Binary file added .doctrees/tutorials/JointCRep.doctree
Binary file not shown.
Binary file added .doctrees/tutorials/MTCOV.doctree
Binary file not shown.
Binary file added .doctrees/tutorials/Unknown_structure.doctree
Binary file not shown.
Empty file added .nojekyll
Empty file.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/input_and_output_for_algorithms.png
417 changes: 417 additions & 0 deletions _modules/index.html

Large diffs are not rendered by default.

631 changes: 631 additions & 0 deletions _modules/probinet/evaluation/community_detection.html

Large diffs are not rendered by default.

486 changes: 486 additions & 0 deletions _modules/probinet/evaluation/covariate_prediction.html

Large diffs are not rendered by default.

792 changes: 792 additions & 0 deletions _modules/probinet/evaluation/expectation_computation.html

Large diffs are not rendered by default.

724 changes: 724 additions & 0 deletions _modules/probinet/evaluation/likelihood.html

Large diffs are not rendered by default.

579 changes: 579 additions & 0 deletions _modules/probinet/evaluation/link_prediction.html

Large diffs are not rendered by default.

831 changes: 831 additions & 0 deletions _modules/probinet/input/loader.html

Large diffs are not rendered by default.

608 changes: 608 additions & 0 deletions _modules/probinet/input/preprocessing.html

Large diffs are not rendered by default.

531 changes: 531 additions & 0 deletions _modules/probinet/input/stats.html

Large diffs are not rendered by default.

853 changes: 853 additions & 0 deletions _modules/probinet/main.html

Large diffs are not rendered by default.

522 changes: 522 additions & 0 deletions _modules/probinet/model_selection/acd_cross_validation.html

Large diffs are not rendered by default.

437 changes: 437 additions & 0 deletions _modules/probinet/model_selection/crep_cross_validation.html

Large diffs are not rendered by default.

704 changes: 704 additions & 0 deletions _modules/probinet/model_selection/cross_validation.html

Large diffs are not rendered by default.

584 changes: 584 additions & 0 deletions _modules/probinet/model_selection/dyncrep_cross_validation.html

Large diffs are not rendered by default.

435 changes: 435 additions & 0 deletions _modules/probinet/model_selection/jointcrep_cross_validation.html

Large diffs are not rendered by default.

487 changes: 487 additions & 0 deletions _modules/probinet/model_selection/main.html

Large diffs are not rendered by default.

656 changes: 656 additions & 0 deletions _modules/probinet/model_selection/masking.html

Large diffs are not rendered by default.

572 changes: 572 additions & 0 deletions _modules/probinet/model_selection/mtcov_cross_validation.html

Large diffs are not rendered by default.

429 changes: 429 additions & 0 deletions _modules/probinet/model_selection/parameter_search.html

Large diffs are not rendered by default.

1,469 changes: 1,469 additions & 0 deletions _modules/probinet/models/acd.html

Large diffs are not rendered by default.

1,724 changes: 1,724 additions & 0 deletions _modules/probinet/models/base.html

Large diffs are not rendered by default.

1,031 changes: 1,031 additions & 0 deletions _modules/probinet/models/crep.html

Large diffs are not rendered by default.

1,547 changes: 1,547 additions & 0 deletions _modules/probinet/models/dyncrep.html

Large diffs are not rendered by default.

1,190 changes: 1,190 additions & 0 deletions _modules/probinet/models/jointcrep.html

Large diffs are not rendered by default.

1,244 changes: 1,244 additions & 0 deletions _modules/probinet/models/mtcov.html

Large diffs are not rendered by default.

868 changes: 868 additions & 0 deletions _modules/probinet/synthetic/anomaly.html

Large diffs are not rendered by default.

1,178 changes: 1,178 additions & 0 deletions _modules/probinet/synthetic/base.html

Large diffs are not rendered by default.

1,132 changes: 1,132 additions & 0 deletions _modules/probinet/synthetic/dynamic.html

Large diffs are not rendered by default.

883 changes: 883 additions & 0 deletions _modules/probinet/synthetic/multilayer.html

Large diffs are not rendered by default.

1,306 changes: 1,306 additions & 0 deletions _modules/probinet/synthetic/reciprocity.html

Large diffs are not rendered by default.

648 changes: 648 additions & 0 deletions _modules/probinet/utils/matrix_operations.html

Large diffs are not rendered by default.

852 changes: 852 additions & 0 deletions _modules/probinet/utils/tools.html

Large diffs are not rendered by default.

1,023 changes: 1,023 additions & 0 deletions _modules/probinet/visualization/plot.html

Large diffs are not rendered by default.

49 changes: 49 additions & 0 deletions _sources/api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
API
---

.. autosummary::
:toctree: generated

probinet.evaluation
probinet.evaluation.community_detection
probinet.evaluation.covariate_prediction
probinet.evaluation.expectation_computation
probinet.evaluation.likelihood
probinet.evaluation.link_prediction
probinet.input
probinet.input.loader
probinet.input.preprocessing
probinet.input.stats
probinet.main
probinet.model_selection
probinet.model_selection.acd_cross_validation
probinet.model_selection.crep_cross_validation
probinet.model_selection.cross_validation
probinet.model_selection.dyncrep_cross_validation
probinet.model_selection.jointcrep_cross_validation
probinet.model_selection.main
probinet.model_selection.masking
probinet.model_selection.mtcov_cross_validation
probinet.model_selection.parameter_search
probinet.models
probinet.models.acd
probinet.models.base
probinet.models.classes
probinet.models.constants
probinet.models.crep
probinet.models.dyncrep
probinet.models.jointcrep
probinet.models.mtcov
probinet.synthetic
probinet.synthetic.anomaly
probinet.synthetic.base
probinet.synthetic.dynamic
probinet.synthetic.multilayer
probinet.synthetic.reciprocity
probinet.utils
probinet.utils.matrix_operations
probinet.utils.tools
probinet.version
probinet.visualization
probinet.visualization.plot

123 changes: 123 additions & 0 deletions _sources/contributing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
Contributing
============

Thank you for your interest in contributing to **ProbINet**! Your contributions help improve the
package and make it more useful for everyone. Please follow the steps below to get started.

Getting Started
---------------

- Fork this repository to your GitHub account: `https://github.com/MPI-IS/probinet <https://github.com/MPI-IS/probinet>`_. You can fork it by clicking the "Fork" button in the top-right corner of the page.
- Clone the forked repository to your local machine:

.. code-block:: bash
git clone https://github.com/<your-username>/probinet.git
- Navigate to the project directory:

.. code-block:: bash
cd probinet
- Add the original repository as a remote named ``upstream`` to keep your fork updated:

.. code-block:: bash
git remote add upstream https://github.com/MPI-IS/probinet.git
Setting Up the Development Environment
--------------------------------------

This project uses ``pyproject.toml`` for dependency management. To set up a development environment:

- Install the package with the ``.dev`` flag:

.. code-block:: bash
pip install ".[dev]"
- Verify the installation by running the following command:

.. code-block:: bash
pip show probinet
If the package is installed, this will display details about it, such as the version and installation location.

Syncing Your Fork
-----------------

Before starting work on a new feature or bug fix, ensure your fork is up to date with the original repository:

- Fetch the latest changes from the ``upstream`` repository:

.. code-block:: bash
git fetch upstream
- Update your local ``main`` branch:

.. code-block:: bash
git checkout main
git merge upstream/main
Making Changes
--------------

- Create a new branch for your contribution:

.. code-block:: bash
git checkout -b feature/your-feature-name
- Make your changes in this branch. Ensure the code is:

- Well-documented.
- Aligned with the existing code style.

- Add or update unit tests for your changes. You can see the existing tests in the ``tests`` directory.

Running Tests
-------------

Tests are written using Python's built-in ``unittest`` framework.

- Run all tests to verify your changes:

.. code-block:: bash
python -W ignore -m unittest discover
Submitting Your Contribution
----------------------------

- Commit your changes with a clear and concise message:

.. code-block:: bash
git commit -m "Add description of your changes"
- Push your changes to your fork:

.. code-block:: bash
git push origin feature/your-feature-name
- Open a Pull Request (PR) to the **original repository**. Include:

- A detailed explanation of your changes.
- The issue number your PR addresses (if applicable).
- Any additional context or screenshots.

You can view all open and merged Pull Requests `here <https://github.com/MPI-IS/probinet/pulls>`_.


Code of Conduct
---------------

By contributing to this repository, you agree to follow our `Code of Conduct
<https://policies.python.org/python.org/code-of-conduct/>`_.

We appreciate your contributions and will review your Pull Request promptly!
15 changes: 15 additions & 0 deletions _sources/generated/probinet.evaluation.community_detection.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
probinet.evaluation.community\_detection
========================================

.. automodule:: probinet.evaluation.community_detection


.. rubric:: Functions

.. autosummary::

calculate_metric
compute_community_detection_metric
compute_permutation_matrix
cosine_similarity

14 changes: 14 additions & 0 deletions _sources/generated/probinet.evaluation.covariate_prediction.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
probinet.evaluation.covariate\_prediction
=========================================

.. automodule:: probinet.evaluation.covariate_prediction


.. rubric:: Functions

.. autosummary::

compute_covariate_prediction_accuracy
extract_true_label
predict_label

27 changes: 27 additions & 0 deletions _sources/generated/probinet.evaluation.expectation_computation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
probinet.evaluation.expectation\_computation
============================================

.. automodule:: probinet.evaluation.expectation_computation


.. rubric:: Functions

.. autosummary::

calculate_Q_dense
calculate_Z
calculate_conditional_expectation
calculate_conditional_expectation_dyncrep
calculate_expectation
calculate_expectation_acd
compute_L1loss
compute_M_joint
compute_expected_adjacency_tensor
compute_expected_adjacency_tensor_multilayer
compute_lagrange_multiplier
compute_marginal_and_conditional_expectation
compute_mean_lambda0
compute_mean_lambda0_dyncrep
compute_mean_lambda0_nonzero
u_with_lagrange_multiplier

18 changes: 18 additions & 0 deletions _sources/generated/probinet.evaluation.likelihood.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
probinet.evaluation.likelihood
==============================

.. automodule:: probinet.evaluation.likelihood


.. rubric:: Functions

.. autosummary::

PSloglikelihood
calculate_opt_func
likelihood_conditional
log_likelihood_given_model
loglikelihood
loglikelihood_attributes
loglikelihood_network

16 changes: 16 additions & 0 deletions _sources/generated/probinet.evaluation.link_prediction.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
probinet.evaluation.link\_prediction
====================================

.. automodule:: probinet.evaluation.link_prediction


.. rubric:: Functions

.. autosummary::

calculate_f1_score
compute_AUC_from_ranked_predictions
compute_link_prediction_AUC
compute_multilayer_link_prediction_AUC
mask_or_flatten_array

6 changes: 6 additions & 0 deletions _sources/generated/probinet.evaluation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
probinet.evaluation
===================

.. automodule:: probinet.evaluation


17 changes: 17 additions & 0 deletions _sources/generated/probinet.input.loader.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
probinet.input.loader
=====================

.. automodule:: probinet.input.loader


.. rubric:: Functions

.. autosummary::

build_adjacency_and_design_from_file
build_adjacency_from_file
build_adjacency_from_networkx
read_and_process_design_matrix
read_design_matrix
read_graph

15 changes: 15 additions & 0 deletions _sources/generated/probinet.input.preprocessing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
probinet.input.preprocessing
============================

.. automodule:: probinet.input.preprocessing


.. rubric:: Functions

.. autosummary::

create_adjacency_tensor_from_graph_list
create_sparse_adjacency_tensor_from_graph_list
preprocess_adjacency_tensor
preprocess_data_matrix

6 changes: 6 additions & 0 deletions _sources/generated/probinet.input.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
probinet.input
==============

.. automodule:: probinet.input


14 changes: 14 additions & 0 deletions _sources/generated/probinet.input.stats.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
probinet.input.stats
====================

.. automodule:: probinet.input.stats


.. rubric:: Functions

.. autosummary::

print_graph_stats
print_graph_stats_MTCOV
reciprocal_edges

13 changes: 13 additions & 0 deletions _sources/generated/probinet.main.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
probinet.main
=============

.. automodule:: probinet.main


.. rubric:: Functions

.. autosummary::

main
parse_args

Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
probinet.model\_selection.acd\_cross\_validation
================================================

.. automodule:: probinet.model_selection.acd_cross_validation


.. rubric:: Classes

.. autosummary::

ACDCrossValidation

Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
probinet.model\_selection.crep\_cross\_validation
=================================================

.. automodule:: probinet.model_selection.crep_cross_validation


.. rubric:: Classes

.. autosummary::

CRepCrossValidation

Loading

0 comments on commit d8427b0

Please sign in to comment.