OpenICL
latest
Getting Started
Installation
A Simple Example
Tutorials
Tutorials List
Modules
DatasetReader
PromptTemplate
Inferencer
Retriever
OpenICL
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
G
|
I
|
L
|
M
|
O
|
P
|
R
|
S
|
T
|
V
|
Z
A
accelerator (openicl.icl_inferencer.icl_base_inferencer.BaseInferencer attribute)
(openicl.icl_inferencer.icl_cot_inferencer.CoTInferencer attribute)
(openicl.icl_inferencer.icl_gen_inferencer.GenInferencer attribute)
(openicl.icl_inferencer.icl_ppl_inferencer.PPLInferencer attribute)
(openicl.icl_retriever.icl_base_retriever.BaseRetriever attribute)
(openicl.icl_retriever.icl_bm25_retriever.BM25Retriever attribute)
(openicl.icl_retriever.icl_dpp_retriever.DPPRetriever attribute)
(openicl.icl_retriever.icl_mdl_retriever.MDLRetriever attribute)
(openicl.icl_retriever.icl_random_retriever.RandomRetriever attribute)
(openicl.icl_retriever.icl_topk_retriever.TopkRetriever attribute)
(openicl.icl_retriever.icl_votek_retriever.VotekRetriever attribute)
(openicl.icl_retriever.icl_zero_retriever.ZeroRetriever attribute)
api_name (openicl.icl_inferencer.icl_base_inferencer.BaseInferencer attribute)
(openicl.icl_inferencer.icl_cot_inferencer.CoTInferencer attribute)
(openicl.icl_inferencer.icl_gen_inferencer.GenInferencer attribute)
(openicl.icl_inferencer.icl_ppl_inferencer.PPLInferencer attribute)
B
BaseInferencer (class in openicl.icl_inferencer.icl_base_inferencer)
BaseRetriever (class in openicl.icl_retriever.icl_base_retriever)
batch_size (openicl.icl_inferencer.icl_base_inferencer.BaseInferencer attribute)
(openicl.icl_inferencer.icl_cot_inferencer.CoTInferencer attribute)
(openicl.icl_inferencer.icl_gen_inferencer.GenInferencer attribute)
(openicl.icl_inferencer.icl_ppl_inferencer.PPLInferencer attribute)
(openicl.icl_retriever.icl_dpp_retriever.DPPRetriever attribute)
(openicl.icl_retriever.icl_mdl_retriever.MDLRetriever attribute)
(openicl.icl_retriever.icl_topk_retriever.TopkRetriever attribute)
(openicl.icl_retriever.icl_votek_retriever.VotekRetriever attribute)
bm25 (openicl.icl_retriever.icl_bm25_retriever.BM25Retriever attribute)
BM25Retriever (class in openicl.icl_retriever.icl_bm25_retriever)
C
call_api (openicl.icl_inferencer.icl_base_inferencer.BaseInferencer attribute)
(openicl.icl_inferencer.icl_cot_inferencer.CoTInferencer attribute)
(openicl.icl_inferencer.icl_gen_inferencer.GenInferencer attribute)
(openicl.icl_inferencer.icl_ppl_inferencer.PPLInferencer attribute)
candidate_num (openicl.icl_retriever.icl_mdl_retriever.MDLRetriever attribute)
column_token_map (openicl.PromptTemplate attribute)
cot_list (openicl.icl_inferencer.icl_cot_inferencer.CoTInferencer attribute)
CoTInferencer (class in openicl.icl_inferencer.icl_cot_inferencer)
D
dataset (openicl.DatasetReader attribute)
dataset_reader (openicl.icl_retriever.icl_base_retriever.BaseRetriever attribute)
(openicl.icl_retriever.icl_bm25_retriever.BM25Retriever attribute)
(openicl.icl_retriever.icl_dpp_retriever.DPPRetriever attribute)
(openicl.icl_retriever.icl_mdl_retriever.MDLRetriever attribute)
(openicl.icl_retriever.icl_random_retriever.RandomRetriever attribute)
(openicl.icl_retriever.icl_topk_retriever.TopkRetriever attribute)
(openicl.icl_retriever.icl_votek_retriever.VotekRetriever attribute)
(openicl.icl_retriever.icl_zero_retriever.ZeroRetriever attribute)
DatasetReader (class in openicl)
DPPRetriever (class in openicl.icl_retriever.icl_dpp_retriever)
ds_size (openicl.DatasetReader attribute)
G
gen_field_replace_token (openicl.icl_inferencer.icl_cot_inferencer.CoTInferencer attribute)
(openicl.icl_inferencer.icl_gen_inferencer.GenInferencer attribute)
generate_ice_item() (openicl.PromptTemplate method)
generate_input_field_corpus() (openicl.DatasetReader method)
generate_input_field_prompt() (openicl.DatasetReader method)
generate_input_output_field_corpus() (openicl.DatasetReader method)
generate_input_output_field_prompt() (openicl.DatasetReader method)
generate_item() (openicl.PromptTemplate method)
generate_label_prompt_item() (openicl.PromptTemplate method)
generate_ouput_field_prompt() (openicl.DatasetReader method)
generate_output_field_corpus() (openicl.DatasetReader method)
generation_kwargs (openicl.icl_inferencer.icl_cot_inferencer.CoTInferencer attribute)
(openicl.icl_inferencer.icl_gen_inferencer.GenInferencer attribute)
GenInferencer (class in openicl.icl_inferencer.icl_gen_inferencer)
I
ice_eos_token (openicl.icl_retriever.icl_base_retriever.BaseRetriever attribute)
(openicl.icl_retriever.icl_bm25_retriever.BM25Retriever attribute)
(openicl.icl_retriever.icl_dpp_retriever.DPPRetriever attribute)
(openicl.icl_retriever.icl_mdl_retriever.MDLRetriever attribute)
(openicl.icl_retriever.icl_random_retriever.RandomRetriever attribute)
(openicl.icl_retriever.icl_topk_retriever.TopkRetriever attribute)
(openicl.icl_retriever.icl_votek_retriever.VotekRetriever attribute)
(openicl.icl_retriever.icl_zero_retriever.ZeroRetriever attribute)
ice_num (openicl.icl_retriever.icl_base_retriever.BaseRetriever attribute)
(openicl.icl_retriever.icl_bm25_retriever.BM25Retriever attribute)
(openicl.icl_retriever.icl_dpp_retriever.DPPRetriever attribute)
(openicl.icl_retriever.icl_mdl_retriever.MDLRetriever attribute)
(openicl.icl_retriever.icl_random_retriever.RandomRetriever attribute)
(openicl.icl_retriever.icl_topk_retriever.TopkRetriever attribute)
(openicl.icl_retriever.icl_votek_retriever.VotekRetriever attribute)
ice_separator (openicl.icl_retriever.icl_base_retriever.BaseRetriever attribute)
(openicl.icl_retriever.icl_bm25_retriever.BM25Retriever attribute)
(openicl.icl_retriever.icl_dpp_retriever.DPPRetriever attribute)
(openicl.icl_retriever.icl_mdl_retriever.MDLRetriever attribute)
(openicl.icl_retriever.icl_random_retriever.RandomRetriever attribute)
(openicl.icl_retriever.icl_topk_retriever.TopkRetriever attribute)
(openicl.icl_retriever.icl_votek_retriever.VotekRetriever attribute)
ice_token (openicl.PromptTemplate attribute)
index (openicl.icl_retriever.icl_dpp_retriever.DPPRetriever attribute)
(openicl.icl_retriever.icl_mdl_retriever.MDLRetriever attribute)
(openicl.icl_retriever.icl_topk_retriever.TopkRetriever attribute)
(openicl.icl_retriever.icl_votek_retriever.VotekRetriever attribute)
index_corpus (openicl.icl_retriever.icl_bm25_retriever.BM25Retriever attribute)
index_ds (openicl.icl_retriever.icl_base_retriever.BaseRetriever attribute)
(openicl.icl_retriever.icl_bm25_retriever.BM25Retriever attribute)
(openicl.icl_retriever.icl_dpp_retriever.DPPRetriever attribute)
(openicl.icl_retriever.icl_mdl_retriever.MDLRetriever attribute)
(openicl.icl_retriever.icl_random_retriever.RandomRetriever attribute)
(openicl.icl_retriever.icl_topk_retriever.TopkRetriever attribute)
(openicl.icl_retriever.icl_votek_retriever.VotekRetriever attribute)
(openicl.icl_retriever.icl_zero_retriever.ZeroRetriever attribute)
index_split (openicl.icl_retriever.icl_base_retriever.BaseRetriever attribute)
(openicl.icl_retriever.icl_bm25_retriever.BM25Retriever attribute)
(openicl.icl_retriever.icl_dpp_retriever.DPPRetriever attribute)
(openicl.icl_retriever.icl_mdl_retriever.MDLRetriever attribute)
(openicl.icl_retriever.icl_random_retriever.RandomRetriever attribute)
(openicl.icl_retriever.icl_topk_retriever.TopkRetriever attribute)
(openicl.icl_retriever.icl_votek_retriever.VotekRetriever attribute)
(openicl.icl_retriever.icl_zero_retriever.ZeroRetriever attribute)
inference() (openicl.icl_inferencer.icl_base_inferencer.BaseInferencer method)
(openicl.icl_inferencer.icl_cot_inferencer.CoTInferencer method)
(openicl.icl_inferencer.icl_gen_inferencer.GenInferencer method)
(openicl.icl_inferencer.icl_ppl_inferencer.PPLInferencer method)
input_columns (openicl.DatasetReader attribute)
input_output_template (openicl.DatasetReader attribute)
input_template (openicl.DatasetReader attribute)
L
labels (openicl.icl_inferencer.icl_ppl_inferencer.PPLInferencer attribute)
(openicl.icl_retriever.icl_mdl_retriever.MDLRetriever attribute)
M
max_model_token_num (openicl.icl_inferencer.icl_base_inferencer.BaseInferencer attribute)
(openicl.icl_inferencer.icl_cot_inferencer.CoTInferencer attribute)
(openicl.icl_inferencer.icl_gen_inferencer.GenInferencer attribute)
(openicl.icl_inferencer.icl_ppl_inferencer.PPLInferencer attribute)
MDLRetriever (class in openicl.icl_retriever.icl_mdl_retriever)
model (openicl.icl_inferencer.icl_base_inferencer.BaseInferencer attribute)
(openicl.icl_inferencer.icl_cot_inferencer.CoTInferencer attribute)
(openicl.icl_inferencer.icl_gen_inferencer.GenInferencer attribute)
(openicl.icl_inferencer.icl_ppl_inferencer.PPLInferencer attribute)
(openicl.icl_retriever.icl_dpp_retriever.DPPRetriever attribute)
(openicl.icl_retriever.icl_mdl_retriever.MDLRetriever attribute)
(openicl.icl_retriever.icl_topk_retriever.TopkRetriever attribute)
(openicl.icl_retriever.icl_votek_retriever.VotekRetriever attribute)
O
output_column (openicl.DatasetReader attribute)
output_json_filename (openicl.icl_inferencer.icl_base_inferencer.BaseInferencer attribute)
(openicl.icl_inferencer.icl_cot_inferencer.CoTInferencer attribute)
(openicl.icl_inferencer.icl_gen_inferencer.GenInferencer attribute)
(openicl.icl_inferencer.icl_ppl_inferencer.PPLInferencer attribute)
output_json_filepath (openicl.icl_inferencer.icl_base_inferencer.BaseInferencer attribute)
(openicl.icl_inferencer.icl_cot_inferencer.CoTInferencer attribute)
(openicl.icl_inferencer.icl_gen_inferencer.GenInferencer attribute)
(openicl.icl_inferencer.icl_ppl_inferencer.PPLInferencer attribute)
output_template (openicl.DatasetReader attribute)
P
PPLInferencer (class in openicl.icl_inferencer.icl_ppl_inferencer)
prompt_eos_token (openicl.icl_retriever.icl_base_retriever.BaseRetriever attribute)
(openicl.icl_retriever.icl_bm25_retriever.BM25Retriever attribute)
(openicl.icl_retriever.icl_dpp_retriever.DPPRetriever attribute)
(openicl.icl_retriever.icl_mdl_retriever.MDLRetriever attribute)
(openicl.icl_retriever.icl_random_retriever.RandomRetriever attribute)
(openicl.icl_retriever.icl_topk_retriever.TopkRetriever attribute)
(openicl.icl_retriever.icl_votek_retriever.VotekRetriever attribute)
(openicl.icl_retriever.icl_zero_retriever.ZeroRetriever attribute)
PromptTemplate (class in openicl)
R
RandomRetriever (class in openicl.icl_retriever.icl_random_retriever)
references (openicl.DatasetReader attribute)
retrieve() (openicl.icl_retriever.icl_base_retriever.BaseRetriever method)
(openicl.icl_retriever.icl_bm25_retriever.BM25Retriever method)
(openicl.icl_retriever.icl_dpp_retriever.DPPRetriever method)
(openicl.icl_retriever.icl_mdl_retriever.MDLRetriever method)
(openicl.icl_retriever.icl_random_retriever.RandomRetriever method)
(openicl.icl_retriever.icl_topk_retriever.TopkRetriever method)
(openicl.icl_retriever.icl_votek_retriever.VotekRetriever method)
(openicl.icl_retriever.icl_zero_retriever.ZeroRetriever method)
S
scale_factor (openicl.icl_retriever.icl_dpp_retriever.DPPRetriever attribute)
seed (openicl.icl_retriever.icl_dpp_retriever.DPPRetriever attribute)
(openicl.icl_retriever.icl_mdl_retriever.MDLRetriever attribute)
(openicl.icl_retriever.icl_random_retriever.RandomRetriever attribute)
select_time (openicl.icl_retriever.icl_mdl_retriever.MDLRetriever attribute)
selected_column_map (openicl.PromptTemplate attribute)
selected_column_name (openicl.PromptTemplate attribute)
set_references() (openicl.DatasetReader method)
T
template (openicl.PromptTemplate attribute)
test_corpus (openicl.icl_retriever.icl_bm25_retriever.BM25Retriever attribute)
test_ds (openicl.icl_retriever.icl_base_retriever.BaseRetriever attribute)
(openicl.icl_retriever.icl_bm25_retriever.BM25Retriever attribute)
(openicl.icl_retriever.icl_dpp_retriever.DPPRetriever attribute)
(openicl.icl_retriever.icl_mdl_retriever.MDLRetriever attribute)
(openicl.icl_retriever.icl_random_retriever.RandomRetriever attribute)
(openicl.icl_retriever.icl_topk_retriever.TopkRetriever attribute)
(openicl.icl_retriever.icl_votek_retriever.VotekRetriever attribute)
(openicl.icl_retriever.icl_zero_retriever.ZeroRetriever attribute)
test_split (openicl.icl_retriever.icl_base_retriever.BaseRetriever attribute)
(openicl.icl_retriever.icl_bm25_retriever.BM25Retriever attribute)
(openicl.icl_retriever.icl_dpp_retriever.DPPRetriever attribute)
(openicl.icl_retriever.icl_mdl_retriever.MDLRetriever attribute)
(openicl.icl_retriever.icl_random_retriever.RandomRetriever attribute)
(openicl.icl_retriever.icl_topk_retriever.TopkRetriever attribute)
(openicl.icl_retriever.icl_votek_retriever.VotekRetriever attribute)
(openicl.icl_retriever.icl_zero_retriever.ZeroRetriever attribute)
tokenizer (openicl.icl_inferencer.icl_base_inferencer.BaseInferencer attribute)
(openicl.icl_inferencer.icl_cot_inferencer.CoTInferencer attribute)
(openicl.icl_inferencer.icl_gen_inferencer.GenInferencer attribute)
(openicl.icl_inferencer.icl_ppl_inferencer.PPLInferencer attribute)
(openicl.icl_retriever.icl_dpp_retriever.DPPRetriever attribute)
(openicl.icl_retriever.icl_mdl_retriever.MDLRetriever attribute)
(openicl.icl_retriever.icl_topk_retriever.TopkRetriever attribute)
(openicl.icl_retriever.icl_votek_retriever.VotekRetriever attribute)
TopkRetriever (class in openicl.icl_retriever.icl_topk_retriever)
V
votek_k (openicl.icl_retriever.icl_votek_retriever.VotekRetriever attribute)
VotekRetriever (class in openicl.icl_retriever.icl_votek_retriever)
Z
ZeroRetriever (class in openicl.icl_retriever.icl_zero_retriever)