diff --git a/README.md b/README.md index 7e1a753..7583385 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,36 @@ We are researching the methods and implement the methods that can accelerate mul ## mopro-msm -This is the crate that possess various of implementation of MSM functions, which are integrated in `mopro-core`. +This is the crate that possess various of implementation of MSM functions, which are integrated in `mopro-core`. + +### Run benchmark on the laptop +Currently we support these MSM algorithms on BN254 +- arkworks_pippenger +- bucket_wise_msm +- precompute_msm +- metal::msm (GPU) + +Replace `MSM_ALGO` with the algorithm name below to get the benchmarks + +Benchmarking for single instance size +```sh +cargo test --release --package mopro-msm --lib -- msm::MSM_ALGO::tests::test_run_benchmark --exact --nocapture +``` + +Benchmarking for multiple instance size +```sh +cargo test --release --package mopro-msm --lib -- msm::MSM_ALGO::tests::test_run_multi_benchmarks --exact --nocapture +``` ## gpu-exploration-app This is a benchmark app to compare the performance of different algorithm on IOS device. + +Run this command on the project root directory to compile metal library for OS +```sh +# for macOS +bash mopro-msm/src/msm/metal/compile_metal.sh + +# for iphoneOS +bash mopro-msm/src/msm/metal/compile_metal_iphone.sh +``` diff --git a/gpu-acceleration-app/README.md b/gpu-acceleration-app/README.md index 1f1a9a4..45fed4f 100644 --- a/gpu-acceleration-app/README.md +++ b/gpu-acceleration-app/README.md @@ -14,7 +14,7 @@ CONFIGURATION=debug cargo run --bin ios ### running Benchmarks on IOS devices -1. Make sure you are in `./mopro-msm/gpu-acceleartion-app/`. +1. Make sure you are in `./gpu-acceleartion-app/`. 2. Run `CONFIGURATION=release cargo run --bin ios` for release building.