sf.apps.data.feature.FeatureDataset

class FeatureDataset[source]

Bases: abc.ABC

Base class for loading datasets of pre-calculated GBS feature vectors.

Each dataset contains a collection of feature vectors. The corresponding adjacency matrix for each feature vector and the orbits/events used are also provided.

n_mean

mean number of photons used in the GBS device

Type

float

method

method used to calculate the feature vectors; exact for exact calculation or mc for Monte Carlo estimation

Type

str

unit

signifies the unit of construction of feature vectors; orbits or events

Type

str

unit_data

list of orbits/events used to construct the feature vectors. Each orbit is a list of integers and each event must be provided as [total_photon_number, max_photon_per_mode]

Type

list[list[int]]

n_vectors

number of feature vectors provided in the dataset

Type

int

n_features

number of features in each feature vector

Type

int

vectors

array of feature vectors

Type

array

adjs

array of adjacency matrices of graphs for which feature vectors were calculated

Type

array

method

rtype

str

n_mean

rtype

float

unit

rtype

str

unit_data

rtype

list

method
Return type

str

n_mean
Return type

float

unit
Return type

str

unit_data
Return type

list