From 8f7ed801f3483cba7880dcc940bd73b475d2cc49 Mon Sep 17 00:00:00 2001 From: Patrick Juen Date: Wed, 19 Jun 2024 16:09:37 +0800 Subject: [PATCH] add some simple docs --- tools/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 tools/README.md diff --git a/tools/README.md b/tools/README.md new file mode 100644 index 0000000..073617c --- /dev/null +++ b/tools/README.md @@ -0,0 +1,16 @@ +# run-benchmark.sh +### Prerequisites +1. Write access to the zero-bin-bcw repo + +### Steps +1. Go to https://github.com/BCWResearch/zero-bin-bcw/actions/workflows/benchmark.yml +1. Click Run workflow on the right of the page +1. Input the parameters needed for the test then click `Run Workflow` +1. Wait for your test run to appear, then click on it to view logs of the script. + + +### Tips +- View the logs of zero-bin-leader to get a better idea of the current progress. (A link will be printed in the script) +- If you expect a fast test run and the pipeline doesn't finish fast enough, check the zero-bin logs. If there is an error, you can cancel the pipeline and debug. +- Set the `block_start` and `block_end` to the same value to test only 1 block. +- By default, always set the same values for CPU requests/limits and memory requests/limits.