baler-collaboration / baler

Repository of Baler, a machine learning based data compression tool
https://github.com/baler-collaboration/baler.github.io
Apache License 2.0
31 stars 26 forks source link

Documentation explaining the flags in the config file #296

Closed urania277 closed 8 months ago

urania277 commented 1 year ago

At the moment, the user needs to reverse engineer the flags in the config file by going back to the code. This is not necessarily ideal, so we should have a page documenting what flags (with units) we have available.

Example format for this page/README:

variable name units description
c.test_size percentage Toggles dataset split into training/validation and defines percentage of dataset that is used for validation