Package

org.apache.spark.ml

attribute

Permalink

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.

Source
package.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. attribute
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. sealed abstract class Attribute extends Serializable

    Permalink

    :: DeveloperApi :: Abstract class for ML attributes.

    :: DeveloperApi :: Abstract class for ML attributes.

    Annotations
    @DeveloperApi()
  2. class AttributeGroup extends Serializable

    Permalink

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

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

    Annotations
    @DeveloperApi()
  3. sealed abstract class AttributeType extends AnyRef

    Permalink

    :: 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()
  4. class BinaryAttribute extends Attribute

    Permalink

    :: DeveloperApi :: A binary attribute.

    :: DeveloperApi :: A binary attribute.

    Annotations
    @DeveloperApi()
  5. class NominalAttribute extends Attribute

    Permalink

    :: DeveloperApi :: A nominal attribute.

    :: DeveloperApi :: A nominal attribute.

    Annotations
    @DeveloperApi()
  6. class NumericAttribute extends Attribute

    Permalink

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

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

    Annotations
    @DeveloperApi()

Value Members

  1. object Attribute extends AttributeFactory with Serializable

    Permalink

    :: DeveloperApi ::

    :: DeveloperApi ::

    Annotations
    @DeveloperApi()
  2. object AttributeGroup extends Serializable

    Permalink

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

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

    Annotations
    @DeveloperApi()
  3. object AttributeType

    Permalink

    :: DeveloperApi ::

    :: DeveloperApi ::

    Annotations
    @DeveloperApi()
  4. object BinaryAttribute extends AttributeFactory with Serializable

    Permalink

    :: DeveloperApi :: Factory methods for binary attributes.

    :: DeveloperApi :: Factory methods for binary attributes.

    Annotations
    @DeveloperApi()
  5. object NominalAttribute extends AttributeFactory with Serializable

    Permalink

    :: DeveloperApi :: Factory methods for nominal attributes.

    :: DeveloperApi :: Factory methods for nominal attributes.

    Annotations
    @DeveloperApi()
  6. object NumericAttribute extends AttributeFactory with Serializable

    Permalink

    :: DeveloperApi :: Factory methods for numeric attributes.

    :: DeveloperApi :: Factory methods for numeric attributes.

    Annotations
    @DeveloperApi()
  7. object UnresolvedAttribute extends Attribute

    Permalink

    :: DeveloperApi :: An unresolved attribute.

    :: DeveloperApi :: An unresolved attribute.

    Annotations
    @DeveloperApi()

Inherited from AnyRef

Inherited from Any

Members