Packages

c

com.spotify.scio.extra.voyager.syntax

VoyagerPairSCollectionOps

final class VoyagerPairSCollectionOps extends AnyVal

Source
SCollectionSyntax.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. VoyagerPairSCollectionOps
  2. AnyVal
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new VoyagerPairSCollectionOps(self: SCollection[(String, Array[Float])])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    Any
  2. final def ##: Int
    Definition Classes
    Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def asVoyager(uri: VoyagerUri, space: SpaceType, numDimensions: Int, indexM: Long = VoyagerWriter.DefaultIndexM, efConstruction: Long = VoyagerWriter.DefaultEfConstruction, randomSeed: Long = VoyagerWriter.DefaultRandomSeed, storageDataType: StorageDataType = VoyagerWriter.DefaultStorageDataType): SCollection[VoyagerUri]

    Write the key-value pairs of this SCollection as a Voyager index to a specified location using the parameters specified.

    Write the key-value pairs of this SCollection as a Voyager index to a specified location using the parameters specified.

    uri

    The VoyagerUri.

    space

    The space type to use when storing and comparing vectors.

    numDimensions

    The number of dimensions per vector.

    indexM

    Controls the degree of interconnectedness between vectors.

    efConstruction

    Controls index quality, affecting the speed of addItem calls. Does not affect memory usage or size of the index.

    randomSeed

    A random seed to use when initializing the index's internal data structures.

    storageDataType

    The datatype to use under-the-hood when storing vectors.

    returns

    A VoyagerUri representing where the index was written to.

    Annotations
    @experimental()
  6. def asVoyagerSideInput(space: SpaceType, numDimensions: Int, indexM: Long = VoyagerWriter.DefaultIndexM, efConstruction: Long = VoyagerWriter.DefaultEfConstruction, randomSeed: Long = VoyagerWriter.DefaultRandomSeed, storageDataType: StorageDataType = VoyagerWriter.DefaultStorageDataType): SideInput[VoyagerReader]

    Write the key-value pairs of this SCollection as a Voyager index to a temporary location, building the index using the parameters specified and then loading the reader into a side input.

    Write the key-value pairs of this SCollection as a Voyager index to a temporary location, building the index using the parameters specified and then loading the reader into a side input.

    space

    The space type to use when storing and comparing vectors.

    numDimensions

    The number of dimensions per vector.

    indexM

    Controls the degree of interconnectedness between vectors.

    efConstruction

    Controls index quality, affecting the speed of addItem calls. Does not affect memory usage or size of the index.

    randomSeed

    A random seed to use when initializing the index's internal data structures.

    storageDataType

    The datatype to use under-the-hood when storing vectors.

    returns

    A SideInput with a VoyagerReader

    Annotations
    @experimental()
  7. def getClass(): Class[_ <: AnyVal]
    Definition Classes
    AnyVal → Any
  8. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  9. def toString(): String
    Definition Classes
    Any

Inherited from AnyVal

Inherited from Any

Ungrouped