From 52f87e915310df47a0a7f698e32b8523218c5170 Mon Sep 17 00:00:00 2001 From: Micha Birklbauer Date: Mon, 31 Jul 2023 15:07:47 +0200 Subject: [PATCH] add documentation --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4446398..ae06e39 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,10 @@ Searching for candidates using sparse matrix + [sparse] vector/matrix multiplication. Implements the following methods across two DLLs: -- VectorSearch.dll: +- [VectorSearch.dll](https://github.com/hgb-bin-proteomics/CandidateVectorSearch/blob/master/VectorSearch/dllmain.cpp): - findTopCandidates: sparse matrix - sparse vector multiplication using [Eigen](https://eigen.tuxfamily.org/). - findTopCandidatesBatched: sparse matrix - sparse matrix multiplication using [Eigen](https://eigen.tuxfamily.org/). -- VectorSearchCUDA.dll: +- [VectorSearchCUDA.dll](https://github.com/hgb-bin-proteomics/CandidateVectorSearch/blob/master/VectorSearchCUDA/dllmain.cpp): - findTopCandidates: sparse matrix - dense vector multiplication using [CUDA](https://developer.nvidia.com/cuda-toolkit) ([SpMV](https://docs.nvidia.com/cuda/cusparse/index.html#cusparsespmv)). - findTopCandidatesBatched: sparse matrix - sparse matrix multiplication using [CUDA](https://developer.nvidia.com/cuda-toolkit) ([SpGEMM](https://docs.nvidia.com/cuda/cusparse/index.html#cusparsespgemm)). - findTopCandidatesBatched2: sparse matrix - dense matrix multiplication using [CUDA](https://developer.nvidia.com/cuda-toolkit) ([SpMM](https://docs.nvidia.com/cuda/cusparse/index.html#cusparsespmm)). @@ -15,6 +15,12 @@ VectorSearch.dll implements functions that run on the CPU, while VectorSearchCUD Which functions should be used depends on the problem size and the available hardware. A recommendation is depicted at the figure at the bottom. +## Documentation + +Functions are documented within the source code: +- [VectorSearch.dll](https://github.com/hgb-bin-proteomics/CandidateVectorSearch/blob/master/VectorSearch/dllmain.cpp) +- [VectorSearchCUDA.dll](https://github.com/hgb-bin-proteomics/CandidateVectorSearch/blob/master/VectorSearchCUDA/dllmain.cpp) + ## Benchmarks tbd