check_collection

gtda.utils.check_collection(X, **kwargs)[source]

Generic input validation on arrays or lists of arrays.

Parameters
  • X (object) – Input object to check / convert.

  • **kwargs – Keyword arguments accepted by sklearn.utils.validation.check_array, with the following caveats: 1) ensure_2d and allow_nd are ignored; 2) when force_all_finite is set to False, NaN inputs are not allowed.

Returns

Xnew – The converted and validated object.

Return type

ndarray or list