check_neighbors_object(nn_name, nn_object, additional_neighbor=0)¶
Check the objects is consistent to be a NN.
Several methods in imblearn relies on NN. Until version 0.4, these objects can be passed at initialisation as an integer or a KNeighborsMixin. After only KNeighborsMixin will be accepted. This utility allows for type checking and raise if the type is wrong.
- nn_name : str,
The name associated to the object to raise an error if needed.
- nn_object : int or KNeighborsMixin,
The object to be checked
- additional_neighbor : int, optional (default=0)
Sometimes, some algorithm need an additional neighbors.
- nn_object : KNeighborsMixin
The k-NN object.