diff --git a/README.md b/README.md index b684e2f91..e22e8300a 100644 --- a/README.md +++ b/README.md @@ -137,6 +137,10 @@ For example: - `source` link to the weights file. Preferably an url to the weights file. - `sha256` SHA256 checksum of the model weight file specified by `source` (see `models` section above for how to generate SHA256 checksum) - `[attachments]` weight specific attachments that will be included when generating the model package. + +- `[run_mode]` Custom run mode for this model: for more complex prediction procedures like test time data augmentation that currently cannot be expressed in the specification. The different run modes should be listed in [supported_formats_and_operations.md#Run Modes](https://github.com/bioimage-io/configuration/blob/master/supported_formats_and_operations.md#run modes) + - `name` the name of the `run_mode` + - `[kwargs]` keyword arguments for this `run_mode` - `[config]` A custom configuration field that can contain any other keys which are not defined above. It can be very specifc to a framework or specific tool. To avoid conflicted defintions, it is recommended to wrap configuration into a sub-field named with the specific framework or tool name. diff --git a/supported_formats_and_operations.md b/supported_formats_and_operations.md index d1f81a9ca..a0408f8b0 100644 --- a/supported_formats_and_operations.md +++ b/supported_formats_and_operations.md @@ -109,3 +109,11 @@ Which consumer supports which postprocessing operation? | `scale_mean_variance`| no | ? | yes | | `scale_min_max` | no | ? | yes | | `scale_linear` | no | ? | ? | + + +# Run Modes + +Custom run modes to enable more complex prediction procedures. + + +## Consumers