Skip to main content

OutputFilePaths

OutputFilePaths contains and provides all paths where various meta outputs produced by the task can be placed, such that the framework can directly access them. Every path is represented using storage.DataReference - > an URN for the configured storage backend

Attributes​

AttributeTypeDescription
RawOutputPathsRawOutputPaths are available with OutputFilePaths
CheckpointPathsCheckpointPaths that can be optionally used to checkpoint

Methods​

GetOutputPrefixPath()​

@classmethod
def GetOutputPrefixPath() - > storage.DataReference

Returns a path to a directory or prefix that contains all execution metadata for this execution.

Returns​

TypeDescription
storage.DataReferenceA storage.DataReference representing the URN for the configured storage backend where execution metadata is stored.

GetOutputPath()​

@classmethod
def GetOutputPath() - > storage.DataReference

Returns a fully qualified path (URN) to where the framework expects the output to exist in the configured storage backend.

Returns​

TypeDescription
storage.DataReferenceA storage.DataReference representing the URN for the configured storage backend where the framework expects output.

GetDeckPath()​

@classmethod
def GetDeckPath() - > storage.DataReference

Returns a fully qualified path (URN) to where the framework expects the deck.html to exist in the configured storage backend.

Returns​

TypeDescription
storage.DataReferenceA storage.DataReference representing the URN for the configured storage backend where the framework expects deck.html.

GetErrorPath()​

@classmethod
def GetErrorPath() - > storage.DataReference

Returns a fully qualified path (URN) where the error information should be placed as a protobuf core.ErrorDocument. It is not directly used by the framework, but could be used in the future.

Returns​

TypeDescription
storage.DataReferenceA storage.DataReference representing the URN for the configured storage backend where error information should be placed.