Skip to content
Snippets Groups Projects
Commit e3bb4174 authored by ml bonhomme's avatar ml bonhomme :bee: Committed by Yoann Schneider
Browse files

Model type user configuration field documentation

parent 569ebb6b
No related branches found
No related tags found
1 merge request!460Model type user configuration field documentation
Pipeline #147302 passed
docs/contents/workers/user_configuration/model_config.png

50.4 KiB

......@@ -137,6 +137,7 @@ A parameter is defined using the following settings:
- `enum`
- `list`
- `dict`
- `model`
`default`
: Optional. A default value for the parameter. Must be of the defined parameter `type`.
......@@ -272,7 +273,7 @@ Which will result in the following display for the user:
#### Dictionary parameters
Dictionary-type parameters must be defined using a `title`, the `dict` `type`. You can also set a `default` value for this parameter, which must be one a dictionary, as well as make it a `required` parameter, which prevents users from leaving it blank. You can use dictionary parameters for example to specify a correspondence between the classes that are predicted by a worker and the elements that are created on Arkindex from these predictions.
Dictionary-type parameters must be defined using a `title` and the `dict` `type`. You can also set a `default` value for this parameter, which must be a dictionary, as well as make it a `required` parameter, which prevents users from leaving it blank. You can use dictionary parameters for example to specify a correspondence between the classes that are predicted by a worker and the elements that are created on Arkindex from these predictions.
Dictionary-type parameters only accept strings as values.
......@@ -293,6 +294,26 @@ Which will result in the following display for the user:
![Dictionary-type parameter](user_configuration/dict_config.png "Example dictionary-type parameter.")
#### Model parameters
Model-type parameters must be defined using a `title` and the `model` type. You can also set a `default` value for this parameter, which must be the UUID of an existing Model, and make it a `required` parameter, which prevents users from leaving it blank. You can use a model parameter to specify to which Model the Model Version that is created by a Training process will be attached.
Model-type parameters only accept Model UUIDs as values.
In the configuration form, model parameters are displayed as an input field. Users can select a model from a list of available Models: what they type into the input field filters that list, allowing them to search for a model using its name or UUID.
For example, a model-type parameter can be defined like this:
```yaml
model_param:
title: Training Model
type: model
```
Which will result in the following display for the user:
![Model-type parameter](user_configuration/model_config.png "Example model-type parameter.")
#### Example user_configuration
```yaml
......@@ -318,6 +339,9 @@ user_configuration:
- 23
- 56
title: Another Parameter
a_model_parameter:
type: model
title: Model to train
```
#### Fallback to free JSON input
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment