Hubro Connect/no.hubroplatform.hubroconnect.flwr

Package-level declarations

Types

Client

interface Client

Abstract base class for Flower clients.

Code

enum Code : Enum<Code>

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

Config

typealias Config = Map<String, Scalar>

Represents a map of configuration values.

Context

data class Context(val runId: ULong, val nodeId: ULong, val nodeConfig: Config, val runConfig: Config)

Context for a client.

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.

FlowerKeyPair

actual class FlowerKeyPair

expect class FlowerKeyPair

actual class FlowerKeyPair

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>

Represents a map of metric values.

PandasExampleClient

class PandasExampleClient : Client

A Flower client that mimics the pandas_example.

Parameters

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

Model parameters.

Properties

typealias Properties = Map<String, Scalar>

Represents a map of properties.

QueryIns

data class QueryIns(val query: Recorddict.RecordDict)

Query instructions for a client.

QueryRes

data class QueryRes(val status: Status, val response: Recorddict.RecordDict)

Query response from a client.

ReconnectIns

data class ReconnectIns(val seconds: Long?)

ReconnectIns message from server to client.

Scalar

sealed class Scalar

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

Status

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

Client status.

Properties

EMPTY_TENSOR_KEY

const val EMPTY_TENSOR_KEY: String

HUNDRED_MEBIBYTE

const val HUNDRED_MEBIBYTE: Int

Functions

base64Encode

actual fun base64Encode(data: ByteArray): String

expect fun base64Encode(data: ByteArray): String

actual fun base64Encode(data: ByteArray): String

generateKeyPair

actual fun generateKeyPair(): FlowerKeyPair

expect fun generateKeyPair(): FlowerKeyPair

actual fun generateKeyPair(): FlowerKeyPair

runPandasExample

suspend fun runPandasExample(serverAddress: String)

sha256

actual fun sha256(data: ByteArray): String

expect fun sha256(data: ByteArray): String

actual fun sha256(data: ByteArray): String

sign

actual fun sign(privateKey: Any, data: ByteArray): ByteArray

expect fun sign(privateKey: Any, data: ByteArray): ByteArray

actual fun sign(privateKey: Any, data: ByteArray): ByteArray

startClient

suspend fun startClient(serverAddress: String, useTls: Boolean, client: Client, nodeConfig: Config = emptyMap())