add reading config, add and update docs

This commit is contained in:
askiiart 2024-12-26 12:18:16 -06:00
parent e9af17baf0
commit bd880f4f5f
Signed by untrusted user who does not match committer: askiiart
GPG key ID: EA85979611654C30
9 changed files with 265 additions and 89 deletions

View file

@ -0,0 +1,38 @@
# Default `max-threads`
The default `max-threads` uses a simple algorithm to get how many threads.
```rs
if total_threads >= 32 {
return total_threads - 4;
} else if total_threads >= 12 {
return total_threads - 2;
} else if total_threads >= 3 {
return total_threads - 1;
} else {
return total_threads;
}
```
i.e. with `total_threads` as the number of threads the CPU(s) has:
- If the CPU has 32 or more threads, it will use all but 4 threads
- If the CPU has 12 or more threads, it will use all but 2 threads
- If the CPU has 3 or more threads, it will use all but 1 thread
- Otherwise, i.e. if the CPU has 1 to 2 threads, it will use all threads
---
Alternative algorithms I tried:
```rs
if total_threads >= 32 {
return total_threads - total_threads.div_ceil(10);
} else if total_threads >= 12 {
return total_threads - 2;
} else if total_threads >= 3 {
return total_threads - 1;
} else {
return total_threads;
}
```