9.16. Output
Declares that an operator requires a mounted volume or shared memory to write data to. Clara Deploy SDK will ensure that any declared output property values will be available to the executing container application, at the specified path or shaped memory location.
9.16.1.1.name
type: string
Unique name of the output.
Optional in pipeline api-version 0.4.0 and below when an operator only defines a single output; otherwise required.
Mandatory in pipeline api-version 0.5.0 or better for both shared memory items or disk-based output.
When another operator maps an operator’s output, it does so by declaring an input‘s from field to match the name of the upstream operator, and its name field to match the name of the desired output.
See names for additional information about names in Clara Deploy SDK pipeline definitions.
9.16.1.2.path
type: string
Container-local path to which Clara Deploy SDK will provide the requested output volume.
The path property must be declared as part of any output declaration in pipeline api-version 0.4.0 and below, or when type (next section) is stream in pipeline api-version 0.5.0 and above. Paths must be fully-qualified.
9.16.1.3.type
(available api-version 0.5.0 and above)
type: string
Describes the Clara structure or Clara primitive.
Clara Primitive |
Logical Interpretation |
|
|---|---|---|
|
8-bit unsigned integer |
|
|
16-bit unsigned integer |
|
|
32-bit unsigned integer |
|
|
64-bit unsigned integer |
|
|
8-bit unsigned integer |
|
|
16-bit signed integer |
|
|
32-bit signed integer |
|
|
64-bit signed integer |
|
|
16-bit floating-point |
|
|
32-bit floating-point |
|
|
64-bit floating-point |
|
9.16.1.4.element-type
(available api-version 0.5.0 and above)
type: string
Must be specified only for array and stream types (see table above); must be omitted for Clara primitives and string.
element-type accepts only Clara primitive types (see Table under type section).
9.16.1.5.shape
(available api-version 0.5.0 and above)
type: list of dimension lengths. Use -1 to indicate that the length is dynamic (will be set at run-time). Fixed (not dynamic) lengths must be greater than zero.
Must be specified only for array type. Omitted for all other types.
Accepts a list of dimension lengths. Use -1 to indicate the size is dynamic (will be defined at run-time). Fixed (not dynamic) dimension lengths must be greater than zero.
9.16.1.6.Examples:
3D array with dynamic first dimension.
shape: [-1, 224, 224]
3-channel 3D array with three dynamically updatable dimensions.
shape: [3, -1, -1, -1]
3-channel static array of 224 x 224.
shape: [3, 224, 224]