Scaleout Edge gRPC protocol

Table of Contents

scaleoututil/grpc/scaleout.proto

ActivityReport

Field	Type	Description
node_id	string	If sent from a client
correlation_id	string
status	string
done	bool
response	string	json

AttributeElem

Field	Type	Label	Description
key	string
value	string

AttributeMessage

Field	Type	Label
client_id	string
attributes	AttributeElem	repeated
timestamp	Timestamp

ClientAnnounceRequest

Field	Type	Label	Description
client_id	string
type	string
parameters	string

ClientAvailableMessage

Field	Type	Label	Description
client_id	string
data	string
timestamp	string

FileChunk

Field	Type	Label	Description
data	bytes

Heartbeat

Field	Type	Label	Description
client_id	string
memory_utilisation	float
cpu_utilisation	float

MetricElem

Field	Type	Label	Description
key	string
value	float

ModelMetric

Field	Type	Label
client_id	string
metrics	MetricElem	repeated
timestamp	Timestamp
step	UInt32Value	optional
model_id	string
round_id	string
session_id	string

ModelPrediction

Field	Type	Label	Description
client_id	string
model_id	string
data	string
correlation_id	string
timestamp	Timestamp
session_id	string

ModelRequest

Field	Type	Label	Description
model_id	string

ModelResponse

Field	Type	Label	Description
status	ModelStatus
message	string

ModelUpdate

Field	Type	Label	Description
client_id	string
model_id	string
model_update_id	string
correlation_id	string
timestamp	Timestamp
meta	string
config	string
round_id	string
session_id	string

ModelValidation

Field	Type	Label	Description
client_id	string
model_id	string
data	string
correlation_id	string
timestamp	Timestamp
session_id	string

Response

Field	Type	Label	Description
response	string
parameters	string

Status

Field	Type	Label	Description
client_id	string
status	string
log_level	LogLevel
timestamp	Timestamp
type	string

TaskRequest

Field	Type	Label	Description
model_id	string
data	string
correlation_id	string
timestamp	string
session_id	string
round_id	string
type	string
status	string
client_id	string

TelemetryElem

Field	Type	Label	Description
key	string
value	float

TelemetryMessage

Field	Type	Label
client_id	string
telemetries	TelemetryElem	repeated
timestamp	Timestamp

LogLevel

Name	Number	Description
NONE	0
INFO	1
DEBUG	2
WARNING	3
ERROR	4
AUDIT	5

ModelStatus

Name	Number	Description
UNKNOWN	0
IN_PROGRESS	1
OK	2
FAILED	3

CombinerClient

Method Name	Request Type	Response Type	Description
SendModelUpdate	ModelUpdate	Response
SendModelValidation	ModelValidation	Response
SendModelPrediction	ModelPrediction	Response
SendModelMetric	ModelMetric	Response
SendAttributeMessage	AttributeMessage	Response
SendTelemetryMessage	TelemetryMessage	Response
Announce	ClientAnnounceRequest	Response
PollAndReport	ActivityReport	TaskRequest
SendStatus	Status	Response	Status endpoint
SendHeartbeat	Heartbeat	Response	Client messaging to stay engaged.
TaskStream	ClientAvailableMessage	TaskRequest stream	Stream endpoints for training/validation pub/sub

ModelService

Method Name	Request Type	Response Type	Description
Upload	FileChunk stream	ModelResponse
Download	ModelRequest	FileChunk stream

Scalar Value Types

.proto Type	Notes	Python	Go
double		float	float64
float		float	float32
int32	Uses variable-length encoding	int	int32
int64	Uses variable-length encoding	int	int64
uint32	Uses variable-length encoding	int	uint32
uint64	Uses variable-length encoding	int	uint64
sint32	Uses var-length encoding. Signed int value.	int	int32
sint64	Uses var-length encoding. Signed int value.	int	int64
fixed32	Always four bytes	int	uint32
fixed64	Always eight bytes	int	uint64
sfixed32	Always four bytes	int	int32
sfixed64	Always eight bytes	int	int64
bool		bool	bool
string	UTF-8 or 7-bit ASCII text.	str	string
bytes	Any arbitrary sequence of bytes.	bytes	[]byte