Types de paramètres de job

Chaque entrée de la parameterDefinitions liste d'un modèle de tâche déclare un paramètre de tâche. Chaque paramètre possède a name et atype, et peut avoir a descriptiondefault, a et un userInterface bloc avec a labelgroupLabel, a et control a. Le type détermine les valeurs que le paramètre accepte, les champs de contrainte qu'il prend en charge et le contrôle affiché par défaut dans la boîte de dialogue de soumission. Un modèle désigne la valeur sous la forme{{Param.Name}}. Les types sont les suivants.

Certains types font partie de la spécification de base d'Open Job Description. Les autres sont ajoutés par l'EXPRextension, et un modèle qui les utilise doit être répertorié EXPR dans sonextensions. Pour la définition champ par champ de chaque type, consultez les définitions des paramètres de tâche Open Job Description sur le site Web. GitHub

INT

Un entier, sous forme de nombre ou de chaîne numérique. Contraintes :allowedValues,minValue,maxValue. Contrôle :SPIN_BOX, ou DROPDOWN_LIST quand allowedValues est défini.

FLOAT

Un nombre, sous forme de nombre ou de chaîne numérique. Contraintes :allowedValues,minValue,maxValue. Contrôle :SPIN_BOX, ou DROPDOWN_LIST quand allowedValues est défini. Le decimals champ définit le nombre de décimales modifiables.

STRING

Une ficelle. Contraintes :allowedValues,minLength,maxLength. Contrôle :LINE_EDIT, ou DROPDOWN_LIST quand allowedValues est défini. Accepte égalementMULTILINE_EDIT, et allowedValues détient CHECK_BOX quand une true/false paire telle que["true", "false"].

PATH

Un chemin de fichier ou de répertoire. Les règles de mappage des chemins sont appliquées à la valeur du travailleur. Contraintes :allowedValues,minLength,maxLength,objectType,dataFlow. Contrôle :CHOOSE_INPUT_FILE,CHOOSE_OUTPUT_FILE, ouCHOOSE_DIRECTORY, selon objectType etdataFlow.

BOOL(nécessiteEXPR)

trueou false ; les chiffres 1 ou 0 ; ou les chaînestrue,yes,on,1,false,no,off, 0 en majuscules. Aucune contrainte. Contrôle :CHECK_BOX.

RANGE_EXPR(nécessiteEXPR)

Une expression de plage de nombres entiers telle que "1-100""1-100:10", ou"1,3,5-9". Contraintes :minLength,maxLength. Contrôle :LINE_EDIT.

LIST[STRING](nécessiteEXPR)

Une liste de chaînes. Contraintes : minLength et maxLength pour la liste ;item.allowedValues,item.minLength, et item.maxLength pour chaque élément. Contrôle :LINE_EDIT_LIST.

LIST[PATH](nécessiteEXPR)

Une liste de chemins. Les règles de mappage des chemins sont appliquées à chaque valeur. Contraintes : les contraintes de liste et d'élément deLIST[STRING], plus objectType etdataFlow. Contrôle :CHOOSE_INPUT_FILE_LIST,CHOOSE_OUTPUT_FILE_LIST, ouCHOOSE_DIRECTORY_LIST, selon objectType etdataFlow.

LIST[INT], LIST[FLOAT] (nécessiteEXPR)

Une liste de numéros. Contraintes : minLength et maxLength pour la liste ;item.allowedValues,item.minValue, et item.maxValue pour chaque élément. Contrôle :SPIN_BOX_LIST.

LIST[BOOL](nécessiteEXPR)

Une liste de valeurs booléennes, chacune acceptant les mêmes valeurs que. BOOL Contraintes :minLength,maxLength. Contrôle :CHECK_BOX_LIST.

LIST[LIST[INT]](nécessiteEXPR)

Une liste de listes d'entiers, pour une entrée structurée telle qu'une liste de contiguïté. Contraintes : contraintes imbriquéesitem. Contrôle : HIDDEN il n'existe aucun contrôle visuel pour ce type.

Chaque type accepte également HIDDEN comme contrôle, ce qui empêche le paramètre d'entrer dans la boîte de dialogue de soumission. Défini HIDDEN pour les valeurs fournies par un pipeline par programme.

Les LIST[PATH] types PATH et comportent deux champs supplémentaires. objectTypeest FILE ouDIRECTORY, et dataFlow est INOUT,INOUT, ouNONE. Les pièces jointes aux tâches lisent ces champs pour choisir les chemins à télécharger en entrée et ceux à surveiller pour les sorties. Un PATH paramètre prend également en charge fileFilters et fileFilterDefault pour le dialogue de fichier. Pour plus d’informations, consultez Éléments de modèles de tâches pour les offres d'emploi.

Les définitions suivantes présentent une case à cocher, une plage d'images, une liste de noms de caméras et une liste de fichiers d'entrée. Le modèle est EXPR répertorié parce que les quatre derniers types l'exigent.

specificationVersion: 'jobtemplate-2023-09'
extensions:
  - EXPR
parameterDefinitions:
  - name: Samples
    type: INT
    default: 64
    minValue: 1
    maxValue: 4096
  - name: UseGpu
    type: BOOL
    default: false
    userInterface:
      label: Render on GPU
  - name: Frames
    type: RANGE_EXPR
    default: "1-100"
    userInterface:
      label: Frame Range
  - name: Cameras
    type: LIST[STRING]
    default: ["main", "closeup"]
    minLength: 1
    userInterface:
      label: Cameras to Render
  - name: Textures
    type: LIST[PATH]
    objectType: FILE
    dataFlow: IN
    default: []

Dans un modèle avec l'EXPRextension, chaque paramètre possède un type d'expression correspondant : intfloat,string,path,bool,range_expr, oulist[T]. Un paramètre RANGE_EXPR ou un paramètre range de liste peut être directement le paramètre d'une tâche, de sorte que chaque cadre ou élément devient une tâche. Pour PATH etLIST[PATH], RawParam.Name est la valeur telle que soumise, sous forme de chaîne, avant le mappage du chemin.

steps:
  - name: Render
    parameterSpace:
      taskParameterDefinitions:
        - name: Camera
          type: STRING
          range: "{{Param.Cameras}}"
        - name: Frame
          type: INT
          range: "{{Param.Frames}}"
    script:
      actions:
        onRun:
          command: render
          args:
            - "--camera"
            - "{{Task.Param.Camera}}"
            - "--frame"
            - "{{Task.Param.Frame}}"
            - "--samples"
            - "{{Param.Samples}}"
            - "{{ '--gpu' if Param.UseGpu else null }}"
            - "{{ ['--textures', Param.Textures.join(',')] if len(Param.Textures) > 0 else null }}"

Les deux derniers arguments sont des expressions. Un null résultat n'ajoute aucun argument et un résultat de liste ajoute chaque élément en tant qu'argument distinct. Pour plus d’informations, consultez Expressions dans les modèles de tâches.

Pour soumettre un ensemble de tâches qui utilise les types de EXPR paramètres, la CLI de Deadline Cloud, la boîte de dialogue de soumission deadline bundle gui-submit et le moniteur Deadline Cloud doivent être une version compatible avec l'extension. Les clients plus anciens rejettent les modèles de ce type.