com.spotify.scio.extra.nn

NearestNeighbor

trait NearestNeighbor[K, V] extends Serializable

Immutable index for fast nearest neighbor look up.

{{ import com.spotify.scio.extra.nn._

// Tuples of (item ID, vector) to look up from val vectors: Seq[(String, DenseVector[Double])] = // ...

// Builder for a nearest neighbor index backed by a matrix val builder = NearestNeighbor.newMatrixBuilder[String, Double](40) vectors.foreach(kv => builder.addVector(kv._1, kv._2)) val nn = builder.build

// Candidate to loo up nearest neighbors from val candidate: DenseVector[Double] = // ...

// Look up top 10 most similar items nn.lookup(candidate, 10) }}

Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. NearestNeighbor
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract val dimension: Int

    Dimension of item vectors.

    Dimension of item vectors.

    Attributes
    protected
  2. abstract val idToKey: Array[K]

    Numeric id to item key mapping.

    Numeric id to item key mapping.

    Attributes
    protected
  3. abstract val keyToId: Map[K, Int]

    Item key to numeric id mapping.

    Item key to numeric id mapping.

    Attributes
    protected
  4. abstract def lookup(vec: DenseVector[V], maxResult: Int, minSimilarity: Double = Double.NegativeInfinity): Iterable[(K, Double)]

    Lookup nearest neighbors of a vector.

    Lookup nearest neighbors of a vector. The vector should be normalized.

  5. abstract val name: String

    Name of the nearest neighbor method.

  6. abstract val vectors: Array[DenseVector[V]]

    Raw item vectors.

    Raw item vectors.

    Attributes
    protected

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  12. def getId(key: K): Int

    Attributes
    protected
    Annotations
    @inline()
  13. def getKey(id: Int): K

    Attributes
    protected
    Annotations
    @inline()
  14. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  15. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  16. def lookupKey(key: K, maxResult: Int, minSimilarity: Double = Double.NegativeInfinity): Iterable[(K, Double)]

    Lookup nearest neighbors of an existing vector.

  17. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  18. final def notify(): Unit

    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  20. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  21. def toString(): String

    Definition Classes
    AnyRef → Any
  22. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped