Outcome

Note

This page is a reference documentation. It only explains the class signature, and not how to use it. Please refer to the Habitat Guide and Python API guide (v2.0) for usage.

class Outcome(*args, **kwargs)[source]

Bases: Protocol

A declared study endpoint.

Implementations are frozen value objects carrying only column names and the coding of those columns – never data, so an endpoint declaration can be recorded in provenance, compared, and serialised.

task

Endpoint family identifier used for dispatch. Built-in values are "binary", "multiclass", "continuous" and "survival"; third-party endpoints declare their own. Declared as a class-level constant: implementations are frozen value objects whose task never varies per instance.

Type:: ClassVar[str]

property columns: Tuple[str, ...]: Return every frame column this endpoint occupies.

__init__(*args, **kwargs)