Skip to content

Commit a278094

Browse files
Update documentation for new Ractor benchmarks
1 parent 19917c6 commit a278094

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,43 @@ It's also convenient for profiling, debugging, etc, especially since all benchma
101101
ruby benchmarks/some_benchmark.rb
102102
```
103103

104+
## Ractor Benchmarks
105+
106+
ruby-bench supports Ractor-specific benchmarking with dedicated categories and benchmark directories.
107+
108+
### Ractor Categories
109+
110+
There are two Ractor-related categories:
111+
112+
* **`--category ractor`** - Runs both regular benchmarks marked with `ractor:
113+
true` in `benchmarks.yml` AND all benchmarks from the `benchmarks-ractor`
114+
directory. The `harness-ractor` harness is used for both types of benchmark.
115+
116+
* **`--category ractor-only`** - Runs ONLY benchmarks from the
117+
`benchmarks-ractor` directory, ignoring regular benchmarks even if they are
118+
marked with `ractor: true`. This category also automatically uses the
119+
`harness-ractor` harness.
120+
121+
### Directory Structure
122+
123+
The `benchmarks-ractor/` directory sits at the same level as the main
124+
`benchmarks` directory, and contains Ractor-specific benchmark
125+
implementations that are designed to test Ractor functionality. They are not
126+
intended to be used with any harness except `harness-ractor`.
127+
128+
### Usage Examples
129+
130+
```bash
131+
# Run all Ractor-capable benchmarks (both regular and Ractor-specific)
132+
./run_benchmarks.rb --category ractor
133+
134+
# Run only dedicated Ractor benchmarks from benchmarks-ractor directory
135+
./run_benchmarks.rb --category ractor-only
136+
```
137+
138+
Note: The `harness-ractor` harness is automatically selected when using these
139+
categories, so there's no need to specify `--harness` manually.
140+
104141
## Ruby options
105142

106143
By default, ruby-bench benchmarks the Ruby used for `run_benchmarks.rb`.

0 commit comments

Comments
 (0)