hoi.utils.get_nbest_mult

hoi.utils.get_nbest_mult#

hoi.utils.get_nbest_mult(hoi, model=None, orders=None, multiplets=None, n_best=5, minsize=None, maxsize=None, names=None)[source]#

Get the n best multiplets.

This function requires pandas to be installed.

Parameters:

hoiarray_like: Array of higher-order information.
modelhoi.metrics, optional: Model used to compute the higher-order information. The default is None.
orders: array_like, optional: Order associated to each multiplet. The default is None.
multiplets: array_like, optional: Combination of features. The default is None.
n_bestint, optional: Number of best multiplets to return. The default is 5.
minsizeint, optional: Minimum size of the multiplets. The default is None.
maxsizeint, optional: Maximum size of the multiplets. The default is None.
nameslist, optional: List of names of the variables. The default is None.

Returns: