package attribute

ML attributes

The ML pipeline API uses DataFrames 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.

Linear Supertypes
AnyRef, Any
  1. Alphabetic
  2. By inheritance
  1. attribute
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
  1. Public
  2. All

Type Members

  1. sealed abstract class Attribute extends Serializable

    :: DeveloperApi :: Abstract class for ML attributes.

  2. class AttributeGroup extends Serializable

    :: DeveloperApi :: Attributes that describe a vector ML column.

  3. sealed abstract class AttributeType extends AnyRef

    :: DeveloperApi :: An enum-like type for attribute types: AttributeType$#Numeric, AttributeType$#Nominal, and AttributeType$#Binary.

  4. class BinaryAttribute extends Attribute

    :: DeveloperApi :: A binary attribute.

  5. class NominalAttribute extends Attribute

    :: DeveloperApi :: A nominal attribute.

  6. class NumericAttribute extends Attribute

    :: DeveloperApi :: A numeric attribute with optional summary statistics.

Value Members

  1. object Attribute extends AttributeFactory with Serializable

    :: DeveloperApi ::

  2. object AttributeGroup extends Serializable

    :: DeveloperApi :: Factory methods to create attribute groups.

  3. object AttributeType

  4. object BinaryAttribute extends AttributeFactory with Serializable

    :: DeveloperApi :: Factory methods for binary attributes.

  5. object NominalAttribute extends AttributeFactory with Serializable

    :: DeveloperApi :: Factory methods for nominal attributes.

  6. object NumericAttribute extends AttributeFactory with Serializable

    :: DeveloperApi :: Factory methods for numeric attributes.

  7. object UnresolvedAttribute extends Attribute

    :: DeveloperApi :: An unresolved attribute.

Inherited from AnyRef

Inherited from Any