Release Notes

This page provides version history and a summary of key features for each SDK release

17 May 2023: 2D Histograms for EDA Intersect & Linear Inference

This release introduces two new features:

• The ability to generate 2D histograms for EDA sessions in Intersect mode. This feature requires the addition of a paired_cols parameter. For more information, see the Intersect Mode tutorial.

• A new model package for linear inference. This package is particularly useful for GWAS training. For more information, see Linear Inference Sessions.

• New in this release is also the addition of a single release version number to describe the release package. This release is version: 9.5.0.

27 April 2023: PRL, VFL, and EDA Intersect

This release introduces the following new features:

• The ability to perform private record linkage (PRL) on two datasets. A guide is available here.

• The ability to perform exploratory data analysis (EDA) in Intersect mode, using a PRL session result. A guide is available here.

• The ability to perform Vertical Federated Learning (VFL) in both training and prediction mode. A guide is available here.

• Note: this release does not support Python 3.11 due to a known issue in that Python release.

Versions:

• SDK: 0.9.2

• Client: 2.4.2

• Server: 2.6.0

• CLI Tool: 0.0.46

30 Jan 2023: User Authentication

This release added two new features:

• The ability to train Gradient Boosted HFL Models. A guide is available here.

• The ability to generate scoped tokens for users. A guide is available here.

Bug fixes:

• Clients may get disconnected from the server when training large models

Versions:

• SDK: 0.5.36

• Client: 2.0.18

• Server: 2.2.19

• CLI Tool: 0.0.38

08 Dec 2022: Integration with AWS Fargate

This release introduces the ability to run an IAI training server on AWS Fargate through the integrate.ai SDK. With an integrate.ai training server running on Fargate, your data in S3 buckets, and clients running on AWS Batch, you can use the SDK to manage and run fully remote training sessions. A guide is available here.

Versions:

• SDK: 0.5.13

• Client: 2.0.11

• CLI Tool: 0.0.33

02 Nov 2022: Integration with AWS Batch

This release introduces the ability to run AWS Batch jobs through the integrate.ai SDK. Building on the previous release, which added support for data hosted in S3 buckets, you can now start and run a remote training session on remote data with jobs managed by AWS Batch. A guide is available here.

Features:

• Added the ability to run the iai client through AWS Batch

• Added the ability for the iai client to retrieve a token through the IAI_TOKEN environment variable

• Added a version command for the iai client: iai client version Note: Docker must be running for the version command to return a value.

• Added support for a new session "pending" status

• BREAKING CHANGE:

  • Session status mapping in the SDK has been updated as follows:

  created -> Created
  started -> Running
  pending -> Pending
  failed -> Failed
  succeeded -> Completed
  canceled -> Canceled

Bug fixes:

• Fixed an issue with small batch sizes

Versions:

• SDK: 0.3.31

• Client: 1.0.15

• CLI Tool: 0.0.31

06 Oct 2022: Exploratory Data Analysis & S3 Support

Features:

• Exploratory Data Analysis (EDA) - integrate.ai now supports the ability to generate histograms for each feature of a dataset. Use the results of the EDA session to calculate summary statistics for both continuous and categorical variables. See more about the feature here.

  • This feature has Differential Privacy applied automatically to each histogram to add noise and reduce privacy leakage. The Differential Privacy settings are dynamic and applied to best suit each dataset individually, to ensure privacy protection without excessive noise.

• S3 data path support - load data from an s3 bucket for the <iai client hfl> and <iai client eda> commands. You can use S3 URLs as the data_path given that your AWS CLI environment is properly configured. Read more on how to configure this integration here.

• Client logging via <iai client log> command - this new feature in the integrate-ai CLI package allows a user to access session logs from clients, to be used as a tool to help debug failed sessions. Access this using the <iai client log> command.

Versions:

• SDK: 0.3.20

• Client: 1.0.8

• CLI Too: 0.0.21

14 Sept 2022: Infrastructure upgrades for session abstraction

• SDK Version: 0.3.5

• Client Version: 1.0.2

• CLI Tool Version: 0.0.21

Earlier Releases

To view the API documentation for a particular release, click the SDK version number.

SDK 0.2.x

Release Date	SDK Version	Client Version	CLI tool Version	Feature Summary
2022-08-23	0.2.14	0.3.6	0.0.20	Added convenience function iai client train Added option to download CPU or GPU version Include all optimizers supported by pytorch
2022-08-09	0.2.7	0.3.3		SDK renamed (from (iai_integratefl_sdk.api to integrate_ai_sdk.api) CLI tool introduced

SDK 0.1.x

Release Date	SDK Version	Client Version	Feature Summary
2022-07-14	0.1.43	0.2.35	Download the SDK through the integrate UI
2022-06-27	0.1.43		Added sample notebook with custom model example (LSTM model)
2022-06-16	0.1.38		Introduced authentication token Added model upload function Added stop running session function Added delete completed session function
2022-05-17	0.1.3.8		First release of the integrate FL SDK