plexus.data.ScorecardExampleReferenceItems module

Build deterministic single-score reference datasets from scorecard examples.

class plexus.data.ScorecardExampleReferenceItems.ScorecardExampleReferenceItems(**parameters)

Bases: DataCache

Data cache that materializes deterministic reference rows from scorecard example items.

Initialize the DataCache instance with the given parameters.

Parameters

**parametersdict

Arbitrary keyword arguments that are used to initialize the Parameters instance.

Raises

ValidationError

If the provided parameters do not pass validation.

class Parameters(*, class_name: str = 'DataCache', scorecard: str | int, score: str | int, days: int | None = None, limit: int | None = None, column_mappings: Dict[str, str] | None = None, item_config: Dict | None = None)

Bases: Parameters

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

column_mappings: Dict[str, str] | None

days: int | None

classmethod days_must_be_positive(v)

item_config: Dict | None

limit: int | None

classmethod limit_must_be_positive(v)

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

score: str | int

scorecard: str | int

__init__(**parameters)

Initialize the DataCache instance with the given parameters.

Parameters

**parametersdict

Arbitrary keyword arguments that are used to initialize the Parameters instance.

Raises

ValidationError

If the provided parameters do not pass validation.

load_dataframe(*args, **kwargs) → DataFrame

Load a dataframe based on the provided parameters.

Returns

pd.DataFrame

The loaded dataframe.

This method must be implemented by all subclasses.