BAPCtools icon indicating copy to clipboard operation
BAPCtools copied to clipboard

Generators: reconsider -f --samples defaults

Open thorehusfeldt opened this issue 9 months ago • 1 comments

The generators framework work very smoothly, but I now constantly get tripped up in the following dance:

> bt generate
PROBLEM closestpairscoring
Generate: sample/2                    SKIPPED: 2.ans; supply -f --samples to overwrite
Generate: sample/1                    SKIPPED: 1.ans; supply -f --samples to overwrite
Generate: sample/3                    SKIPPED: 3.ans; supply -f --samples to overwrite
^[[A^CFATAL ERROR: Running interrupted[######################---------------------------------------------------------------------------------- 11/48]
> bt generate -f --samples
PROBLEM closestpairscoring
Generate: sample/2                    CHANGED 2.ans
Generate: sample/1                    CHANGED 1.ans
Generate: sample/3                    CHANGED 3.ans

The -f --samples tradition targets a workflow where sample typically are provided as files in data/samples, but the new framework much prefers to have everything in generators/generators.yaml.

This confuses two recommendations for what “the expected workflow” is; an author that follows best practice should be supported by default settings.

Suggestions:

  1. drop the default SKIPPED behaviour
  2. introduce config.I_know_what_Im_doing_shut_up or config.this_contest_has_some_people_with_dirty_samples somewhere (presumably with a better name)
  3. make BAPC check if all files in data are mentioned in generators.yaml. If so, assume the author knows what they’re doing and set the default to -f --sample. (This is very hard to document an can lead to unexpected behaviour.)

thorehusfeldt avatar Sep 06 '23 07:09 thorehusfeldt