Skip to content

hssm.check_data_for_rl

hssm.check_data_for_rl 

check_data_for_rl(
    data: DataFrame,
    participant_id_col: str = "participant_id",
    trial_id_col: str = "trial_id",
) -> tuple[pd.DataFrame, int, int]

Check if the data is suitable for Reinforcement Learning (RL) models.

Parameters:

  • data (DataFrame) –

    The data to check.

  • participant_id_col (str, default: 'participant_id' ) –

    The name of the column containing participant IDs.

  • trial_id_col (str, default: 'trial_id' ) –

    The name of the column containing trial IDs.

Returns:

  • tuple[DataFrame, int, int] –

    A tuple containing the cleaned data, number of participants, and number of trials.