Index

A

after() (xpmir.context.InitializationHook method) (xpmir.letor.context.InitializationTrainingHook method) (xpmir.letor.context.StepTrainingHook method)

aggregated (xpmir.evaluation.Evaluate attribute) aggregation (xpmir.neural.splade.SpladeTextEncoder attribute) AP (in module xpmir.measures) assessments (xpmir.datasets.adapters.RandomFold attribute)

B

b (xpmir.rankers.standard.BM25 attribute) base (xpmir.datasets.adapters.AdhocDocumentSubset attribute) batch_size (xpmir.letor.trainers.LossTrainer attribute) (xpmir.letor.trainers.pairwise.PairwiseTrainer attribute) (xpmir.letor.trainers.pointwise.PointwiseTrainer attribute), [1] batcher (xpmir.letor.trainers.LossTrainer attribute) (xpmir.letor.trainers.pairwise.PairwiseTrainer attribute) (xpmir.letor.trainers.pointwise.PointwiseTrainer attribute), [1] (xpmir.rankers.TwoStageRetriever attribute)

batchsize (xpmir.rankers.TwoStageRetriever attribute) before() (xpmir.context.InitializationHook method) (xpmir.letor.context.InitializationTrainingHook method) (xpmir.letor.context.StepTrainingHook method)

C

checkpoint (xpmir.neural.colbert.Colbert attribute) (xpmir.neural.cross.CrossScorer attribute) (xpmir.neural.dual.CosineDense attribute) (xpmir.neural.dual.Dense attribute) (xpmir.neural.dual.DotDense attribute) (xpmir.neural.DualRepresentationScorer attribute) (xpmir.neural.interaction.drmm.Drmm attribute) (xpmir.neural.interaction.InteractionScorer attribute) (xpmir.rankers.LearnableScorer attribute)

checkpoint_interval (xpmir.letor.learner.Learner attribute) checkpointspath (xpmir.letor.learner.Learner attribute) collection() (xpmir.rankers.Retriever method) combine (xpmir.neural.interaction.drmm.Drmm attribute) compression_size (xpmir.neural.colbert.Colbert attribute) count (xpmir.datasets.adapters.AdhocDocumentSubset attribute) (xpmir.datasets.irds.data.AdhocDocuments attribute) (xpmir.interfaces.anserini.Index attribute) cpu_fallback (xpmir.letor.devices.CudaDevice attribute) cutoff (xpmir.measures.Measure attribute)

D

dataset (xpmir.datasets.adapters.RandomFold attribute) (xpmir.datasets.adapters.RetrieverBasedCollection attribute) (xpmir.evaluation.Evaluate attribute) (xpmir.letor.samplers.PairwiseModelBasedSampler attribute) (xpmir.letor.samplers.PointwiseModelBasedSampler attribute) detailed (xpmir.evaluation.Evaluate attribute) device (xpmir.letor.learner.Learner attribute) (xpmir.rankers.TwoStageRetriever attribute)

distributed (xpmir.letor.devices.CudaDevice attribute) dlen (xpmir.neural.colbert.Colbert attribute) (xpmir.neural.interaction.drmm.Drmm attribute) (xpmir.neural.interaction.InteractionScorer attribute) docids_path (xpmir.datasets.adapters.AdhocDocumentSubset attribute) (xpmir.datasets.adapters.RetrieverBasedCollection attribute) doctoken (xpmir.neural.colbert.Colbert attribute) documents (xpmir.documents.samplers.BatchwiseRandomSpanSampler attribute)

E

encoder (xpmir.neural.cross.CrossScorer attribute) (xpmir.neural.dual.CosineDense attribute) (xpmir.neural.dual.Dense attribute) (xpmir.neural.dual.DotDense attribute) (xpmir.neural.splade.SpladeTextEncoder attribute) (xpmir.text.huggingface.ContextualizedTextEncoderAdapter attribute)

exclude (xpmir.datasets.adapters.RandomFold attribute)

F

filter (xpmir.letor.optim.ParameterOptimizer attribute) fold (xpmir.datasets.adapters.RandomFold attribute) forward() (xpmir.text.encoders.DualTextEncoder method) (xpmir.text.encoders.TextEncoder method)

freeze_embeddings (xpmir.text.huggingface.LayerFreezer attribute) frozen (xpmir.text.huggingface.LayerFreezer attribute)

G

getindex() (xpmir.rankers.Retriever method)

gpu_determ (xpmir.letor.devices.CudaDevice attribute)

H

hidden (xpmir.neural.interaction.drmm.Drmm attribute) hist (xpmir.neural.interaction.drmm.Drmm attribute) hooks (xpmir.letor.learner.Learner attribute) (xpmir.letor.trainers.LossTrainer attribute) (xpmir.letor.trainers.pairwise.PairwiseTrainer attribute) (xpmir.letor.trainers.pointwise.PointwiseTrainer attribute), [1] (xpmir.letor.trainers.Trainer attribute)

I

id (xpmir.datasets.adapters.AdhocAssessmentFold attribute) (xpmir.datasets.adapters.AdhocDocumentSubset attribute) (xpmir.datasets.adapters.AdhocTopicFold attribute) (xpmir.datasets.irds.data.AdhocAssessments attribute) (xpmir.datasets.irds.data.AdhocDocuments attribute) (xpmir.datasets.irds.data.AdhocTopics attribute) (xpmir.interfaces.anserini.Index attribute)

identifier (xpmir.measures.Measure attribute) ids (xpmir.datasets.adapters.AdhocAssessmentFold attribute) (xpmir.datasets.adapters.AdhocTopicFold attribute) index (xpmir.interfaces.anserini.AnseriniRetriever attribute) (xpmir.neural.interaction.drmm.Drmm attribute) irds (xpmir.datasets.irds.data.AdhocAssessments attribute) (xpmir.datasets.irds.data.AdhocDocuments attribute) (xpmir.datasets.irds.data.AdhocTopics attribute)

K

k (xpmir.interfaces.anserini.AnseriniRetriever attribute) k1 (xpmir.rankers.standard.BM25 attribute)

keepNotRelevant (xpmir.datasets.adapters.RetrieverBasedCollection attribute) keepRelevant (xpmir.datasets.adapters.RetrieverBasedCollection attribute)

L

listeners (namedtuple field) LearnerOutput (namedtuple in xpmir.letor.learner) layer (xpmir.text.huggingface.DualTransformerEncoder attribute) (xpmir.text.huggingface.IndependentTransformerVocab attribute) (xpmir.text.huggingface.TransformerVocab attribute) LearnerOutput (namedtuple in xpmir.letor.learner) listeners (namedtuple field)

linear_dim (xpmir.neural.colbert.Colbert attribute) listeners (xpmir.letor.learner.Learner attribute) logpath (xpmir.letor.learner.Learner attribute) lossfn (xpmir.letor.trainers.pairwise.PairwiseTrainer attribute) (xpmir.letor.trainers.pointwise.PointwiseTrainer attribute), [1]

M

margin (xpmir.letor.trainers.pairwise.HingeLoss attribute) masktoken (xpmir.neural.colbert.Colbert attribute) max_epochs (xpmir.letor.learner.Learner attribute) max_spansize (xpmir.documents.samplers.BatchwiseRandomSpanSampler attribute) maxlen (xpmir.neural.splade.SpladeTextEncoder attribute) (xpmir.text.huggingface.ContextualizedTextEncoderAdapter attribute) (xpmir.text.huggingface.DualTransformerEncoder attribute) measures (xpmir.evaluation.Evaluate attribute) min_factor (xpmir.letor.schedulers.LinearWithWarmup attribute), [1]

model (xpmir.interfaces.anserini.AnseriniRetriever attribute) model_id (xpmir.text.huggingface.DualTransformerEncoder attribute) (xpmir.text.huggingface.IndependentTransformerVocab attribute) (xpmir.text.huggingface.TransformerVocab attribute) module xpmir.letor.records xpmir.letor.schedulers xpmir.measures xpmir.neural.pretrained module (xpmir.letor.optim.ParameterOptimizer attribute)

N

nDCG (in module xpmir.measures) num_cycles (xpmir.letor.schedulers.CosineWithWarmup attribute), [1]

num_warmup_steps (xpmir.letor.schedulers.CosineWithWarmup attribute), [1] (xpmir.letor.schedulers.LinearWithWarmup attribute), [1]

O

optimizer (xpmir.letor.optim.ParameterOptimizer attribute)

optimizers (xpmir.letor.learner.Learner attribute)

P

P (in module xpmir.measures) PairwiseRecord (class in xpmir.letor.records) path (xpmir.interfaces.anserini.Index attribute)

pointwise_iter() (xpmir.letor.samplers.PointwiseSampler method) PointwiseRecord (class in xpmir.letor.records) process_microbatch() (xpmir.letor.trainers.LossTrainer method)

Q

qlen (xpmir.neural.colbert.Colbert attribute) (xpmir.neural.interaction.drmm.Drmm attribute) (xpmir.neural.interaction.InteractionScorer attribute) qrels (xpmir.datasets.adapters.AdhocAssessmentFold attribute)

query_encoder (xpmir.neural.dual.CosineDense attribute) (xpmir.neural.dual.Dense attribute) (xpmir.neural.dual.DotDense attribute) querytoken (xpmir.neural.colbert.Colbert attribute)

R

random (xpmir.letor.learner.Learner attribute) (xpmir.rankers.RandomScorer attribute) rel (xpmir.measures.Measure attribute) relevance_threshold (xpmir.datasets.adapters.RetrieverBasedCollection attribute) relevant_ratio (xpmir.letor.samplers.PointwiseModelBasedSampler attribute) retrieve() (xpmir.rankers.Retriever method)

retrieve_all() (xpmir.rankers.Retriever method) retriever (xpmir.evaluation.Evaluate attribute) (xpmir.letor.samplers.PairwiseModelBasedSampler attribute) (xpmir.letor.samplers.PointwiseModelBasedSampler attribute) (xpmir.rankers.TwoStageRetriever attribute) retrievers (xpmir.datasets.adapters.RetrieverBasedCollection attribute) RR (in module xpmir.measures)

S

sampler (xpmir.letor.trainers.LossTrainer attribute) (xpmir.letor.trainers.pairwise.PairwiseTrainer attribute) (xpmir.letor.trainers.pointwise.PointwiseTrainer attribute), [1] scheduler (xpmir.letor.optim.ParameterOptimizer attribute) score_pairs() (xpmir.neural.DualRepresentationScorer method) score_product() (xpmir.neural.DualRepresentationScorer method) ScoredDocument (class in xpmir.rankers) scorer (xpmir.letor.learner.Learner attribute) (xpmir.rankers.TwoStageRetriever attribute) seed (xpmir.datasets.adapters.RandomFold attribute) (xpmir.letor.Random attribute)

SerializableIterator (class in xpmir.letor.samplers) similarity (xpmir.neural.colbert.Colbert attribute) sizes (xpmir.datasets.adapters.RandomFold attribute) spladev2() (in module xpmir.neural.pretrained) stemmer (xpmir.interfaces.anserini.Index attribute) steps_per_epoch (xpmir.letor.learner.Learner attribute) storeContents (xpmir.interfaces.anserini.Index attribute) storeDocvectors (xpmir.interfaces.anserini.Index attribute) storePositions (xpmir.interfaces.anserini.Index attribute) storeRaw (xpmir.interfaces.anserini.Index attribute)

T

tas_balanced() (in module xpmir.neural.pretrained) topics (xpmir.datasets.adapters.AdhocTopicFold attribute) (xpmir.datasets.adapters.MemoryTopicStore attribute) (xpmir.datasets.adapters.RandomFold attribute) trainable (xpmir.text.huggingface.DualTransformerEncoder attribute) (xpmir.text.huggingface.IndependentTransformerVocab attribute) (xpmir.text.huggingface.TransformerVocab attribute)

trainer (xpmir.letor.learner.Learner attribute) transformer (xpmir.text.huggingface.DistributedModelHook attribute) (xpmir.text.huggingface.LayerFreezer attribute)

U

use_fp16 (xpmir.letor.learner.Learner attribute)

V

version (xpmir.neural.colbert.Colbert attribute) vocab (xpmir.neural.colbert.Colbert attribute) (xpmir.neural.interaction.drmm.Drmm attribute) (xpmir.neural.interaction.InteractionScorer attribute)

W

weight (xpmir.letor.trainers.pairwise.CrossEntropyLoss attribute) (xpmir.letor.trainers.pairwise.HingeLoss attribute) (xpmir.letor.trainers.pairwise.LogSoftmaxLoss attribute) (xpmir.letor.trainers.pairwise.PairwiseLoss attribute) (xpmir.letor.trainers.pairwise.SoftmaxLoss attribute) (xpmir.letor.trainers.pointwise.BinaryCrossEntropyLoss attribute) (xpmir.letor.trainers.pointwise.MSELoss attribute) (xpmir.letor.trainers.pointwise.PointwiseLoss attribute)

X

xpmir.letor.records module xpmir.letor.schedulers module

xpmir.measures module xpmir.neural.pretrained module