Skip to content

Commit ce7df5e

Browse files
authored
added TOC to readme
1 parent db37a30 commit ce7df5e

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@ Pang is free software: you can redistribute it and/or modify it under the terms
99
# Description
1010
Pang is an algorithm which represents and classifies a collection of graphs according to their frequent patterns (subgraphs).
1111

12+
**Content**
13+
* [Organization](#organization)
14+
* [Installation](#installation)
15+
* [Usage](#usage)
16+
* [Dependencies](#dependencies)
17+
* [References](#references)
1218

1319
# Organization
1420
This repository is composed of the following elements:
@@ -44,10 +50,10 @@ Note that SPMF is available both as a JAR and as source code archive. However, t
4450
**TODO In order to run the script that reproduces our ECML PKDD experiments, you also need to install CORK.**
4551

4652
## Data
47-
Third, you need to set up the data to which you want to apply Pang. This can be the dataset from our paper, in which you will need to unzip several archives, or your own data, in which case they need to be respect the appropriate format. In both cases, see cf. Section [Use](#use).
53+
Third, you need to set up the data to which you want to apply Pang. This can be the dataset from our paper, in which you will need to unzip several archives, or your own data, in which case they need to be respect the appropriate format. In both cases, see cf. Section [Usage](#usage).
4854

4955

50-
# Use
56+
# Usage
5157
We provide two scripts to use Pang:
5258

5359
* `ECML.py`: reproduces the experiments described in our paper submitted to ECML PKDD.

0 commit comments

Comments
 (0)