restmodels

type AnyDataType string

type BasicModel struct {

	// A unique id of the deep learning model.
	ModelID string `json:"model_id,omitempty"`
}

type BasicNewModel struct {
	BasicModel

	// Location of the model to retrieve it.
	Location string `json:"location,omitempty"`
}

type Datastore struct {

	// connection
	Connection map[string]string `json:"connection,omitempty"`

	// the id of the data store as defined in the manifest.
	DataStoreID string `json:"data_store_id,omitempty"`

	// the type of the data store as defined in the manifest.
	Type string `json:"type,omitempty"`
}

type Endpoint struct {

	// the id of the endpoint
	ID string `json:"id,omitempty"`

	// the url of the endpoint
	URL string `json:"url,omitempty"`
}

type EndpointList struct {

	// endpoints
	Endpoints []*Endpoint `json:"endpoints"`
}

type Error struct {

	// code
	Code int32 `json:"code,omitempty"`

	// description
	Description string `json:"description,omitempty"`

	// error
	Error string `json:"error,omitempty"`
}

type Event struct {

	// endpoints
	Endpoints *EndpointList `json:"endpoints,omitempty"`

	// the type of event (i.e. update, metrics, logs, all...)
	Type string `json:"type,omitempty"`
}

type EventEndpointRegistration struct {

	// The type of event this URL should be notified of.
	Type string `json:"type,omitempty"`

	// The URL to notify on events.
	URL string `json:"url,omitempty"`
}

type EventList struct {

	// events
	Events []*Event `json:"events"`
}

type Framework struct {

	// the name of the deep learning framework (e.g. caffe, torch, tensorflow)
	Name string `json:"name,omitempty"`

	// the version of the specific framework to use.
	Version string `json:"version,omitempty"`
}

type MetricData struct {

	// map of key/values, that describe evaluation metrics
	Values map[string]interface{} `json:"Values,omitempty"`

	// Current iteration number be processed.
	Iteration int32 `json:"iteration,omitempty"`

	// Timestamp of the metric. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
	//
	Timestamp string `json:"timestamp,omitempty"`

	// The type of metrics data
	Type string `json:"type,omitempty"`
}

type Model struct {
	BasicNewModel

	// data stores
	DataStores []*Datastore `json:"data_stores"`

	// Detailed description of deep learning model.
	Description string `json:"description,omitempty"`

	// framework
	Framework *Framework `json:"framework,omitempty"`

	// metrics
	Metrics []*MetricData `json:"metrics"`

	// The name of the deep learning model.
	Name string `json:"name,omitempty"`

	// training
	Training *Training `json:"training,omitempty"`
}

type ModelList struct {

	// models
	Models []*Model `json:"models"`
}

type QuerySearchType string

type Training struct {

	// the command invoked for running the training. This is specific to the DL framework
	Command string `json:"command,omitempty"`

	// Number of CPUs required
	Cpus float64 `json:"cpus,omitempty"`

	// events
	Events *EventList `json:"events,omitempty"`

	// Number of CPUs required
	Gpus float64 `json:"gpus,omitempty"`

	// Input data to the training, such as training data, pre-trained model. The input is specified as references to the data_store ids that contain the data.
	InputData []string `json:"input_data"`

	// Number of learners required.
	Learners int32 `json:"learners,omitempty"`

	// Amount of memory required
	Memory float64 `json:"memory,omitempty"`

	// Memory unit (default: MiB)
	//
	MemoryUnit *string `json:"memory_unit,omitempty"`

	// Output data of the training, such as trained models. The output is specified as references to the data_store ids that contain the data.
	OutputData []string `json:"output_data"`

	// the pre-configured deployment size to used for training. The is used instead of directly specifying CPU, GPU, memory and learners.
	Size string `json:"size,omitempty"`

	// training status
	TrainingStatus *TrainingStatus `json:"training_status,omitempty"`
}

type TrainingStatus struct {

	// Training completion timestamp (Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
	//
	Completed string `json:"completed,omitempty"`

	// A code identifying the cause of a status message.
	ErrorCode string `json:"error_code,omitempty"`

	// Status of the training.
	Status string `json:"status,omitempty"`

	// Description of the training status.
	StatusDescription string `json:"status_description,omitempty"`

	// A human readable message description of the training status.
	StatusMessage string `json:"status_message,omitempty"`

	// Training submission timestamp (Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
	//
	Submitted string `json:"submitted,omitempty"`
}

type TrainingUpdate struct {

	// The status action to be executed on the training job. (Currently only `halt` is supported.)
	Status string `json:"status,omitempty"`
}

type V1AddResponse struct {

	// success
	Success bool `json:"success,omitempty"`
}

type V1Any struct {

	// type
	Type AnyDataType `json:"type,omitempty"`

	// value
	Value string `json:"value,omitempty"`
}

type V1DeleteResponse struct {

	// success
	Success bool `json:"success,omitempty"`
}

type V1EMetrics struct {

	// Repeated, order-dependent list of temporal keys
	// Example: {"iteration": 209}
	Etimes map[string]V1Any `json:"etimes,omitempty"`

	// Group label, such as test, train, or validate
	Grouplabel string `json:"grouplabel,omitempty"`

	// meta
	Meta *V1MetaInfo `json:"meta,omitempty"`

	// / {"cross_entropy": 0.4430539906024933,	"accuracy": 0.8999999761581421}
	Values map[string]V1Any `json:"values,omitempty"`
}

type V1EMetricsList struct {

	// models
	Models []*V1EMetrics `json:"models"`
}

type V1HelloResponse struct {

	// msg
	Msg string `json:"msg,omitempty"`
}

type V1LogLine struct {

	// line
	Line string `json:"line,omitempty"`

	// meta
	Meta *V1MetaInfo `json:"meta,omitempty"`
}

type V1LogLinesList struct {

	// models
	Models []*V1LogLine `json:"models"`
}

type V1MetaInfo struct {

	// sequential index
	Rindex int64 `json:"rindex,omitempty"`

	// Time that the metric occured: representing the number of millisecond since midnight January 1, 1970.
	Time int64 `json:"time,omitempty"`

	// Unique id identifying the training job
	TrainingID string `json:"training_id,omitempty"`

	// Unique id identifying the user
	UserID string `json:"user_id,omitempty"`
}

type V1Query struct {

	// follow
	Follow bool `json:"follow,omitempty"`

	// The following three options are exclusive
	Meta *V1MetaInfo `json:"meta,omitempty"`

	// n records
	NRecords int32 `json:"nRecords,omitempty"`

	// search type
	SearchType QuerySearchType `json:"searchType,omitempty"`

	// since
	Since string `json:"since,omitempty"`
}