Document


The top level Runefile type.
root anyOf DocumentV1
Type: object

Version 1 of the Runefile.yml format.

root anyOf item 0 image

The base image that defines the interface between a Rune and its runtime.

This should always be "runicos/base".
root anyOf item 0 image allOf Path
Type: string

A specification for finding a dependency.

The full syntax is base@version#sub_path where

  • base is a URL or the name of a repository on GitHub (e.g. hotg-ai/rune
    or https://github.com/hotg-ai/rune)
  • version is an optional field specifying the version (e.g. as a git tag)
  • sub_path is an optional field which is useful when pointing to
    repositories with multiple relevant items because it lets you specify
    which directory the specified item is in.
Must match regular expression: (?x) (?P<base>[\w\d:/_.-]+) (?:@(?P<version>[\w\d./-]+))? (?:\#(?P<sub_path>[\w\d._/-]+))?

root anyOf item 0 pipeline
Type: object

The various stages in the Runefile's pipeline.

Each additional property must conform to the following schema

root anyOf item 0 pipeline Stage
Type: object

A stage in the Rune's pipeline.

root anyOf item 0 pipeline additionalProperties anyOf ModelStage
Type: object

A ML model which will be executed by the runtime.

root anyOf item 0 pipeline additionalProperties anyOf item 0 args
Type: object

Each additional property must conform to the following schema

root anyOf item 0 pipeline additionalProperties anyOf item 0 args Argument
Type: object

Something that could be either a reference to a resource ($resource) or a plain string (./path).

root anyOf item 0 pipeline additionalProperties anyOf item 0 args additionalProperties anyOf ResourceName
Type: string

A reference to some [ResourceDeclaration]. It typically looks like
$RESOURCE_NAME.

 Must match regular expression: ^\$[_a-zA-Z][_a-zA-Z0-9]*$
root anyOf item 0 pipeline additionalProperties anyOf item 0 args additionalProperties anyOf item 1
Type: string
root anyOf item 0 pipeline additionalProperties anyOf item 0 args additionalProperties anyOf item 2
Type: number

root anyOf item 0 pipeline additionalProperties anyOf item 0 inputs
Type: array

Tensors to use as input to this model.

Each item of this array must be:

root anyOf item 0 pipeline additionalProperties anyOf item 0 inputs Input
Type: string

The name of a tensor.

Typically something like "stage", or "stage.2" if the stage has multiple outputs.

 Must match regular expression: ^(?P<name>[a-zA-Z_][\w-]*)(?:\.(?P<index>\d+))?$

root anyOf item 0 pipeline additionalProperties anyOf item 0 model

The model to use, or a resource which specifies the model to use.

root anyOf item 0 pipeline additionalProperties anyOf item 0 outputs
Type: array

The tensors that this model outputs.

Each item of this array must be:

root anyOf item 0 pipeline additionalProperties anyOf item 0 outputs Type
Type: object

The element type and dimensions for a particular tensor.

root anyOf item 0 pipeline additionalProperties anyOf item 0 outputs outputs items dimensions
Type: array of integer

Each item of this array must be:

root anyOf item 0 pipeline additionalProperties anyOf item 0 outputs outputs items dimensions dimensions items
Type: integer

Value must be greater or equal to 0.0

root anyOf item 0 pipeline additionalProperties anyOf ProcBlockStage
Type: object

A stage which executes a procedural block.

root anyOf item 0 pipeline additionalProperties anyOf item 1 args
Type: object

Each additional property must conform to the following schema

root anyOf item 0 pipeline additionalProperties anyOf item 1 args Argument
Type: object

Something that could be either a reference to a resource ($resource) or a plain string (./path).

Same definition as anyOf_i0_pipeline_additionalProperties_anyOf_i0_args_additionalProperties

root anyOf item 0 pipeline additionalProperties anyOf item 1 inputs
Type: array

Each item of this array must be:

root anyOf item 0 pipeline additionalProperties anyOf item 1 inputs Input
Type: string

The name of a tensor.

Typically something like "stage", or "stage.2" if the stage has multiple outputs.

Same definition as anyOf_i0_pipeline_additionalProperties_anyOf_i0_inputs_items

root anyOf item 0 pipeline additionalProperties anyOf item 1 outputs
Type: array

Each item of this array must be:

root anyOf item 0 pipeline additionalProperties anyOf item 1 outputs Type
Type: object

The element type and dimensions for a particular tensor.

Same definition as anyOf_i0_pipeline_additionalProperties_anyOf_i0_outputs_items

root anyOf item 0 pipeline additionalProperties anyOf item 1 proc-block
Type: string

A [Path] that Rune can use to locate the proc block.

Must match regular expression: (?x) (?P<base>[\w\d:/_.-]+) (?:@(?P<version>[\w\d./-]+))? (?:\#(?P<sub_path>[\w\d._/-]+))?
root anyOf item 0 pipeline additionalProperties anyOf CapabilityStage
Type: object

A stage which reads inputs from the runtime.

root anyOf item 0 pipeline additionalProperties anyOf item 2 args
Type: object

Each additional property must conform to the following schema

root anyOf item 0 pipeline additionalProperties anyOf item 2 args Argument
Type: object

Something that could be either a reference to a resource ($resource) or a plain string (./path).

Same definition as anyOf_i0_pipeline_additionalProperties_anyOf_i0_args_additionalProperties

root anyOf item 0 pipeline additionalProperties anyOf item 2 capability
Type: string

What type of capability to use ("IMAGE", "SOUND", etc.).

root anyOf item 0 pipeline additionalProperties anyOf item 2 outputs
Type: array

Each item of this array must be:

root anyOf item 0 pipeline additionalProperties anyOf item 2 outputs Type
Type: object

The element type and dimensions for a particular tensor.

Same definition as anyOf_i0_pipeline_additionalProperties_anyOf_i0_outputs_items
root anyOf item 0 pipeline additionalProperties anyOf OutStage
Type: object

A stage which passes outputs back to the runtime.

root anyOf item 0 pipeline additionalProperties anyOf item 3 args
Type: object

Each additional property must conform to the following schema

root anyOf item 0 pipeline additionalProperties anyOf item 3 args Argument
Type: object

Something that could be either a reference to a resource ($resource) or a plain string (./path).

Same definition as anyOf_i0_pipeline_additionalProperties_anyOf_i0_args_additionalProperties

root anyOf item 0 pipeline additionalProperties anyOf item 3 inputs
Type: array

Each item of this array must be:

root anyOf item 0 pipeline additionalProperties anyOf item 3 inputs Input
Type: string

The name of a tensor.

Typically something like "stage", or "stage.2" if the stage has multiple outputs.

Same definition as anyOf_i0_pipeline_additionalProperties_anyOf_i0_inputs_items

root anyOf item 0 pipeline additionalProperties anyOf item 3 out
Type: string

The type of output (e.g. "SERIAL").

root anyOf item 0 resources
Type: object Default: {}

Any resources that can be accessed by pipeline stages.

Each additional property must conform to the following schema

root anyOf item 0 resources ResourceDeclaration
Type: object

The declaration for a resource, typically something like a wordlist or environment variable.

 No Additional Properties

root anyOf item 0 resources additionalProperties inline
Type: string or null

A resource who's default value is specified inline.

root anyOf item 0 resources additionalProperties path
Type: string or null

A resource who's default value is meant to be loaded from a file.

root anyOf item 0 resources additionalProperties type
Default: "string"
root anyOf item 0 resources additionalProperties type allOf ResourceType
Type: enum (of string)

How the resource should be treated inside the Rune.

Must be one of:

  • "string"
  • "binary"

root anyOf item 0 version
Type: integer

The version number. Must always be "1".

Value must be greater or equal to 1.0 and lesser or equal to 1.0