prepare_factorized_vector#

skrough.dataprep.prepare_factorized_vector(values: np.ndarray, return_unique_values: Literal[False] = False) → tuple[np.ndarray, int][source]#
skrough.dataprep.prepare_factorized_vector(values: np.ndarray, return_unique_values: Literal[True]) → tuple[np.ndarray, int, np.ndarray]

Factorize values.

Prepare enumerated values along with a number of distinct values.

Parameters:

values – A 1d array to be factorized.

Returns:

Result is consisted of the following elements

  • factorized data returned in form of 1d array

  • feature domain size

Examples

>>> ar = np.array([3, 4, 3, 3, 2])
>>> prepare_factorized_vector(ar)
(array([0, 1, 0, 0, 2]), 3)