Name : MINRES is very confusing

skojaku / core-periphery-detection

Python package for detecting core-periphery structure in networks.

Apache License 2.0

47 stars 5 forks source link

Name : MINRES is very confusing #5

Closed skojaku closed 3 years ago

skojaku commented 3 years ago

The Boyd's paper in 2010, which proposed the MINRES algorithm, finds a continuous core-periphery structure. The name MINRES is therefore reserved for this algorithm. However, in cpnet package, we call Lip's algorithm as MINRES. Clarification is needed.

skojaku commented 3 years ago

[x] Rewrite the doc string in sphinx format
[x] set up test env
[x] generate readthedoc

skojaku commented 3 years ago

The following changes have been made and thus this issue is closed now.

Rename the MINRES to Lip Algorithm
Implement the (genuine) MINRES algorithm proposed in Boyd et al. 2010, Social Net.