Struct DistributionShift

pub struct DistributionShift {
    pub current_mean: OrderedFloat<f32>,
    pub current_sigma: OrderedFloat<f32>,
}

Describes the mean and sigma of distribution of embedding similarity in the embedding space.

The intended use is to make the similarity score more comparable to the regular ranking score. This allows to correct effects where results are too “packed” around a certain value.

Fields

current_mean: OrderedFloat<f32>

Value where the results are “packed”.

Similarity scores are translated so that they are packed around 0.5 instead

current_sigma: OrderedFloat<f32>

standard deviation of a similarity score.

Set below 0.4 to make the results less packed around the mean, and above 0.4 to make them more packed.

Implementations

impl DistributionShift

pub fn new(mean: f32, sigma: f32) -> Option<Self>

None if sigma <= 0.

pub fn shift(&self, score: f32) -> f32

Trait Implementations

impl Clone for DistributionShift

fn clone(&self) -> DistributionShift

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ComposeSchema for DistributionShift

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for DistributionShift

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DistributionShift

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<E> Deserr<E> for DistributionShift

where E: DeserializeError,

fn deserialize_from_value<V: IntoValue>( value: Value<V>, location: ValuePointerRef<'_>, ) -> Result<Self, E>

Attempts to deserialize Self from the given value. Note that this method is an implementation detail. You probably want to use the deserialize function directly instead.

impl Hash for DistributionShift

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for DistributionShift

fn eq(&self, other: &DistributionShift) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for DistributionShift

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for DistributionShift

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.

impl Copy for DistributionShift

impl Eq for DistributionShift

impl StructuralPartialEq for DistributionShift