asset

Documentation

Overview

Package asset defines the structures necessary to orchestrate a federated learning network. Most of these files are generated from protobuf definitions. This package also define validation rules for those assets.

Index

• Variables
• func MarshalEventAsset(event *Event) ([]byte, error)
• func UnmarshalEventAsset(b []byte, event *Event, assetKind AssetKind) error
• type Kind

Variables

var (
	// OrganizationKind is the type of Organization assets
	OrganizationKind Kind = "organization"
	// MetricKind is the type of Metric assets
	MetricKind = "metric"
	// DataSampleKind is the type of DataSample assets
	DataSampleKind = "datasample"
	// FunctionKind is the type of Function assets
	FunctionKind = "function"
	// DataManagerKind is the type of DataManager assets
	DataManagerKind = "datamanager"
	// ComputeTaskKind is the type of ComputeTask assets
	ComputeTaskKind = "computetask"
	// ComputePlanKind is the type of ComputePlan assets
	ComputePlanKind = "computeplan"
	// ModelKind is the type of Model assets
	ModelKind = "model"
	// PerformanceKind is the type of Performance assets
	PerformanceKind = "performance"
	// ProfilingStepKind is the type of Performance assets
	ProfilingStepKind = "profiling_step"
	// FailureReportKind is the type of FailureReport assets
	FailureReportKind          = "failurereport"
	ComputeTaskOutputAssetKind = "computetask_output_asset"
)

Functions

func MarshalEventAsset

func MarshalEventAsset(event *Event) ([]byte, error)

MarshalEventAsset returns the JSON encoding of the Asset of the provided Event.

func UnmarshalEventAsset

func UnmarshalEventAsset(b []byte, event *Event, assetKind AssetKind) error

UnmarshalEventAsset parses the JSON-encoded data according to the assetKind and stores the result in the Asset field of the provided event.

Types

type Kind

type Kind = string

Kind represent the type of assets handled by the orchestrator