lenskit.batch.BatchResults#

class lenskit.batch.BatchResults(key)#

Results from a batch recommendation run. Results consist of the outputs of various pipeline components for each of the test users. Results may be None, if the pipeline produced no output for that query.

Stability:
Caller (see Stability Levels).
Parameters:

key (type[tuple] | Sequence[str])

property outputs: list[str]#

Get the list of output names in these results.

Return type:

list[str]

output(name)#

Get the item lists for a particular output component.

Parameters:

name (str) – The output name. This may or may not be the same as the component name.

Return type:

lenskit.data.ItemListCollection[lenskit.data.GenericKey]

add_result(name, key, result)#

Add a single result for one of the outputs.

Parameters:

  • name (str) – The output name in which to save this result.

  • user – The user identifier for this result.

  • result (object) – The result object to save.

  • key (lenskit.data.GenericKey)