Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #15

Merged
merged 1 commit into from
Dec 10, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,35 @@
# mopro msm gpu-acceleration

We are researching the methods and implement the methods that can accelerate multi-scalar multiplication (MSM) on IOS mobile device.
We are researching and implementing methods to accelerate multi-scalar multiplication (MSM) on IOS mobile device.

## mopro-msm

This is the crate that possess various of implementation of MSM functions, which are integrated in `mopro-core`.
This is a of various implementations of MSM functions, which are then integrated in `mopro-core`.

### Run benchmark on the laptop
Currently we support these MSM algorithms on BN254
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
Replace `MSM_ALGO` with one of the algorithms above to get the corresponding benchmarks.

Benchmarking for <u>single instance size</u>
Benchmarking for <u>single instance size</u>:
```sh
cargo test --release --package mopro-msm --lib -- msm::MSM_ALGO::tests::test_run_benchmark --exact --nocapture
```

Benchmarking for <u>multiple instance size</u>
Benchmarking for <u>multiple instance size</u>:
```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.
This is a benchmark app to compare the performance of different algorithms on iOS device.

Run this command on the project root directory to compile metal library for OS
You can run the following commands in the root directory of the project to compile the metal library for a given OS:
```sh
# for macOS
bash mopro-msm/src/msm/metal/compile_metal.sh
Expand Down
Loading