flwr/dev.flower.android

Package-level declarations

Types

Client

interface Client

Abstract base class for Flower clients.

Code

object Code

The Code class defines client status codes used in the application.

CodeAnnotation

annotation class CodeAnnotation

Config

typealias Config = Map<String, Scalar<Any>>

Represents a map of configuration values.

DisconnectRes

data class DisconnectRes(val reason: String)

DisconnectRes message from client to server.

EvaluateIns

data class EvaluateIns(val parameters: Parameters, val config: Config)

Evaluate instructions for a client.

EvaluateRes

data class EvaluateRes(val status: Status, val loss: Float, val numExamples: Int, val metrics: Metrics)

Evaluate response from a client.

FitIns

data class FitIns(val parameters: Parameters, val config: Config)

Fit instructions for a client.

FitRes

data class FitRes(val status: Status, val parameters: Parameters, val numExamples: Int, val metrics: Metrics)

Fit response from a client.

GetParametersIns

data class GetParametersIns(val config: Config)

Parameters request for a client.

GetParametersRes

data class GetParametersRes(val status: Status, val parameters: Parameters)

Response when asked to return parameters.

GetPropertiesIns

data class GetPropertiesIns(val config: Config)

Properties request for a client.

GetPropertiesRes

data class GetPropertiesRes(val status: Status, val properties: Properties)

Properties response from a client.

Metrics

typealias Metrics = Map<String, Scalar<Any>>

Represents a map of metric values.

Parameters

data class Parameters(val tensors: Array<ByteBuffer>, val tensorType: String)

Model parameters.

Properties

typealias Properties = Map<String, Scalar<Any>>

Represents a map of properties.

ReconnectIns

data class ReconnectIns(val seconds: Long?)

ReconnectIns message from server to client.

Scalar

sealed class Scalar<T>

The Scalar class represents a scalar value that can have different data types.

Status

data class Status(val code: Int, val message: String)

Client status.

Properties

HUNDRED_MEBIBYTE

const val HUNDRED_MEBIBYTE: Int

Functions

createFlowerRere

suspend fun createFlowerRere(serverAddress: String, useTLS: Boolean, client: Client)

startClient

suspend fun startClient(serverAddress: String, useTls: Boolean, client: Client)

Start a Flower client node which connects to a Flower server.