restmodels

package
v0.0.0-...-18f9a63 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 29, 2021 License: Apache-2.0, CC-BY-4.0, MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// TrainingMemoryUnitMiB captures enum value "MiB"
	TrainingMemoryUnitMiB string = "MiB"
	// TrainingMemoryUnitMB captures enum value "MB"
	TrainingMemoryUnitMB string = "MB"
	// TrainingMemoryUnitGiB captures enum value "GiB"
	TrainingMemoryUnitGiB string = "GiB"
	// TrainingMemoryUnitGB captures enum value "GB"
	TrainingMemoryUnitGB string = "GB"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AnyDataType 

type AnyDataType string
const (
	// AnyDataTypeSTRING captures enum value "STRING"
	AnyDataTypeSTRING AnyDataType = "STRING"
	// AnyDataTypeJSONSTRING captures enum value "JSONSTRING"
	AnyDataTypeJSONSTRING AnyDataType = "JSONSTRING"
	// AnyDataTypeINT captures enum value "INT"
	AnyDataTypeINT AnyDataType = "INT"
	// AnyDataTypeFLOAT captures enum value "FLOAT"
	AnyDataTypeFLOAT AnyDataType = "FLOAT"
)

func (AnyDataType) Validate 

func (m AnyDataType) Validate(formats strfmt.Registry) error

Validate validates this any data type

type BasicModel 

type BasicModel struct {

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

func (*BasicModel) MarshalBinary 

func (m *BasicModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BasicModel) UnmarshalBinary 

func (m *BasicModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BasicModel) Validate 

func (m *BasicModel) Validate(formats strfmt.Registry) error

Validate validates this basic model

type BasicNewModel 

type BasicNewModel struct {
	BasicModel

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

func (*BasicNewModel) MarshalBinary 

func (m *BasicNewModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (BasicNewModel) MarshalJSON 

func (m BasicNewModel) MarshalJSON() ([]byte, error)

MarshalJSON marshals this object to a JSON structure

func (*BasicNewModel) UnmarshalBinary 

func (m *BasicNewModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BasicNewModel) UnmarshalJSON 

func (m *BasicNewModel) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this object from a JSON structure

func (*BasicNewModel) Validate 

func (m *BasicNewModel) Validate(formats strfmt.Registry) error

Validate validates this basic new model

type Datastore 

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"`
}

func (*Datastore) MarshalBinary 

func (m *Datastore) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Datastore) UnmarshalBinary 

func (m *Datastore) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Datastore) Validate 

func (m *Datastore) Validate(formats strfmt.Registry) error

Validate validates this datastore

type Endpoint 

type Endpoint struct {

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

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

func (*Endpoint) MarshalBinary 

func (m *Endpoint) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Endpoint) UnmarshalBinary 

func (m *Endpoint) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Endpoint) Validate 

func (m *Endpoint) Validate(formats strfmt.Registry) error

Validate validates this endpoint

type EndpointList 

type EndpointList struct {

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

func (*EndpointList) MarshalBinary 

func (m *EndpointList) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*EndpointList) UnmarshalBinary 

func (m *EndpointList) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*EndpointList) Validate 

func (m *EndpointList) Validate(formats strfmt.Registry) error

Validate validates this endpoint list

type Error 

type Error struct {

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

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

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

func (*Error) MarshalBinary 

func (m *Error) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Error) UnmarshalBinary 

func (m *Error) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Error) Validate 

func (m *Error) Validate(formats strfmt.Registry) error

Validate validates this error

type Event 

type Event struct {

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

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

func (*Event) MarshalBinary 

func (m *Event) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Event) UnmarshalBinary 

func (m *Event) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Event) Validate 

func (m *Event) Validate(formats strfmt.Registry) error

Validate validates this event

type EventEndpointRegistration 

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"`
}

func (*EventEndpointRegistration) MarshalBinary 

func (m *EventEndpointRegistration) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*EventEndpointRegistration) UnmarshalBinary 

func (m *EventEndpointRegistration) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*EventEndpointRegistration) Validate 

func (m *EventEndpointRegistration) Validate(formats strfmt.Registry) error

Validate validates this event endpoint registration

type EventList 

type EventList struct {

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

func (*EventList) MarshalBinary 

func (m *EventList) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*EventList) UnmarshalBinary 

func (m *EventList) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*EventList) Validate 

func (m *EventList) Validate(formats strfmt.Registry) error

Validate validates this event list

type Framework 

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"`
}

func (*Framework) MarshalBinary 

func (m *Framework) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Framework) UnmarshalBinary 

func (m *Framework) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Framework) Validate 

func (m *Framework) Validate(formats strfmt.Registry) error

Validate validates this framework

type MetricData 

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"`
}

func (*MetricData) MarshalBinary 

func (m *MetricData) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*MetricData) UnmarshalBinary 

func (m *MetricData) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*MetricData) Validate 

func (m *MetricData) Validate(formats strfmt.Registry) error

Validate validates this metric data

type Model 

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"`
}

func (*Model) MarshalBinary 

func (m *Model) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (Model) MarshalJSON 

func (m Model) MarshalJSON() ([]byte, error)

MarshalJSON marshals this object to a JSON structure

func (*Model) UnmarshalBinary 

func (m *Model) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Model) UnmarshalJSON 

func (m *Model) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this object from a JSON structure

func (*Model) Validate 

func (m *Model) Validate(formats strfmt.Registry) error

Validate validates this model

type ModelList 

type ModelList struct {

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

func (*ModelList) MarshalBinary 

func (m *ModelList) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ModelList) UnmarshalBinary 

func (m *ModelList) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ModelList) Validate 

func (m *ModelList) Validate(formats strfmt.Registry) error

Validate validates this model list

type QuerySearchType 

type QuerySearchType string
const (
	// QuerySearchTypeTERM captures enum value "TERM"
	QuerySearchTypeTERM QuerySearchType = "TERM"
	// QuerySearchTypeNESTED captures enum value "NESTED"
	QuerySearchTypeNESTED QuerySearchType = "NESTED"
	// QuerySearchTypeMATCH captures enum value "MATCH"
	QuerySearchTypeMATCH QuerySearchType = "MATCH"
	// QuerySearchTypeALL captures enum value "ALL"
	QuerySearchTypeALL QuerySearchType = "ALL"
)

func (QuerySearchType) Validate 

func (m QuerySearchType) Validate(formats strfmt.Registry) error

Validate validates this query search type

type Training 

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"`
}

func (*Training) MarshalBinary 

func (m *Training) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Training) UnmarshalBinary 

func (m *Training) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Training) Validate 

func (m *Training) Validate(formats strfmt.Registry) error

Validate validates this training

type TrainingStatus 

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"`
}

func (*TrainingStatus) MarshalBinary 

func (m *TrainingStatus) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TrainingStatus) UnmarshalBinary 

func (m *TrainingStatus) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TrainingStatus) Validate 

func (m *TrainingStatus) Validate(formats strfmt.Registry) error

Validate validates this training status

type TrainingUpdate 

type TrainingUpdate struct {

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

func (*TrainingUpdate) MarshalBinary 

func (m *TrainingUpdate) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TrainingUpdate) UnmarshalBinary 

func (m *TrainingUpdate) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TrainingUpdate) Validate 

func (m *TrainingUpdate) Validate(formats strfmt.Registry) error

Validate validates this training update

type V1AddResponse 

type V1AddResponse struct {

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

func (*V1AddResponse) MarshalBinary 

func (m *V1AddResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V1AddResponse) UnmarshalBinary 

func (m *V1AddResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V1AddResponse) Validate 

func (m *V1AddResponse) Validate(formats strfmt.Registry) error

Validate validates this v1 add response

type V1Any 

type V1Any struct {

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

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

func (*V1Any) MarshalBinary 

func (m *V1Any) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V1Any) UnmarshalBinary 

func (m *V1Any) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V1Any) Validate 

func (m *V1Any) Validate(formats strfmt.Registry) error

Validate validates this v1 any

type V1DeleteResponse 

type V1DeleteResponse struct {

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

func (*V1DeleteResponse) MarshalBinary 

func (m *V1DeleteResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V1DeleteResponse) UnmarshalBinary 

func (m *V1DeleteResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V1DeleteResponse) Validate 

func (m *V1DeleteResponse) Validate(formats strfmt.Registry) error

Validate validates this v1 delete response

type V1EMetrics 

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"`
}

func (*V1EMetrics) MarshalBinary 

func (m *V1EMetrics) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V1EMetrics) UnmarshalBinary 

func (m *V1EMetrics) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V1EMetrics) Validate 

func (m *V1EMetrics) Validate(formats strfmt.Registry) error

Validate validates this v1 e metrics

type V1EMetricsList 

type V1EMetricsList struct {

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

func (*V1EMetricsList) MarshalBinary 

func (m *V1EMetricsList) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V1EMetricsList) UnmarshalBinary 

func (m *V1EMetricsList) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V1EMetricsList) Validate 

func (m *V1EMetricsList) Validate(formats strfmt.Registry) error

Validate validates this v1 e metrics list

type V1HelloResponse 

type V1HelloResponse struct {

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

func (*V1HelloResponse) MarshalBinary 

func (m *V1HelloResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V1HelloResponse) UnmarshalBinary 

func (m *V1HelloResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V1HelloResponse) Validate 

func (m *V1HelloResponse) Validate(formats strfmt.Registry) error

Validate validates this v1 hello response

type V1LogLine 

type V1LogLine struct {

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

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

func (*V1LogLine) MarshalBinary 

func (m *V1LogLine) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V1LogLine) UnmarshalBinary 

func (m *V1LogLine) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V1LogLine) Validate 

func (m *V1LogLine) Validate(formats strfmt.Registry) error

Validate validates this v1 log line

type V1LogLinesList 

type V1LogLinesList struct {

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

func (*V1LogLinesList) MarshalBinary 

func (m *V1LogLinesList) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V1LogLinesList) UnmarshalBinary 

func (m *V1LogLinesList) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V1LogLinesList) Validate 

func (m *V1LogLinesList) Validate(formats strfmt.Registry) error

Validate validates this v1 log lines list

type V1MetaInfo 

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"`
}

func (*V1MetaInfo) MarshalBinary 

func (m *V1MetaInfo) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V1MetaInfo) UnmarshalBinary 

func (m *V1MetaInfo) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V1MetaInfo) Validate 

func (m *V1MetaInfo) Validate(formats strfmt.Registry) error

Validate validates this v1 meta info

type V1Query 

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"`
}

func (*V1Query) MarshalBinary 

func (m *V1Query) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V1Query) UnmarshalBinary 

func (m *V1Query) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V1Query) Validate 

func (m *V1Query) Validate(formats strfmt.Registry) error

Validate validates this v1 query

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.