Skip to content

add some simple docs #63

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 19, 2024
Merged

add some simple docs #63

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 16 additions & 0 deletions tools/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Loading