fed_learn.protos package

3.1
class Client

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

DESCRIPTOR =
client_name

Field admin.Client.client_name

class Empty

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

DESCRIPTOR =
class Message

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

DESCRIPTOR =
class HeadersEntry

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

DESCRIPTOR =
key

Field admin.Message.HeadersEntry.key

value

Field admin.Message.HeadersEntry.value

body

Field admin.Message.body

body_type

Field admin.Message.body_type

headers

Field admin.Message.headers

id

Field admin.Message.id

topic

Field admin.Message.topic

class Messages

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

DESCRIPTOR =
message

Field admin.Messages.message

class Reply

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

DESCRIPTOR =
client_name

Field admin.Reply.client_name

message

Field admin.Reply.message

class AdminCommunicatingServicer

Bases: object

import “google/protobuf/timestamp.proto”; import “google/protobuf/struct.proto”;

The admin communication interfaces

Retrieve(request, context)

client retrieve requests.

SendReply(request, context)

client send reply to server

SendResult(request, context)

client send process results to server

class AdminCommunicatingStub(channel)

Bases: object

import “google/protobuf/timestamp.proto”; import “google/protobuf/struct.proto”;

The admin communication interfaces

Constructor.

Parameters

channel – A grpc.Channel.

add_AdminCommunicatingServicer_to_server(servicer, server)
class ClientLogin

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

DESCRIPTOR =
client_id

Field fedlearn.ClientLogin.client_id

client_ip

Field fedlearn.ClientLogin.client_ip

meta

Field fedlearn.ClientLogin.meta

token

Field fedlearn.ClientLogin.token

class ClientState

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

DESCRIPTOR =
meta

Field fedlearn.ClientState.meta

meta_data

Field fedlearn.ClientState.meta_data

token

Field fedlearn.ClientState.token

uid

Field fedlearn.ClientState.uid

class Contribution

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

DESCRIPTOR =
client

Field fedlearn.Contribution.client

data

Field fedlearn.Contribution.data

meta_data

Field fedlearn.Contribution.meta_data

n_iter

Field fedlearn.Contribution.n_iter

type

Field fedlearn.Contribution.type

class CurrentModel

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

DESCRIPTOR =
data

Field fedlearn.CurrentModel.data

meta

Field fedlearn.CurrentModel.meta

meta_data

Field fedlearn.CurrentModel.meta_data

class FederatedSummary

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

DESCRIPTOR =
comment

Field fedlearn.FederatedSummary.comment

meta

Field fedlearn.FederatedSummary.meta

token

Field fedlearn.FederatedSummary.token

class LocalModel

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

class CheckpointEntry

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

DESCRIPTOR =
key

Field fedlearn.LocalModel.CheckpointEntry.key

value

Field fedlearn.LocalModel.CheckpointEntry.value

DESCRIPTOR =
checkpoint

Field fedlearn.LocalModel.checkpoint

client

Field fedlearn.LocalModel.client

class Metrics

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

DESCRIPTOR =
class MetricsEntry

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

DESCRIPTOR =
key

Field fedlearn.Metrics.MetricsEntry.key

value

Field fedlearn.Metrics.MetricsEntry.value

metrics

Field fedlearn.Metrics.metrics

class ModelData

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

DESCRIPTOR =
class ParamsEntry

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

DESCRIPTOR =
key

Field fedlearn.ModelData.ParamsEntry.key

value

Field fedlearn.ModelData.ParamsEntry.value

params

Field fedlearn.ModelData.params

class ModelMetaData

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

DESCRIPTOR =
class Task

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

DESCRIPTOR =
name

Field fedlearn.ModelMetaData.Task.name

version

Field fedlearn.ModelMetaData.Task.version

created

Field fedlearn.ModelMetaData.created

current_round

Field fedlearn.ModelMetaData.current_round

num_rounds

Field fedlearn.ModelMetaData.num_rounds

task

Field fedlearn.ModelMetaData.task

class NDArray

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

DESCRIPTOR =
ndarray

Field fedlearn.NDArray.ndarray

class Token

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

DESCRIPTOR =
token

Field fedlearn.Token.token

class ValidationModel

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

DESCRIPTOR =
finished

Field fedlearn.ValidationModel.finished

models

Field fedlearn.ValidationModel.models

models_available

Field fedlearn.ValidationModel.models_available

class ValidationResults

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

DESCRIPTOR =
client

Field fedlearn.ValidationResults.client

client_ids

Field fedlearn.ValidationResults.client_ids

client_metrics

Field fedlearn.ValidationResults.client_metrics

class FederatedTrainingServicer

Bases: object

The global federated model interfaces

GetModel(request, context)

server to client model sharing

GetValidationModels(request, context)

server to client model sharing for validation

Heartbeat(request, context)

client to server heartbeat keep live

Quit(request, context)

client quiting the federated training

Register(request, context)

client registration, so that it will contribute to the training

SubmitBestLocalModel(request, context)

client to server best local model submission

SubmitCrossSiteValidationResults(request, context)

client to server send validation results

SubmitUpdate(request, context)

client to server contribution submission

class FederatedTrainingStub(channel)

Bases: object

The global federated model interfaces

Constructor.

Parameters

channel – A grpc.Channel.

add_FederatedTrainingServicer_to_server(servicer, server)
© Copyright 2020, NVIDIA. Last updated on Feb 2, 2023.