feat: add some README notes on available settings #1177
Conversation
|
Review feedback/corrections for docs is most useful as a commit/update to this branch. |
Sure, please add! |
|
@dignifiedquire Can you add a short description for the parents cache, including any constraints or considerations controlling how that value should be set? |
cryptonemo
force-pushed
the
readme-updates
branch
3 times, most recently
from
57deff4 to
51ae3e7
Compare
feat: allow an env configurable parent cache location
cryptonemo
force-pushed
the
readme-updates
branch
from
51ae3e7 to
7060637
Compare
README.md
Outdated
|
|
||
| ### Memory | ||
| A related setting that can also be tuned is the SDR parents cache size. This value is defaulted to 2048 nodes, which is the equivalent of 384KiB of resident memory (where each cached node is (6 * 32) = 192 bytes in length). Given that the cache is now located on disk, it is memory mapped when accessed in window sizes related to this variable. This default was chosen to minimize memory while still allowing efficient access to the cache. If you would like to experiment with alternate sizes, you can modify the environment variable |
There was a problem hiding this comment.
@dignifiedquire Can you check that my sizes above are sane? I pulled those out from looking at the code, but there was a comment you made elsewhere that indicated each cached node was 56 bytes (i.e. using 112KiB RAM), so I'm looking for clarification/corrections here.
There was a problem hiding this comment.
Thanks for clarifying, it's been updated.
| @@ -17,6 +18,7 @@ use storage_proofs_core::{ | |||
| use super::graph::{StackedGraph, DEGREE}; | |||
|
|
|||
| /// Path in which to store the parents caches. | |||
| pub const PARENT_CACHE_ENV_VAR: &str = "FIL_PROOFS_PARENT_CACHE"; | |||
There was a problem hiding this comment.
why not use settings.rs for this?
There was a problem hiding this comment.
I went with the existing approach taken by the PARAMETER_CACHE
There was a problem hiding this comment.
But can move them both to settings
feat: update pairing dependency feat: move parameter and parent cache path to settings
Addresses #1172