From 85b4aec5c7a53feea48ad651ff31e813c431f1ae Mon Sep 17 00:00:00 2001 From: Constantin Pape Date: Fri, 27 Nov 2020 16:51:56 +0100 Subject: [PATCH 1/2] Add execution model to the spec --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index b684e2f91..ddd22ff30 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. + +- `[execution_model]` Custom mode for running prediction with this model. For more complex prediction procedures like test time data augmentation that cannot be expressed in the current model configuration. The different execution models should be listed in [supported_formats_and_operations.md#Execution Model](https://github.com/bioimage-io/configuration/blob/master/supported_formats_and_operations.md#execution_model) + - `name` the name of the execution model + - `[kwargs]` keyword arguments for this execution model - `[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. From a11a941289350b3d7762055721e5398d6f41112a Mon Sep 17 00:00:00 2001 From: Constantin Pape Date: Fri, 4 Dec 2020 16:42:41 +0100 Subject: [PATCH 2/2] Change execution_model to run_mode --- README.md | 6 +++--- supported_formats_and_operations.md | 8 ++++++++ 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ddd22ff30..e22e8300a 100644 --- a/README.md +++ b/README.md @@ -138,9 +138,9 @@ For example: - `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. -- `[execution_model]` Custom mode for running prediction with this model. For more complex prediction procedures like test time data augmentation that cannot be expressed in the current model configuration. The different execution models should be listed in [supported_formats_and_operations.md#Execution Model](https://github.com/bioimage-io/configuration/blob/master/supported_formats_and_operations.md#execution_model) - - `name` the name of the execution model - - `[kwargs]` keyword arguments for this execution model +- `[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