​

Registering Entities, Features and Labels

Every feature must describe an entity. An entity can be thought of as a primary key table, and every feature must have at least a single foreign key entity field. Common entities include users, items, and purchases. Entities can be anything that a feature can describe.

@ff.entity
class Passenger:
    # ...

Once our entities are specified, we can begin to associate features and labels with them. Features and labels are each made up of at least two columns, an entity column and a value column. Features and labels that change value over time should be linked to a timestamp column as well. The timestamp column also allows us to create point-in-time correct training data.

Features and labels are registered from sources, which can be either be a Primary table or a Transformation.

​

Without Timestamp

@ff.entity
class Passenger:
    # Register a column from a transformation as a feature
    fpf = ff.Feature(
        fare_per_family_member[["PassengerID", "Fare / Parch"]],
        variant="quickstart",
        type=ff.Float64,
        inference_store=redis,
    )
    # Register label from the original file
    survived = ff.Label(
        titanic[["PassengerID", "Survived"]], variant="quickstart", type=ff.Int
    )

​

With Timestamp

This example is based off of a fraud training set with a CustomerID, TransactionID, Amount, and Transaction Time.

@ff.entity
class Customer:
    # Register a column from a transformation as a feature
    transaction_amount = ff.Feature(
        fare_per_family_member[["CustomerID", "Amount", "Transaction Time"]],
        variant="quickstart",
        type=ff.Float64,
        inference_store=redis,
    )

​

Entity Column Type

NOTE: Currently, the data type of a feature’s entity column (e.g. "CustomerID") must be a string.

​

Registering Training Sets

Once we have our features and labels registered, we can create a training set. Training set creation works by joining a label with a set of features via their entity value and timestamp. For each row of the label, the entity value is used to look up all of the feature values in the training set. When a timestamp is included in the label and the feature, the training set will contain the latest feature value where the feature’s timestamp is less than the label’s.

ff.register_training_set(
    "titanic_training", "quickstart",
    label=("survived", "quickstart"),
    features=[("fpf", "quickstart")],
)

​

Point-in-Time Correctness

Training sets are point-in-time correct. To illustrate point-in-time correctness, image that we are creating a training set from the fraud label previewed below:

And a feature specifying the user’s average purchase price:

The training set would look like this:

Notice that the first row’s feature value is 5, while the second row’s feature value is 10. That’s because at the time of the first label, Jan 3rd, 2022, the feature’s value was 5. On Jan 5th, 2022, the feature’s value was 10.