Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
saienduri committed Oct 30, 2024
1 parent f40d0e6 commit f731cf2
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ This repo is configured with a custom Github runner donated by AMD. You can queu
The main things you need to run your own benchmark
1. In `kernels/` create a new file that must start with the name `test_`. This is because we use `pytest` to discover your kernel
2. If you want your benchmark results to persist in a Github Artifact, we recommend using the builtin Triton `benchmark.run(save_path="./perf-artifacts/your_kernel", show_plots=True, print_data=True)`
3. In your PR, if you don't want to run testing on all the kernels, you can specify a specific kernel you want
to test by adding a line like the following to your PR description: "ci-exactly: <test-file-name.py>" as seen
in this PR: [Example](https://github.com/gpu-mode/amd-cluster/pull/3)

Have fun! We intend for this to be a social repo, if you have any other requests for things we could do better please let us know!

Expand Down

0 comments on commit f731cf2

Please sign in to comment.