The matrix module contains the InteractionMatrix class to represent data within the Recpack framework.

InteractionMatrix(df, item_ix, user_ix[, ...])

An InteractionMatrix contains interactions between users and items at a certain time.


An InteractionMatrix object can be constructed from a pandas DataFrame with a row for each interaction. The item and user values will be indices in the resulting matrix. The following example constructs a 4x4 matrix, with 4 nonzero values:

import pandas as pd

from recpack.matrix import InteractionMatrix
data = {
    "user": [3, 2, 1, 1],
    "item": [1, 1, 2, 3],
    "timestamp": [1613736000, 1613736300, 1613736600, 1613736900]
df = pd.DataFrame.from_dict(data)
demo_data = InteractionMatrix(df, "item", "user", timestamp_ix="timestamp")