hoi.simulation.simulate_hoi_gauss#
- hoi.simulation.simulate_hoi_gauss(n_samples=1000, target=False, triplet_character='synergy')[source]#
Simulates High Order Interactions (HOIs) with or without target.
This function can be used to simulate a triplet only using gaussian variables.
- Parameters:
- n_samplesint | 1000
Number of samples to simulate.
- targetbool | False
Indicates whether to include a target variable.
- triplet_character{“redundancy”, “synergy}
Interaction character of the triplet of variables to generate. Choose either :
“redundancy” : a triplet of variables with positive O-information (about 0.3) will be generated
“synergy”: a triplet of variables with negative O-information (about -0.8)
In the case, target = True, triplet character refers to the information conveyed by the triplet with respect to the target variable.
- Returns:
- data: np.ndarray
Numpy array of simulated data of shape (n_samples, 3)
- target: np.ndarray
Target variable of shape (n_samples,). This parameter is only returned when the input parameter target is set to True
