Ir para o conteúdo

federated-experiment-sdk

Papel

API Java para implementar experimentos sem acoplar o algoritmo ao servidor, ao broker MQTT ou à interface Android. O módulo descreve como a plataforma descobre, instancia e executa uma sessão de treinamento.

Contratos principais

  • ExperimentSession e ExperimentSessionFactory definem uma sessão executável e sua criação.
  • TrainingLocalModel, TrainingContext e TrainingResult representam algoritmo, dados/contexto autorizado e resultado local.
  • MlAlgorithmSpec, MlRuntimeTarget e MlAlgorithmCatalog descrevem algoritmo, versão e runtimes compatíveis.
  • ExperimentRuntimePaths centraliza caminhos que precisam funcionar em execução local e container.
  • Também fornece leitura de termos de consentimento e relatórios de avaliação.

Integração e fluxo

Os módulos em research/experiments/ implementam os contratos do SDK. federated-client verifica a especificação/runtime e chama o modelo local; federated-simulator e a API usam as factories para montar sessões. Os tipos de baixo nível reutilizam federated-common.

Entrada: contrato, configuração de experimento, TrainingContext e visão de treino entregue pelo cliente. Saída: métricas/resultados e parâmetros atualizados encapsulados em TrainingResult; o SDK não publica o update na rede.

Build e teste

Módulo Maven de API, JDK 25, dependente de federated-common:

mvn -pl modules/federated-experiment-sdk -am test

Consulte módulos do workspace e componente SDK.

Documentação relacionada