From 9f0fa6afa69f909c8179e70bea77e20cb0ad6b30 Mon Sep 17 00:00:00 2001 From: Nikolai Maas Date: Mon, 9 Dec 2024 12:55:50 +0100 Subject: [PATCH] move file format documentation --- README.md | 6 +++--- FileFormats.md => mt-kahypar/io/docs/FileFormats.md | 0 2 files changed, 3 insertions(+), 3 deletions(-) rename FileFormats.md => mt-kahypar/io/docs/FileFormats.md (100%) diff --git a/README.md b/README.md index 69d479507..20921ffd4 100644 --- a/README.md +++ b/README.md @@ -152,7 +152,7 @@ To partition a **graph** with Mt-KaHyPar, you can add the following command line -h --instance-type=graph --input-file-format= -o cut -Mt-KaHyPar then uses optimized data structures for graph partitioning, which speeds up the partitioning time by a factor of two compared to our hypergraph partitioning code. Per default, we expect the input in [hMetis format](FileFormats.md#hmetis-format-for-input-hypergraphs), but you can read graph files in [Metis format](FileFormats.md#metis-format-for-input-graphs) via `--input-file-format=metis`. +Mt-KaHyPar then uses optimized data structures for graph partitioning, which speeds up the partitioning time by a factor of two compared to our hypergraph partitioning code. Per default, we expect the input in [hMetis format](mt-kahypar/io/docs/FileFormats.md#hmetis-format-for-input-hypergraphs), but you can read graph files in [Metis format](mt-kahypar/io/docs/FileFormats.md#metis-format-for-input-graphs) via `--input-file-format=metis`. ### Mapping (Hyper)Graphs onto Graphs @@ -160,11 +160,11 @@ To map a **(hyper)graph** onto a **target graph** with Mt-KaHyPar, you can add t -g -o steiner_tree -The target graph is expected to be in [Metis format](FileFormats.md#metis-format-for-input-graphs). The nodes of the (hyper)graph are then mapped onto the nodes of the target graph, while optimizing the Steiner tree metric (see [Supported Objective Functions](#supported-objective-functions)). +The target graph is expected to be in [Metis format](mt-kahypar/io/docs/FileFormats.md#metis-format-for-input-graphs). The nodes of the (hyper)graph are then mapped onto the nodes of the target graph, while optimizing the Steiner tree metric (see [Supported Objective Functions](#supported-objective-functions)). ### Fixed Vertices -Fixed vertices are nodes that are preassigned to particular block and are not allowed to change their block during partitioning. Mt-KaHyPar reads fixed vertices from a file in the [hMetis fix file format](FileFormats.md#hmetis-fix-file-format), which can be provided via the following command line parameter: +Fixed vertices are nodes that are preassigned to particular block and are not allowed to change their block during partitioning. Mt-KaHyPar reads fixed vertices from a file in the [hMetis fix file format](mt-kahypar/io/docs/FileFormats.md#hmetis-fix-file-format), which can be provided via the following command line parameter: -f diff --git a/FileFormats.md b/mt-kahypar/io/docs/FileFormats.md similarity index 100% rename from FileFormats.md rename to mt-kahypar/io/docs/FileFormats.md