search

clamsproject / app-swt-detection

CLAMS app for detecting scenes with text from video input
Apache License 2.0
1 stars 0 forks source link

Record all parameter values (including defaults) in output MMIF #84

Closed owencking closed 8 months ago

owencking commented 8 months ago

New Feature Summary

Desired functionality:
When the SWT app is run, the values of all parameters, including those implicitly assigned default values, are recorded in views > n > metadata > parameters

In v4.1 (and previous versions), parameters are recorded in the MMIF only if they were set explicitly at runtime.

Since different versions of the same app can have different default values for the parameters, having all the parameter values explicitly recorded in the MMIF makes it easier to investigate how a particular MMIF file was generated.

Related

No response

Alternatives

No response

Additional context

This seems to me like desirable functionality to have in all CLAMS apps, not only SWT.

keighrim commented 8 months ago

This was actually discussed in https://github.com/clamsproject/mmif/issues/208, then reverted via https://github.com/clamsproject/mmif/pull/216. We can always revisit our previous decision, but a couple things to note;

  1. we can't (re-)use view::metadata::parameters for this, as we want to keep that field for pure user inputs (for reproducibility and accountability)
  2. which leads to an addition of a new field, that will lead to a "breaking" change in MMIF json scheme and will end up with MMIF 1.1.x.
keighrim commented 8 months ago

Closing as duplicate to https://github.com/clamsproject/mmif/issues/208 , as that issue is now re-opened for further discussion.