Skip to content

CompNet/SignedStabilityBenchmark

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SignedStabilityBenchmark

Generation of random signed networks with a planted optimal partition and the evaluation of some partitioning methods with respect to the Correlation Clustering (CC) Problem

  • Copyright 2020-21 Nejat Arınık

SignedStabilityBenchmark is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation. For source availability and license information see the file LICENCE


Description

This set of R and Julia scripts was designed to generate random signed networks, where we know their optimal solutions by construction thanks to the definition of stability range and to apply some partitioning methods onto these networks. These partitioning methods aim to solve the Correlation Clustering Problem. Although it is possible to run many partitioning methods, in this repository we mainly use the CoNS(nbMaxEdit) method, integrated in the EnumCC method, which aims to explore the direct neighbor optimal solutions of a given optimal solution up to distance nbMaxEdit. See our article [Arınık'21] for more details.

Data

The details about the generator are explained in [Arınık'21]. All our results, as well as our generated signed networks with their optimal solutions, are publicly available on FigShare (article_materials/Dataset1-experiment).

To show explicitly the folder structure used in the signed graph generation and for a quick test, we have already put some generated networks in in/random-networks and some corresponding optimal partitions in out/partitions.

Organization

Here are the folders composing the project:

  • Folder src: contains the source code (R scripts).
  • Folder in: contains the generated signed networks.
  • Folder lib: contains executable files related to the used external partitioning methods.
    • Folder ExCC: Executable file of the method ExCC whose the name will be cplex-partition.jar. See the Installation section for more details.
  • Folder out: contains the folders and files produced by our scripts. See the Use section for more details.

Installation

  1. Install the R language
  2. Install the Julia language
  3. Install the following R packages (R is tested with the version 4.1):
  4. Install the following Julia packages (Julia is tested with the version 1.6.2):
  5. Install IBM CPlex. Tested with the versions 12.8 and 20.1. Set correctly the variable CPLEX.BIN.PATH in define-algos.R (e.g. /opt/ibm/ILOG/CPLEX_Studio128/cplex/bin/x86-64_linux/).
    • For ubuntu, type the following command:
      • sudo ./cplex_studio<YOUR_VERSION>.linux-x86-64.bin
        • The default installation location for education version is: /opt/ibm/ILOG/CPLEX_Studio<YOUR_VERSION.
        • The default installation location for trial version is: /opt/ibm/ILOG/CPLEX_Studio_Community<YOUR_VERSION/cplex/bin/x86-64_linux/.
  6. Download the project of ExCC on github. First, configure and then compile it. To test it, you can run the file run.sh.If everything works (i.e. if a file sol0.txt created in the output folder), move the executable file ExCC.jar, which is in exe, into the lib/ExCC folder in this project.
  7. Download the project of EnumCC on github. Move the executable files EnumCC.jar and RNSCC.jar into the lib/EnumCC folder in this project.

Use

  1. Set correctly the variables CPLEX.BIN.PATH.
  2. Open the R console.
  3. Set the current directory as the working directory, using setwd("<my directory>").
  4. Run the main script src/main.R.

The script will produce the following subfolders in the folder out:

  • benchmark-analysis/partitions: Folder containing all obtained partitions.
  • benchmark-analysis/csv: Folder containing all csv results, as well as their corresponding plots (as in the submitted article).

References

  • [Arınık'21] N. Arınık & R. Figueiredo & V. Labatut. Efficient Enumeration of Correlation Clustering Optimal Solution Space (submitted), Journal of Global Optmization, 2021.