NearestNeighbor

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

Abstract Value Members

abstract val dimension: Int

Dimension of item vectors.
Dimension of item vectors.

Attributes
protected
abstract val idToKey: Array[K]

Numeric id to item key mapping.
Numeric id to item key mapping.

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

Item key to numeric id mapping.
Item key to numeric id mapping.

Attributes
protected
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.
abstract val name: String

Name of the nearest neighbor method.
abstract val vectors: Array[DenseVector[V]]

Raw item vectors.
Raw item vectors.

Attributes
protected

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

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

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

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

Definition Classes
AnyRef → Any
def finalize(): Unit

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

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

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

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

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

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

Lookup nearest neighbors of an existing vector.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

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

Definition Classes
AnyRef
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object NearestNeighbor | package nn

trait NearestNeighbor[K, V] extends Serializable

Abstract Value Members

abstract val dimension: Int

abstract val idToKey: Array[K]

abstract val keyToId: Map[K, Int]

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

abstract val name: String

abstract val vectors: Array[DenseVector[V]]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def getId(key: K): Int

def getKey(id: Int): K

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

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

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped