search

skinniderlab / CLM

MIT License
0 stars 0 forks source link

config documentation #227

Open skinnider opened 1 month ago

skinnider commented 1 month ago

I might be missing it, but is there documentation for what each of the parameters in config.yaml controls? This occurred to me specifically because I wasn't sure what min_tc is in the new workflow - is this the threshold for structural prior by min. Tc (e.g. 0.4, 0.675, 1)? https://github.com/skinniderlab/CLM/blob/0f699acaa1afa28bf64d0545bdbf38b7dd8d6fb7/workflow/config/config.yaml#L41

vineetbansal commented 1 month ago

@skinnider - we'll add inline documentation for each of these config parameters (that was our motivation in moving from json to yml for configuration anyway). Let's keep this open till we do so.

For min_tc - this is the min_tc used during training set generation and serves as the similarity for within the training data (across folds). I believe the min_tc in structural prior by min. Tc is hardcoded here and doesn't entail data generation.

If we need to pull it out a a config option, maybe we create a new issue for it?

skinnider commented 1 month ago

Got it. No need to pull it out as a config option - sounds like this will be resolved with the addition of documentation for the parameters.