Federated PatternsPlatform Patterns

Platform Patterns

There are many federated platforms that could be used by the researcher to perform their federated analytics or federated learning projects.

Whilst there may be only a few types of federation, the various platforms tend to differ in how they implement them.

Initiate

A federated analysis or federated learning project usually will start with some commands to initiate the project. At this stage we are collecting information from platform providers to understand if they are using an API specification that captures how a federated project is initiated.

Therefore, at this stage, we will list the API specification for the receiving of the analysis to run across the network.

Process

Each TRE will be asked to process some local job, and that local processing can equally be initiated by an API. We have seperated out the API specification that initiates a federated project and the API specification that is used to initiate a local processing incase these are different.

Therefore, at this stage, we will list the API specification for API that is to request the processing of the analysis with a TRE.

Metadata

Many federated systems rely on the sharing of metadata in order to make the platform usable, to help reseasrchers to design their studies, and to discover what data is available across the network. At this stage we are seeking to understand how common the metadata is between the various platforms, as this could aid egress and TRE onboarding if we can standardise.

Current Platform Patterns

Platform NameInitiateProcessMetadata
Aridhia DREAridhia API docsAridhia API docs
ApherisApheris API docsNA
BitfountBitfound API docsBitfound API docs
Five Safes TESFive Safes TESTES Documentation
Vantage6Vantage 6 API docsNA