GroupMultiNeSS 0.0.1__py3-none-any.whl

groupmultiness-0.0.1.dist-info/METADATA

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: GroupMultiNeSS
+Version: 0.0.1
+Summary: GroupMultiNeSS package
+Author: Alexander Kagan
+Author-email: <amkagan@umich.edu>
+Keywords: python,multiplex networks,multiness,latent space models
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Education
+Classifier: Programming Language :: Python :: 2
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy<2
+Requires-Dist: scipy
+Requires-Dist: typing
+Requires-Dist: joblib
+Requires-Dist: matplotlib
+Requires-Dist: seaborn
+Requires-Dist: statsmodels
+Requires-Dist: scikit-learn
+Requires-Dist: more_itertools
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: keywords
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
+
+# GroupMultiNeSS
+
+GroupMultiNeSS is a package for statistical modeling of multilayer networks. It implements multiple approaches allowing to extract shared, group, and individual latent structures from a collection of networks on a shared set of nodes. Specifically, it contains the implementation of fitting sampling procedures for the following models:
+- GroupMultiNeSS [Kagan et al. (2025)] - likelihood based approach with nuclear norm penalization, accounts for the additional group latent structure
+- MultiNeSS [[MacDonald et al. (2021)](https://arxiv.org/abs/2012.14409)] - likelihood based approach with nuclear norm penalization
+- MultiNeSS [[Tian et al. (2024)](https://arxiv.org/abs/2412.02151)] - likelihood based approach with pre-estimation of latent ranks via Shared Space Hunting algorithm
+- COSIE ([Arroyo et al.](https://arxiv.org/abs/1906.10026)) - spectral-based Multiple Adjacency Spectral Embedding algorithm
+
+## Installation
+
+Use the package manager [pip](https://pip.pypa.io/en/stable/) to install GroupMultiNeSS.
+
+```bash
+pip install GroupMultiNeSS
+```
+
+## Usage
+
+```python
+# Imports
+import numpy as np
+from GroupMultiNeSS.group_multiness import GroupMultiNeSS
+from GroupMultiNeSS.data_generation import GroupLatentPositionGenerator
+from GroupMultiNeSS.utils import make_group_indices
+
+
+# Sample true latent positions and group indices
+n, M, K = 200, 16, 4
+group_props = np.ones(K) / K  # make ballanced groups
+group_indices = make_group_indices(group_props, M)
+
+lpg = GroupLatentPositionGenerator(n_nodes=n, n_layers=M, group_indices=group_indices)
+lpg.generate(random_seed=1)
+
+As, Ps_true, S_true, Qs_true, Rs_true = lpg.As, lpg.Ps, lpg.S, lpg.Qs, lpg.Rs
+
+# Fit GroupMultiNeSS model and compute the relative errors with ground-truth
+group_multiness = GroupMultiNeSS(group_indices, n_jobs=K)
+group_multiness.fit(As, lr=0.8)
+print(group_multiness.make_final_error_report(S_true, Qs_true, Rs_true, Ps=Ps_true))
+
+# {'Shared component': 0.026, 'Group components': 0.051, 'Individual components': 0.122, 'Ps': 0.077}
+```
+
+
+## License
+
+MIT License
+
+Copyright (c) 2024 Alexander Kagan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

groupmultiness-0.0.1.dist-info/RECORD

@@ -0,0 +1,13 @@
+GroupMultiNeSS/MASE.py,sha256=kOD-eQwmUerAGP_A8clsY_3qgP87udskfc60sOsjpgI,2567
+GroupMultiNeSS/__init__.py,sha256=WZ2Do-k-PX1OypOsY3c_D4QnusQWKJSBoXkCLbu-Bcw,184
+GroupMultiNeSS/base.py,sha256=-7hMNbIYmmDMbnKBwk1co3LJbzd_zHhj8RlZUzffGoY,13201
+GroupMultiNeSS/data_generation.py,sha256=rsibPtIP0MRD-q1gYm5ZfAuizkZ_aqAlxVxW6JWmQl8,10054
+GroupMultiNeSS/group_multiness.py,sha256=SUkDtKI68NwbViz2W5aRkIY5lBMcSecA3sRCGTkiGuw,20682
+GroupMultiNeSS/multiness.py,sha256=HhPVYyczCfTyYexXePREpjHyMTW1lTiLYYawp94P7-c,51730
+GroupMultiNeSS/shared_space_hunting.py,sha256=UECCojow7_T3PTwni6z4yvGtl-FW8LZ6kLqd9A4j5Ts,11358
+GroupMultiNeSS/utils.py,sha256=Pf7L98BOu-5lwJzfps3eLb68O-cqoLY4LJgrdq8Sm9w,14376
+groupmultiness-0.0.1.dist-info/licenses/LICENSE,sha256=-hCOCPtJQua-P_LOnoVJqiUdoSPaXVfTuZK9hUgRhP4,1073
+groupmultiness-0.0.1.dist-info/METADATA,sha256=8VPsWjPXsPYS0n3cHR9QoIzRokbpSGGXoF13Fam-St8,4105
+groupmultiness-0.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+groupmultiness-0.0.1.dist-info/top_level.txt,sha256=7O72OAwdClTmr42odDwkGp_eIkoUCO69Ou8MOHQqRV4,15
+groupmultiness-0.0.1.dist-info/RECORD,,

groupmultiness-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

groupmultiness-0.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 Alexander Kagan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

groupmultiness-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+GroupMultiNeSS