everyvoice inspect-checkpoint -h ( -C -A should be on it's own line) / need more error messages

[marctessier]

Bug description

I was noticing that when we run :

everyvoice inspect-checkpoint -h
or soon after pr722
everyvoice checkpoint inspect --help

The help message options on screen is not placed at the right spot for these 2 options ex:

--no-show-config -C
also
--no-show-architecture -A

should be displayed on it own separate line under Options. Having the 2 options on the same line makes it strange VS how other help messages we display. It's also strange that we have the -c or -a since they are both on by default or if we define one or the other , both will be used anyways. ( Not sure if that is just adding noice to the help message ? Also command like this below works where we should probably display a proper error message / help example?

everyvoice inspect-checkpoint -c -C -A -a ./last.ckpt
or this
everyvoice inspect-checkpoint -C -A ./last.ckpt <- but nothing is displayed ;-0

everyvoice checkpoint inspect --help
                                                                                                                  
 Usage: everyvoice checkpoint inspect [OPTIONS] MODEL_PATH                                                        
                                                                                                                  
 Given an EveryVoice checkpoint, show information about the configuration used during training, the model's       
 architecture and the number of weights per layer and total weight count.                                         
                                                                                                                  
                                                                                                                  
╭─ Arguments ────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ *    model_path      FILE  The path to your model checkpoint file.                                             │
│                            [default: None]                                                                     │
│                            [required]                                                                          │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --show-config        -c  --no-show-config        -C    Show the configuration used during training             │
│                                                        [default: show-config]                                  │
│ --show-architecture  -a  --no-show-architecture  -A    Show the model's architecture                           │
│                                                        [default: show-architecture]                            │
│ --help               -h                                Show this message and exit.                             │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

How to reproduce the bug

everyvoice  inspect-checkpoint  -h 
or soon after pr722
everyvoice checkpoint inspect --help

Error messages and logs

None

Environment

More info

No response

[joanise]

Some feedback here...

I think everyvoice inspect-checkpoint -c -C -A -a ./last.ckpt working is not an error: the philosophy of toggle switches is that if you have a shell alias that sets it to yes or no, you can repeat it again after to override.

So everyvoice inspect-checkpoint -C -C -c -c -C -c ./last.ckpt should also work, and it's the last instance of either -c or -C that prevails, in this case the config should get shown. This is the philosophical reason a "turn it on" switch exists even if it's on by default: it lets you override the "off" switch that might be set in an alias you're using or in a command you're constructing in a script.

I don't understand the comment about everyvoice inspect-checkpoint -C -A ./last.ckpt. That should be valid, and it's disabling both displaying the config and displaying the architecture, so it's supposed to be silent. My understanding is that that is the whole point of these flags.

As for how the help is displayed, my understanding is that since these are opposite flags that turn the feature on or off, putting them on the same line is logical. Would changing Show the configuration used during training and Show the model's architecture to Show/hide the ... make it clearer/more explicit that it's a toggle switch pair? Or Show or hide the ...?