SymetryML6.1
  • Introduction
  • Guides
    • Onboarding Guide
    • Technical Requirements
    • Admin User Guide
    • Installation Guide
      • Installation Guide - GPU
      • Installation Guide - Spark
  • SymetryML GUI
    • ML Toolkit
      • The SymetryML Difference
      • Data Mining Lifecycle
      • SymetryML Concepts
      • Data Sources
      • Streams
      • Encoders
      • Projects
      • Models
    • Sequence Models
    • SymetryML Federated Learning
      • Creating the Federation
      • Load data to local project
      • Requesting Federation Information from Admin Node
      • Joining a Federation with a peer node
      • Federated Data & Modelling
      • Appendix
    • DEM Generator
  • SymetryML Rest Client
    • REST API Reference Guide
      • SymetryML REST API Security
      • SymetryML JSON API Objects
      • Encoder Object REST API
      • SymetryML Projects REST API
      • About Federated Learning
      • Hipaa Compliance and Federated Learning
      • Federated Learning API
        • Federated Learning Topologies
        • Federated Learning with Nats
        • Federated Learning with AWS
        • Fusion Projects
      • Exploration API
      • Modeling API
      • Exporting and Importing Model
      • Third Party Model Rest API
      • SymetryML Job Information
      • Prediction API
      • Data Source API
      • Project Data Source Logs
      • Stream Data Source API
      • AutoML with SymetryML
      • Transform Dataframe
      • Select Model with SymetryML
      • Auto Select with SymetryML
      • Tasks API
      • Miscellaneous API
      • WebSocket API
      • Appendix A JSON Data Structure Schema
      • Appendix B Sample Code
  • SymetryML SaaS
    • SaaS Homepage
    • SaaS Dashboard
    • SaaS Account
    • SaaS Users
    • SaaS Licence
Powered by GitBook
On this page
  • Joining AWS Federation
  • Joining NATS Federation
  1. SymetryML GUI
  2. SymetryML Federated Learning

Joining a Federation with a peer node

PreviousRequesting Federation Information from Admin NodeNextFederated Data & Modelling

Last updated 2 years ago

The peer node requires federated info encrypted information from the admin node. This information is short lived and must be used to join the federation as soon as possible.

Now we will take a look at the steps required to join an existing federation.

Click on the drop-down menu of Create Project and select Join Federation:

Next, the following consecutive windows will appear, detailing all the pertinent information required to join an existing federation, greater detail on the information required follows the figures below:

Get Federation Information
Description

Project Name

This is the name of the local project.

Project Type

This applies to the local project, declare whether the local project is CPU, GPU, Partition, etc.

Project Encoder

Optional parameter specifying the encoder to be used.

Joining AWS Federation

Get Federation Information
Description

Federation Info

The Encrypted Federation Info, provided by the admin of the federation.

Federation Info Password

The Password, provided by the admin of the federation.

AWS Region

The region in which your federation will reside.

AWS S3 Bucket

The name of the S3 Bucket to receive routine updates from the federation.

AWS Account

This is the ID number of your AWS account.

AWS S3 Access Key

The AWS S3 Access Key information.

AWS S3 Secret Key

The AWS S3 Secret key information.

Next, we load data to the local project joining the existing federation. Right click on your local project, and select Add Data:

Once you click on Add Data, next you select the datasource and data you wish to load:

The window below, allows you to review a sample of the data being loaded to ensure the data is valid:

Now that your data is loaded, time to Learn the data, in other words we are scanning the local project data to ascertain various descriptive statistics about the data.

Right click on the dataset and a drop-down menu will appear, select Learn:

Next, a window will appear that allows you to verify that your data attributes have been assigned the correct variable type, and allow for changes if necessary:

Next, we can click on Exploration and look at the select descriptive statistics of our local data:

Finally, we are ready to join the federation and share our local project with the federation. Double click on Federation and the following screen will appear. Here we click Start Pulse, and this starts the periodic sharing of information with other peers in the federation, in this example it is every Minute as this is what was set by the federation admin, however this frequency can be customized (i.e. Minute(s), Hour(s), Day(s)).

Joining NATS Federation

Get Federation Information
Description

Federation Info

The Encrypted Federation Info, provided by the admin of the federation.

Federation Info Password

The Password, provided by the admin of the federation.

Project Name

The name given to the local project.

NATS Hosts

Location of the NATS server

The remainder of the steps (i.e. adding data, learning, and pulsing) for a NATS federation are identical to that of an AWS Federation.

Subsequent sections of this guide will cover the above sequence of steps for and respectively.

AWS
NATS
Federated Learning: Join Federation
Federated Learning: Join Federation
Federated Learning: Join Federation, name local project
Joining Federation: Loading data to local project
Joining Federation: Selecting datasource & data
Joining Federation: verify data
Joining Federation: Learning local data
Joining Federation: Learn Data & Verify variable type
Exploring data: Univariate Information
Federation Info
Federated Learning: Join Federation - NATS
Federated Learning: Join Federation, name local project - NATS
Federated Learning: Join Federation, Federation Info, Password, host info - NATS