download hollowdb vector - download do código fonte hollowdb vector

hollowdb vector

Outro código-fonte

v0.1.4

Baixar

Vetor Hollowdb

Implementação do índice hierárquico de pequenos mundos de navegação (HNSW) sobre HollowDB.

Instalação

Instale o pacote:

yarn add hollowdb-vector
pnpm add hollowdb-vector
npm install hollowdb-vector

Uso

Você pode criar o vectordb da seguinte maneira:

 import HollowDBVector from "hollowdb-vector" ;
import { WarpFactory , defaultCacheOptions } from "warp-contracts" ;
import { SetSDK } from "hollowdb" ;
import { Redis } from "ioredis" ;
import { RedisCache } from "warp-contracts-redis" ;

// connect to Redis
const redis = new Redis ( ) ;

// create Warp instance with Redis cache
const warp = WarpFactory . forMainnet ( ) . useKVStorageFactory (
  ( contractTxId : string ) =>
    new RedisCache ( { ... defaultCacheOptions , dbLocation : ` ${ contractTxId } ` } , { client : redis } ) ,
) ;

// create HollowDB SDK
const wallet = JSON . parse ( readFileSync ( "./path/to/wallet.json" , "utf-8" ) ) ;
const contractTxId = "your-contract-tx-id" ;
const hollowdb = new SetSDK < string > ( wallet , contractTxId , warp ) ;

// create HollowDB Vector
const vectordb = new HollowDBVector ( hollowdb ) ;

Inserindo um vetor

Com isso, você pode inserir um novo ponto:

 const point = [ - 0.28571999073028564 /* and many more... */ , 0.13964000344276428 ] ;

// any object
const metadata = {
  name : "My favorite vector!" ,
} ;

// insert a point
await vectordb . insert ( point , metadata ) ;

Os metadados são opcionais e você pode deixá -lo de fora durante insert . Se você deseja definir mais tarde, sempre pode fazer:

 vectordb . db . set_metadata ( index , metadata ) ;

Observação

A complexidade de inserir um ponto pode aumentar com mais pontos no banco de dados.

Buscando um vetor

Você pode obter um vetor pelo seu índice, que retorna seu valor pontual e metadados:

 const { point , metadata } = await vectordb . get_vector ( index ) ;

Consultando um vetor

Você pode fazer uma consulta e retornar os principais resultados relevantes:

 // a query point
const query = [ - 0.28571999073028564 /* and many more... */ , 0.13964000344276428 ] ;

// number of top results to return
const K = 10 ;

// make a KNN search
const results = await vectordb . knn_search ( query , K ) ;

// each result contains the vector id, its distance to query, and metadata
const { id , distance , metadata } = results [ 0 ] ;

Implantando seu próprio contrato

O HollowDB Vector exporta uma função estática que permite que você implante um novo contrato que você possui. Supondo que você tenha uma wallet e uma instância warp , conforme descrito acima, você pode criar um novo contrato com:

 const { contractTxId } = await HollowDBVector . deploy ( wallet , warp ) ;
console . log ( "Deployed at:" , contractTxId ) ;

Configurar

Para a configuração local deste repositório, primeiro clone -o.

git clone https://github.com/firstbatchxyz/hollowdb-vector

Em seguida, instale pacotes:

pnpm install

As dependências de pares devem ser instaladas automaticamente.

Protobuffers

Incluímos o protobuf pré-compilado dentro do repositório, mas se você mudar o protobuf posteriormente, poderá gerar o código compilado da seguinte maneira:

 # HNSW protobufs
pnpm proto:code:hnsw # generate js code
pnpm proto:type:hnsw # generate types

# Request protobufs
pnpm proto:code:req # generate js code
pnpm proto:type:req # generate types

Teste

Os testes são executados em alguns casos para um conjunto fixo de $ N, k $ Parâmetros preparados em Python e são comparados no TypeScript. Execute os testes via: