Skip to content

Commit

Permalink
Removing ResidalCodec.
Browse files Browse the repository at this point in the history
  • Loading branch information
codetalker7 committed Aug 16, 2024
1 parent d8078eb commit affdb5e
Showing 1 changed file with 0 additions and 29 deletions.
29 changes: 0 additions & 29 deletions src/indexing/codecs/residual.jl
Original file line number Diff line number Diff line change
@@ -1,32 +1,3 @@
"""
ResidualCodec(
config::ColBERTConfig, centroids::AbstractMatrix{Float32}, avg_residual::Float32,
bucket_cutoffs::AbstractVector{Float32}, bucket_weights::AbstractVector{Float32})
A struct that represents a compressor for ColBERT embeddings.
It stores information about the configuration of the model, the centroids used to quantize the residuals, the average residual value, and the cutoffs and weights used to determine which buckets each residual belongs to.
# Arguments
- `config`: A [`ColBERTConfig`](@ref), representing all configuration parameters related to various ColBERT components.
- `centroids`: A matrix of centroids used to quantize the residuals. Has shape `(D, N)`, where `D` is the embedding dimension and `N` is the number of clusters.
- `avg_residual`: The average residual value.
- `bucket_cutoffs`: A vector of cutoff values used to determine which buckets each residual belongs to.
- `bucket_weights`: A vector of weights used to determine the importance of each bucket.
# Returns
A `ResidualCodec` object.
"""
mutable struct ResidualCodec
config::ColBERTConfig
centroids::AbstractMatrix{Float32}
avg_residual::Float32
bucket_cutoffs::AbstractVector{Float32}
bucket_weights::AbstractVector{Float32}
end

"""
load_codec(index_path::String)
Expand Down

0 comments on commit affdb5e

Please sign in to comment.