types

Documentation

Index

• Variables
• type ConstraintSexp
• type DataColumnTagGroup
• type DataColumnTypeGroup
• type DataGroup
• type DataGroupColumns
• type DataType
• type DataTypeName
• type DatasetColumns
• type DatasetFile
• type ElasticID
• type FileParameter
• type InducedDataGroup
• type InducedFileParameter
• type InducedHyperParameter
• type InducedParameter
• type InducedStateParameter
• type InducedTransform
• type ProtoMLEdge
  • func NewProtoMLEdge(typeSource string, idSource ElasticID, typeSink string, idSink ElasticID) (e ProtoMLEdge)
• type ProtoMLGraph
• type ProtoMLVertex
  • func NewProtoMLVertex(typ string, id ElasticID) (v ProtoMLVertex)
• type State
• type StateParameter
• type Transform
• type TransformFunction
• type TransformHyperParameter
• type TransformParameter

Variables

var DefaultDataTypes = []DataType{
	DataType{
		TypeName:    "any",
		ParentTypes: []DataTypeName{},
		Description: "any type of data"},
	DataType{
		TypeName:    "string",
		ParentTypes: []DataTypeName{"any"},
		Description: "any string data"},
	DataType{
		TypeName:    "YYYY-MM-DD",
		ParentTypes: []DataTypeName{"string"},
		Description: "date data with appropriate format"},
	DataType{
		TypeName:    "word",
		ParentTypes: []DataTypeName{"string"},
		Description: "single word data"},
	DataType{
		TypeName:    "text",
		ParentTypes: []DataTypeName{"string"},
		Description: "long string with words"},
	DataType{
		TypeName:    "ordinal",
		ParentTypes: []DataTypeName{"any"},
		Description: "data that has an order"},
	DataType{
		TypeName:    "number",
		ParentTypes: []DataTypeName{"any"},
		Description: "numerical value"},
	DataType{
		TypeName:    "categorical",
		ParentTypes: []DataTypeName{"number"},
		Description: "unordered data corresponding to categories"},
	DataType{
		TypeName:    "int",
		ParentTypes: []DataTypeName{"number", "ordinal"},
		Description: "numbered data with a meaningful ordering"},
	DataType{
		TypeName:    "real",
		ParentTypes: []DataTypeName{"number", "ordinal"},
		Description: "numbered data with meaningful fractional values"},
	DataType{
		TypeName:    "0,1",
		ParentTypes: []DataTypeName{"categorical", "int"},
		Description: "0, 1 binary data"},
	DataType{
		TypeName:    "-1,1",
		ParentTypes: []DataTypeName{"categorical", "int"},
		Description: "row based number data"},
}

list of default data types

Types

type ConstraintSexp

type ConstraintSexp []string

type DataColumnTagGroup

type DataColumnTagGroup map[string][]int

type DataColumnTypeGroup

type DataColumnTypeGroup map[DataTypeName][]int

type DataGroup

type DataGroup struct {
	FileFormat string
	NRows      int
	NCols      int
	Columns    DataGroupColumns
	Source     string
}

type DataGroupColumns

type DataGroupColumns struct {
	ExclusiveType DataTypeName
	Tags          [][]string
}

type DataType

type DataType struct {
	TypeName    DataTypeName
	ParentTypes []DataTypeName
	Description string
}

type DataTypeName

type DataTypeName string

type DatasetColumns

type DatasetColumns struct {
	ExclusiveTypes DataColumnTypeGroup
	Tags           DataColumnTagGroup
}

type DatasetFile

type DatasetFile struct {
	Path       string
	FileFormat string
	NRows      int
	NCols      int
	Columns    DatasetColumns
}

type ElasticID

type ElasticID string

type FileParameter

type FileParameter struct {
	Type        []DataTypeName
	Format      []string // as long as the format of the file is in here it's good
	Description string
	Optional    string
}

type InducedDataGroup

type InducedDataGroup struct {
	Id           ElasticID
	SelectedView []int
}

type InducedFileParameter

type InducedFileParameter struct {
	Path   string
	Format string
}

type InducedHyperParameter

type InducedHyperParameter struct {
	Type  DataTypeName
	Value string
}

type InducedParameter

type InducedParameter string

type InducedStateParameter

type InducedStateParameter struct {
	Format string
	Path   string
}

type InducedTransform

type InducedTransform struct {
	Name            string
	TemplateID      ElasticID
	Function        string
	Parameters      map[string]InducedParameter      // inserted valid parameters. Parameters are unchecked strings
	HyperParameters map[string]InducedHyperParameter // inserted valid hyperparameters
	// input definitions
	InputsIDs map[string][]InducedDataGroup
	// output definitions
	OutputsIDs map[string][]ElasticID
	// state definitions
	InputStatesIDs  map[string]ElasticID
	OutputStatesIDs map[string]ElasticID

	// denotes valid transform
	Error string

	// runtime members
	Id           ElasticID
	Template     string
	Exec         string
	Inputs       map[string]InducedFileParameter
	Outputs      map[string]InducedFileParameter
	InputStates  map[string]InducedStateParameter
	OutputStates map[string]InducedStateParameter
}

type ProtoMLEdge

type ProtoMLEdge [2]ProtoMLVertex

func NewProtoMLEdge

func NewProtoMLEdge(typeSource string, idSource ElasticID, typeSink string, idSink ElasticID) (e ProtoMLEdge)

type ProtoMLGraph

type ProtoMLGraph struct {
	Vertices []ProtoMLVertex
	Edges    []ProtoMLEdge
}

type ProtoMLVertex

type ProtoMLVertex [2]string

func NewProtoMLVertex

func NewProtoMLVertex(typ string, id ElasticID) (v ProtoMLVertex)

type State

type State struct {
	Source ElasticID
}

type StateParameter

type StateParameter struct {
	Format      []string
	Description string
	Optional    string
}

type Transform

type Transform struct {
	Name     string //transform name
	Template string //transform original template
	// parameters
	PrimaryParameters      map[string]TransformParameter
	PrimaryHyperParameters map[string]TransformHyperParameter
	// command to run
	PrimaryExec string
	// help text
	Documentation string
	// functions
	Functions map[string]TransformFunction
	// data/state format created and accepted
	PrimaryInputs       map[string]FileParameter
	PrimaryOutputs      map[string]FileParameter
	PrimaryInputStates  map[string]StateParameter
	PrimaryOutputStates map[string]StateParameter
}

type TransformFunction

type TransformFunction struct {
	// function name, description
	Description string
	// transform parameters
	Parameters      map[string]TransformParameter
	HyperParameters map[string]TransformHyperParameter
	// script to run
	Exec string
	// input definitions
	Inputs map[string]FileParameter
	// output definitions
	Outputs      map[string]FileParameter
	InputStates  map[string]StateParameter
	OutputStates map[string]StateParameter
}

type TransformHyperParameter

type TransformHyperParameter struct {
	Default     string           // the default value of parameter
	Type        []DataTypeName   // will check if it is of one of the types
	Constraints []ConstraintSexp // list of constraints
	Description string           // description of the parameter
}

type TransformParameter

type TransformParameter struct {
	Default     string // the default value of parameter
	Description string // description of the parameter
}