Package org.apache.spark.ml.feature

Class BucketedRandomProjectionLSHModel

Object
org.apache.spark.ml.PipelineStage
org.apache.spark.ml.Transformer
org.apache.spark.ml.Model<T>
org.apache.spark.ml.feature.BucketedRandomProjectionLSHModel
All Implemented Interfaces:
Serializable, org.apache.spark.internal.Logging, BucketedRandomProjectionLSHParams, LSHParams, Params, HasInputCol, HasOutputCol, Identifiable, MLWritable
public class BucketedRandomProjectionLSHModel extends Model<T> implements BucketedRandomProjectionLSHParams
Model produced by BucketedRandomProjectionLSH, where multiple random vectors are stored. The vectors are normalized to be unit vectors and each vector is used in a hash function: h_i(x) = floor(r_i.dot(x) / bucketLength) where r_i is the i-th random unit vector. The number of buckets will be (max L2 norm of input vectors) / bucketLength.

param: randMatrix A matrix with each row representing a hash function.

See Also:

  • Method Details

    • read

      public static MLReader<BucketedRandomProjectionLSHModel> read()

    • load

      public static BucketedRandomProjectionLSHModel load(String path)

    • bucketLength

      public DoubleParam bucketLength()
      Description copied from interface: BucketedRandomProjectionLSHParams
      The length of each hash bucket, a larger bucket lowers the false negative rate. The number of buckets will be (max L2 norm of input vectors) / bucketLength.

      If input vectors are normalized, 1-10 times of pow(numRecords, -1/inputDim) would be a reasonable value

      Specified by:
      bucketLength in interface BucketedRandomProjectionLSHParams
      Returns:
      (undocumented)

    • uid

      public String uid()
      Description copied from interface: Identifiable
      An immutable unique ID for the object and its derivatives.
      Specified by:
      uid in interface Identifiable
      Returns:
      (undocumented)

    • setInputCol

      public BucketedRandomProjectionLSHModel setInputCol(String value)

    • setOutputCol

      public BucketedRandomProjectionLSHModel setOutputCol(String value)

    • copy

      public BucketedRandomProjectionLSHModel copy(ParamMap extra)
      Description copied from interface: Params
      Creates a copy of this instance with the same UID and some extra params. Subclasses should implement this method and set the return type properly. See defaultCopy().
      Specified by:
      copy in interface Params
      Specified by:
      copy in class Model<BucketedRandomProjectionLSHModel>
      Parameters:
      extra - (undocumented)
      Returns:
      (undocumented)

    • write

      public MLWriter write()
      Description copied from interface: MLWritable
      Returns an MLWriter instance for this ML instance.
      Specified by:
      write in interface MLWritable
      Returns:
      (undocumented)

    • toString

      public String toString()
      Specified by:
      toString in interface Identifiable
      Overrides:
      toString in class Object

    • approxNearestNeighbors

      public Dataset<?> approxNearestNeighbors(Dataset<?> dataset, Vector key, int numNearestNeighbors, String distCol)
      Given a large dataset and an item, approximately find at most k items which have the closest distance to the item. If the HasOutputCol.outputCol() is missing, the method will transform the data; if the HasOutputCol.outputCol() exists, it will use the HasOutputCol.outputCol(). This allows caching of the transformed data when necessary.

      Parameters:
      dataset - The dataset to search for nearest neighbors of the key.
      key - Feature vector representing the item to search for.
      numNearestNeighbors - The maximum number of nearest neighbors.
      distCol - Output column for storing the distance between each result row and the key.
      Returns:
      A dataset containing at most k items closest to the key. A column "distCol" is added to show the distance between each row and the key.
      Note:
      This method is experimental and will likely change behavior in the next release.

    • approxNearestNeighbors

      public Dataset<?> approxNearestNeighbors(Dataset<?> dataset, Vector key, int numNearestNeighbors)
      Overloaded method for approxNearestNeighbors. Use "distCol" as default distCol.
      Parameters:
      dataset - (undocumented)
      key - (undocumented)
      numNearestNeighbors - (undocumented)
      Returns:
      (undocumented)

    • approxSimilarityJoin

      public Dataset<?> approxSimilarityJoin(Dataset<?> datasetA, Dataset<?> datasetB, double threshold, String distCol)
      Join two datasets to approximately find all pairs of rows whose distance are smaller than the threshold. If the HasOutputCol.outputCol() is missing, the method will transform the data; if the HasOutputCol.outputCol() exists, it will use the HasOutputCol.outputCol(). This allows caching of the transformed data when necessary.

      Parameters:
      datasetA - One of the datasets to join.
      datasetB - Another dataset to join.
      threshold - The threshold for the distance of row pairs.
      distCol - Output column for storing the distance between each pair of rows.
      Returns:
      A joined dataset containing pairs of rows. The original rows are in columns "datasetA" and "datasetB", and a column "distCol" is added to show the distance between each pair.

    • approxSimilarityJoin

      public Dataset<?> approxSimilarityJoin(Dataset<?> datasetA, Dataset<?> datasetB, double threshold)
      Overloaded method for approxSimilarityJoin. Use "distCol" as default distCol.
      Parameters:
      datasetA - (undocumented)
      datasetB - (undocumented)
      threshold - (undocumented)
      Returns:
      (undocumented)

    • inputCol

      public final Param<String> inputCol()
      Description copied from interface: HasInputCol
      Param for input column name.
      Specified by:
      inputCol in interface HasInputCol
      Returns:
      (undocumented)

    • numHashTables

      public final IntParam numHashTables()
      Description copied from interface: LSHParams
      Param for the number of hash tables used in LSH OR-amplification.

      LSH OR-amplification can be used to reduce the false negative rate. Higher values for this param lead to a reduced false negative rate, at the expense of added computational complexity.

      Specified by:
      numHashTables in interface LSHParams
      Returns:
      (undocumented)

    • outputCol

      public final Param<String> outputCol()
      Description copied from interface: HasOutputCol
      Param for output column name.
      Specified by:
      outputCol in interface HasOutputCol
      Returns:
      (undocumented)

    • transform

      public Dataset<Row> transform(Dataset<?> dataset)
      Description copied from class: Transformer
      Transforms the input dataset.
      Specified by:
      transform in class Transformer
      Parameters:
      dataset - (undocumented)
      Returns:
      (undocumented)

    • transformSchema

      public StructType transformSchema(StructType schema)
      Description copied from class: PipelineStage
      Check transform validity and derive the output schema from the input schema.

      We check validity for interactions between parameters during transformSchema and raise an exception if any parameter value is invalid. Parameter value checks which do not depend on other parameters are handled by Param.validate().

      Typical implementation should first conduct verification on schema change and parameter validity, including complex parameter interaction checks.

      Specified by:
      transformSchema in class PipelineStage
      Parameters:
      schema - (undocumented)
      Returns:
      (undocumented)