Skip to content

Commit

Permalink
added hungarian readme and link
Browse files Browse the repository at this point in the history
  • Loading branch information
acostadon committed May 21, 2024
1 parent 1f4fb13 commit 73ab098
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/cugraph/source/graph_support/algorithms.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Note: Multi-GPU, or MG, includes support for Multi-Node Multi-GPU (also called M
| Layout | | | |
| | [Force Atlas 2](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/layout/Force-Atlas2.ipynb) | Single-GPU | |
| Linear Assignment | | | |
| | [Hungarian]() | Single-GPU | [README](https://docs.rapids.ai/api/cugraph/nightly/api_docs/cugraph/linear_assignment/#hungarian) |
| | [Hungarian](https://docs.rapids.ai/api/cugraph/nightly/api_docs/cugraph/linear_assignment/#hungarian) | Single-GPU | [README](./algorithms/cpp_algorithms/linear_cpp.html) |
| Link Analysis | | | |
| | [Pagerank](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/link_analysis/Pagerank.ipynb) | __Multi-GPU__ | [C++ README](./algorithms/cpp_algorithms/centrality_cpp.html#Pagerank) |
| | [Personal Pagerank](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/link_analysis/Pagerank.ipynb) | __Multi-GPU__ | [C++ README](./algorithms/cpp_algorithms/centrality_cpp.html#Personalized-Pagerank) |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# LAP

Implementation of ***O(n^3) Alternating Tree Variant*** of Hungarian Algorithm on NVIDIA CUDA-enabled GPU.

This implementation solves a batch of ***k*** **Linear Assignment Problems (LAP)**, each with ***nxn*** matrix of single floating point cost values. At optimality, the algorithm produces an assignment with ***minimum*** cost.

The API can be used to query optimal primal and dual costs, optimal assignment vector, and optimal row/column dual vectors for each subproblem in the batch.

cuGraph exposes the Hungarian algorithm, the actual implementation is contained in the RAFT library which contains some common tools and kernels shared between cuGraph and cuML.

Following parameters can be used to tune the performance of algorithm:

1. epsilon: (in raft/lap/lap_kernels.cuh) This parameter controls the tolerance on the floating point precision. Setting this too small will result in increased solution time because the algorithm will search for precise solutions. Setting it too high may cause some inaccuracies.

2. BLOCKDIMX, BLOCKDIMY: (in raft/lap/lap_functions.cuh) These parameters control threads_per_block to be used along the given dimension. Set these according to the device specifications and occupancy calculation.

***This library is licensed under Apache License 2.0. Please cite our paper, if this library helps you in your research.***

- Harvard citation style

Date, K. and Nagi, R., 2016. GPU-accelerated Hungarian algorithms for the Linear Assignment Problem. Parallel Computing, 57, pp.52-72.

- BibTeX Citation block to be used in LaTeX bibliography file:

```
@article{date2016gpu,
title={GPU-accelerated Hungarian algorithms for the Linear Assignment Problem},
author={Date, Ketan and Nagi, Rakesh},
journal={Parallel Computing},
volume={57},
pages={52--72},
year={2016},
publisher={Elsevier}
}
```

The paper is available online on [ScienceDirect](https://www.sciencedirect.com/science/article/abs/pii/S016781911630045X).

0 comments on commit 73ab098

Please sign in to comment.