bipartite_learn.utils package

Module contents

The bipartite_learn.utils module includes various utilities.

bipartite_learn.utils.all_estimators(type_filter=None, base_estimator=None)

Get a list of all estimators from bipartite_learn.

This function is adapted from the original sklearn.utils.all_estimators to crawl the bipartite_learn package.

This function crawls the module and gets all classes that inherit from BaseEstimator. Classes that are defined in test-modules are not included. :param type_filter: “classifier”, “regressor”, “cluster”, “transformer”, “sampler” } or list of such str, default=None

Which kind of estimators should be returned. If None, no filter is applied and all estimators are returned. Possible values are ‘classifier’, ‘regressor’, ‘cluster’ and ‘transformer’ to get estimators only of these specific types, or a list of these to get the estimators that fit at least one of the types.

Returns:

estimators – List of (name, class), where name is the class name as string and class is the actual type of the class.

Return type:

list of tuples

bipartite_learn.utils.check_multipartite_params(*params, k=2)