capreolus.searcher.anserini
¶
Module Contents¶
Classes¶
MixIn for searchers that use Anserini's SearchCollection script |
|
Anserini BM25. This searcher's parameters can also be specified as lists indicating parameters to grid search (e.g., |
|
Deprecated. BM25 with a grid search for k1 and b. Search is from 0.1 to bmax/k1max in 0.1 increments |
|
Anserini BM25 with RM3 expansion. This searcher's parameters can also be specified as lists indicating parameters to grid search (e.g., |
|
Anserini BM25. This searcher's parameters can also be specified as lists indicating parameters to grid search (e.g., |
|
Base class for Searcher modules. The purpose of a Searcher is to query a collection via an |
|
Tuned BM25+RM3 run used by Yang et al. in [1]. This should be used only with a benchmark using the same folds and queries. |
|
Tuned BM25+RM3 robust04 description run on the folds used by Yang et al. in [1]. This should be used only with a benchmark using the same folds and queries. |
|
Base class for Searcher modules. The purpose of a Searcher is to query a collection via an |
|
Base class for Searcher modules. The purpose of a Searcher is to query a collection via an |
|
Base class for Searcher modules. The purpose of a Searcher is to query a collection via an |
|
Base class for Searcher modules. The purpose of a Searcher is to query a collection via an |
|
Base class for Searcher modules. The purpose of a Searcher is to query a collection via an |
|
CDS BM25 run with k1=4.0, b=0.6 and new CDS 2016 documents removed from the 2014 and 2015 queries |
|
Base class for Searcher modules. The purpose of a Searcher is to query a collection via an |
|
Base class for Searcher modules. The purpose of a Searcher is to query a collection via an |
|
Base class for Searcher modules. The purpose of a Searcher is to query a collection via an |
|
Anserini BM25 PRF. This searcher's parameters can also be specified as lists indicating parameters to grid search (e.g., |
|
Anserini BM25 with Axiomatic query expansion. This searcher's parameters can also be specified as lists indicating parameters to grid search (e.g., |
|
Anserini QL with Dirichlet smoothing. This searcher's parameters can also be specified as lists indicating parameters to grid search (e.g., |
|
Anserini QL with Jelinek-Mercer smoothing. This searcher's parameters can also be specified as lists indicating parameters to grid search (e.g., |
|
Anserini I(n)L2 scoring model. This searcher does not support list parameters. |
|
Anserini SPL scoring model. This searcher does not support list parameters. |
|
F2Exp scoring model. This searcher does not support list parameters. |
|
F2Log scoring model. This searcher does not support list parameters. |
|
Anserini BM25 with the Sequential Dependency Model. This searcher supports list parameters for only k1 and b. |
Functions¶
|
Attributes¶
- class capreolus.searcher.anserini.AnseriniSearcherMixIn[source]¶
MixIn for searchers that use Anserini’s SearchCollection script
- class capreolus.searcher.anserini.BM25(config=None, provide=None, share_dependency_objects=False, build=True)[source]¶
Bases:
AnseriniSearcherMixIn
,capreolus.searcher.Searcher
Anserini BM25. This searcher’s parameters can also be specified as lists indicating parameters to grid search (e.g.,
"0.4,0.6,0.8,1.0"
or"0.4..1,0.2"
).
- class capreolus.searcher.anserini.BM25Grid(config=None, provide=None, share_dependency_objects=False, build=True)[source]¶
Bases:
AnseriniSearcherMixIn
,capreolus.searcher.Searcher
Deprecated. BM25 with a grid search for k1 and b. Search is from 0.1 to bmax/k1max in 0.1 increments
- class capreolus.searcher.anserini.BM25RM3(config=None, provide=None, share_dependency_objects=False, build=True)[source]¶
Bases:
AnseriniSearcherMixIn
,capreolus.searcher.Searcher
Anserini BM25 with RM3 expansion. This searcher’s parameters can also be specified as lists indicating parameters to grid search (e.g.,
"0.4,0.6,0.8,1.0"
or"0.4..1,0.2"
).
- class capreolus.searcher.anserini.BM25PostProcess(config=None, provide=None, share_dependency_objects=False, build=True)[source]¶
Bases:
BM25
,PostprocessMixin
Anserini BM25. This searcher’s parameters can also be specified as lists indicating parameters to grid search (e.g.,
"0.4,0.6,0.8,1.0"
or"0.4..1,0.2"
).
- class capreolus.searcher.anserini.StaticRun(config=None, provide=None, share_dependency_objects=False, build=True)[source]¶
Bases:
capreolus.searcher.Searcher
Base class for Searcher modules. The purpose of a Searcher is to query a collection via an
Index
module.Similar to Rerankers, Searchers return a list of documents and their relevance scores for a given query. Searchers are unsupervised and efficient, whereas Rerankers are supervised and do not use an inverted index directly.
- Modules should provide:
a
query(string)
and aquery_from_file(path)
method that return document scores
- class capreolus.searcher.anserini.StaticBM25RM3Rob04Yang19(config=None, provide=None, share_dependency_objects=False, build=True)[source]¶
Bases:
StaticRun
Tuned BM25+RM3 run used by Yang et al. in [1]. This should be used only with a benchmark using the same folds and queries.
[1] Wei Yang, Kuang Lu, Peilin Yang, and Jimmy Lin. Critically Examining the “Neural Hype”: Weak Baselines and the Additivity of Effectiveness Gains from Neural Ranking Models. SIGIR 2019.
- class capreolus.searcher.anserini.StaticBM25RM3Rob04Yang19Desc(config=None, provide=None, share_dependency_objects=False, build=True)[source]¶
Bases:
StaticRun
Tuned BM25+RM3 robust04 description run on the folds used by Yang et al. in [1]. This should be used only with a benchmark using the same folds and queries.
[1] Wei Yang, Kuang Lu, Peilin Yang, and Jimmy Lin. Critically Examining the “Neural Hype”: Weak Baselines and the Additivity of Effectiveness Gains from Neural Ranking Models. SIGIR 2019.
- class capreolus.searcher.anserini.StaticBM25Rob04Huston14Title(config=None, provide=None, share_dependency_objects=False, build=True)[source]¶
Bases:
StaticRun
Base class for Searcher modules. The purpose of a Searcher is to query a collection via an
Index
module.Similar to Rerankers, Searchers return a list of documents and their relevance scores for a given query. Searchers are unsupervised and efficient, whereas Rerankers are supervised and do not use an inverted index directly.
- Modules should provide:
a
query(string)
and aquery_from_file(path)
method that return document scores
- class capreolus.searcher.anserini.StaticBM25Rob04Huston14Desc(config=None, provide=None, share_dependency_objects=False, build=True)[source]¶
Bases:
StaticRun
Base class for Searcher modules. The purpose of a Searcher is to query a collection via an
Index
module.Similar to Rerankers, Searchers return a list of documents and their relevance scores for a given query. Searchers are unsupervised and efficient, whereas Rerankers are supervised and do not use an inverted index directly.
- Modules should provide:
a
query(string)
and aquery_from_file(path)
method that return document scores
- class capreolus.searcher.anserini.StaticBM25Gov2(config=None, provide=None, share_dependency_objects=False, build=True)[source]¶
Bases:
StaticRun
Base class for Searcher modules. The purpose of a Searcher is to query a collection via an
Index
module.Similar to Rerankers, Searchers return a list of documents and their relevance scores for a given query. Searchers are unsupervised and efficient, whereas Rerankers are supervised and do not use an inverted index directly.
- Modules should provide:
a
query(string)
and aquery_from_file(path)
method that return document scores
- class capreolus.searcher.anserini.StaticBM25Gov2Desc(config=None, provide=None, share_dependency_objects=False, build=True)[source]¶
Bases:
StaticRun
Base class for Searcher modules. The purpose of a Searcher is to query a collection via an
Index
module.Similar to Rerankers, Searchers return a list of documents and their relevance scores for a given query. Searchers are unsupervised and efficient, whereas Rerankers are supervised and do not use an inverted index directly.
- Modules should provide:
a
query(string)
and aquery_from_file(path)
method that return document scores
- class capreolus.searcher.anserini.StaticBM25Genomics(config=None, provide=None, share_dependency_objects=False, build=True)[source]¶
Bases:
StaticRun
Base class for Searcher modules. The purpose of a Searcher is to query a collection via an
Index
module.Similar to Rerankers, Searchers return a list of documents and their relevance scores for a given query. Searchers are unsupervised and efficient, whereas Rerankers are supervised and do not use an inverted index directly.
- Modules should provide:
a
query(string)
and aquery_from_file(path)
method that return document scores
- class capreolus.searcher.anserini.StaticBM25CDS(config=None, provide=None, share_dependency_objects=False, build=True)[source]¶
Bases:
StaticRun
CDS BM25 run with k1=4.0, b=0.6 and new CDS 2016 documents removed from the 2014 and 2015 queries
- class capreolus.searcher.anserini.StaticCovidUdelAbstract(config=None, provide=None, share_dependency_objects=False, build=True)[source]¶
Bases:
StaticRun
Base class for Searcher modules. The purpose of a Searcher is to query a collection via an
Index
module.Similar to Rerankers, Searchers return a list of documents and their relevance scores for a given query. Searchers are unsupervised and efficient, whereas Rerankers are supervised and do not use an inverted index directly.
- Modules should provide:
a
query(string)
and aquery_from_file(path)
method that return document scores
- class capreolus.searcher.anserini.StaticRM3TitleCore18(config=None, provide=None, share_dependency_objects=False, build=True)[source]¶
Bases:
StaticRun
Base class for Searcher modules. The purpose of a Searcher is to query a collection via an
Index
module.Similar to Rerankers, Searchers return a list of documents and their relevance scores for a given query. Searchers are unsupervised and efficient, whereas Rerankers are supervised and do not use an inverted index directly.
- Modules should provide:
a
query(string)
and aquery_from_file(path)
method that return document scores
- class capreolus.searcher.anserini.StaticRM3DescCore18(config=None, provide=None, share_dependency_objects=False, build=True)[source]¶
Bases:
StaticRun
Base class for Searcher modules. The purpose of a Searcher is to query a collection via an
Index
module.Similar to Rerankers, Searchers return a list of documents and their relevance scores for a given query. Searchers are unsupervised and efficient, whereas Rerankers are supervised and do not use an inverted index directly.
- Modules should provide:
a
query(string)
and aquery_from_file(path)
method that return document scores
- class capreolus.searcher.anserini.BM25PRF(config=None, provide=None, share_dependency_objects=False, build=True)[source]¶
Bases:
AnseriniSearcherMixIn
,capreolus.searcher.Searcher
Anserini BM25 PRF. This searcher’s parameters can also be specified as lists indicating parameters to grid search (e.g.,
"0.4,0.6,0.8,1.0"
or"0.4..1,0.2"
).
- class capreolus.searcher.anserini.AxiomaticSemanticMatching(config=None, provide=None, share_dependency_objects=False, build=True)[source]¶
Bases:
AnseriniSearcherMixIn
,capreolus.searcher.Searcher
Anserini BM25 with Axiomatic query expansion. This searcher’s parameters can also be specified as lists indicating parameters to grid search (e.g.,
"0.4,0.6,0.8,1.0"
or"0.4..1,0.2"
).
- class capreolus.searcher.anserini.DirichletQL(config=None, provide=None, share_dependency_objects=False, build=True)[source]¶
Bases:
AnseriniSearcherMixIn
,capreolus.searcher.Searcher
Anserini QL with Dirichlet smoothing. This searcher’s parameters can also be specified as lists indicating parameters to grid search (e.g.,
"0.4,0.6,0.8,1.0"
or"0.4..1,0.2"
).
- class capreolus.searcher.anserini.QLJM(config=None, provide=None, share_dependency_objects=False, build=True)[source]¶
Bases:
AnseriniSearcherMixIn
,capreolus.searcher.Searcher
Anserini QL with Jelinek-Mercer smoothing. This searcher’s parameters can also be specified as lists indicating parameters to grid search (e.g.,
"0.4,0.6,0.8,1.0"
or"0.4..1,0.2"
).
- class capreolus.searcher.anserini.INL2(config=None, provide=None, share_dependency_objects=False, build=True)[source]¶
Bases:
AnseriniSearcherMixIn
,capreolus.searcher.Searcher
Anserini I(n)L2 scoring model. This searcher does not support list parameters.
- class capreolus.searcher.anserini.SPL(config=None, provide=None, share_dependency_objects=False, build=True)[source]¶
Bases:
AnseriniSearcherMixIn
,capreolus.searcher.Searcher
Anserini SPL scoring model. This searcher does not support list parameters.
- class capreolus.searcher.anserini.F2Exp(config=None, provide=None, share_dependency_objects=False, build=True)[source]¶
Bases:
AnseriniSearcherMixIn
,capreolus.searcher.Searcher
F2Exp scoring model. This searcher does not support list parameters.
- class capreolus.searcher.anserini.F2Log(config=None, provide=None, share_dependency_objects=False, build=True)[source]¶
Bases:
AnseriniSearcherMixIn
,capreolus.searcher.Searcher
F2Log scoring model. This searcher does not support list parameters.
- class capreolus.searcher.anserini.SDM(config=None, provide=None, share_dependency_objects=False, build=True)[source]¶
Bases:
AnseriniSearcherMixIn
,capreolus.searcher.Searcher
Anserini BM25 with the Sequential Dependency Model. This searcher supports list parameters for only k1 and b.