update docs for threads=auto

This commit is contained in:
Jonathan Shook 2020-07-17 17:30:32 -05:00
parent d6c06cf7e2
commit 60360b459f

View File

@ -88,6 +88,13 @@ _default value_ : For now, the default is simply *1*. Users must be
aware of this setting and adjust it to a reasonable value for their
workloads.
`threads=_auto_` : When you set `threads=auto`, it will set the number of threads to 10x the number of cores
in your system. There is no distinction here between full cores and hardware threads. This is generally
a reasonable number of threads to tap into the procesing power of a client system.
`threads=_n_x` : When you set `threads=5x` or `threads=10x`, you will set the number of threads to some multiplier
of the logical CPUs in the local system.
:::info
The threads parameter will work slightly differently for activities using the async parameter. For example, when
`async=500` is provided, then the number of async operations is split between all configured threads, and each thread
@ -159,12 +166,18 @@ The stride is initialized to the calculated sequence length. The
sequence length is simply the number of operations in the op sequence
that is planned from your active statements and their ratios.
You usually do not want to set the stride directly. If you do, make sure
it is a multiple of what it would normally be set to if you need to ensure
that sequences are not divided up differently. This can be important when
simulating the access patterns of applications.
:::info
When simulating multi-op access patterns in non-async mode, the
stride metric can tell you how long it took for a whole group of
operations to complete.
:::
## async
- `async=<ops>`
@ -228,6 +241,10 @@ Examples:
- `cyclerate=1000,1.5` - same as above, with burst rate set to 1.5 (aka
50% burst allowed)
Synonyms:
- `rate`
- `targetrate`
### burst ratio
This is only an optional part of the cyclerate as shown in examples