package attribute
ML attributes
The ML pipeline API uses DataFrame
s as ML datasets.
Each dataset consists of typed columns, e.g., string, double, vector, etc.
However, knowing only the column type may not be sufficient to handle the data properly.
For instance, a double column with values 0.0, 1.0, 2.0, ... may represent some label indices,
which cannot be treated as numeric values in ML algorithms, and, for another instance, we may
want to know the names and types of features stored in a vector column.
ML attributes are used to provide additional information to describe columns in a dataset.
ML columns
A column with ML attributes attached is called an ML column. The data in ML columns are stored as double values, i.e., an ML column is either a scalar column of double values or a vector column. Columns of other types must be encoded into ML columns using transformers. We use Attribute to describe a scalar ML column, and AttributeGroup to describe a vector ML column. ML attributes are stored in the metadata field of the column schema.
- Alphabetic
- By Inheritance
- attribute
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
sealed abstract
class
Attribute extends Serializable
:: DeveloperApi :: Abstract class for ML attributes.
:: DeveloperApi :: Abstract class for ML attributes.
- Annotations
- @DeveloperApi()
-
class
AttributeGroup extends Serializable
:: DeveloperApi :: Attributes that describe a vector ML column.
:: DeveloperApi :: Attributes that describe a vector ML column.
- Annotations
- @DeveloperApi()
-
sealed abstract
class
AttributeType extends AnyRef
:: DeveloperApi :: An enum-like type for attribute types: AttributeType$#Numeric, AttributeType$#Nominal, and AttributeType$#Binary.
:: DeveloperApi :: An enum-like type for attribute types: AttributeType$#Numeric, AttributeType$#Nominal, and AttributeType$#Binary.
- Annotations
- @DeveloperApi()
-
class
BinaryAttribute extends Attribute
:: DeveloperApi :: A binary attribute.
:: DeveloperApi :: A binary attribute.
- Annotations
- @DeveloperApi()
-
class
NominalAttribute extends Attribute
:: DeveloperApi :: A nominal attribute.
:: DeveloperApi :: A nominal attribute.
- Annotations
- @DeveloperApi()
-
class
NumericAttribute extends Attribute
:: DeveloperApi :: A numeric attribute with optional summary statistics.
:: DeveloperApi :: A numeric attribute with optional summary statistics.
- Annotations
- @DeveloperApi()
Value Members
-
object
Attribute extends AttributeFactory with Serializable
:: DeveloperApi ::
:: DeveloperApi ::
- Annotations
- @DeveloperApi()
-
object
AttributeGroup extends Serializable
:: DeveloperApi :: Factory methods to create attribute groups.
:: DeveloperApi :: Factory methods to create attribute groups.
- Annotations
- @DeveloperApi()
-
object
AttributeType
:: DeveloperApi ::
:: DeveloperApi ::
- Annotations
- @DeveloperApi()
-
object
BinaryAttribute extends AttributeFactory with Serializable
:: DeveloperApi :: Factory methods for binary attributes.
:: DeveloperApi :: Factory methods for binary attributes.
- Annotations
- @DeveloperApi()
-
object
NominalAttribute extends AttributeFactory with Serializable
:: DeveloperApi :: Factory methods for nominal attributes.
:: DeveloperApi :: Factory methods for nominal attributes.
- Annotations
- @DeveloperApi()
-
object
NumericAttribute extends AttributeFactory with Serializable
:: DeveloperApi :: Factory methods for numeric attributes.
:: DeveloperApi :: Factory methods for numeric attributes.
- Annotations
- @DeveloperApi()
-
object
UnresolvedAttribute extends Attribute
:: DeveloperApi :: An unresolved attribute.
:: DeveloperApi :: An unresolved attribute.
- Annotations
- @DeveloperApi()