folktexts
0.6.0
🏠 Home
📖 Readme file
🎛️ Configuring prompts
📝 Updates
⚙️ API reference
📓 Example notebooks
folktexts
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
A
ACS_DATASET_CONFIGS (folktexts.benchmark.Benchmark attribute)
ACSDataset (class in folktexts.acs.acs_dataset)
ACSTaskMetadata (class in folktexts.acs.acs_tasks)
add_pad_token() (in module folktexts.llm_utils)
add_task_description (folktexts.prompting.VaryPrefix attribute)
answer_keys (folktexts.qa_interface.MultipleChoiceQA property)
answer_probability (folktexts.qa_interface.DirectNumericQA attribute)
apply_chat_template() (in module folktexts.prompting)
apply_to_column_data() (folktexts.threshold.Threshold method)
apply_to_column_name() (folktexts.threshold.Threshold method)
B
batch_size (folktexts.benchmark.BenchmarkConfig attribute)
,
[1]
Benchmark (class in folktexts.benchmark)
BenchmarkConfig (class in folktexts.benchmark)
bootstrap_estimate() (in module folktexts.evaluation)
build() (folktexts.prompting.PromptBuilder method)
build_chat() (folktexts.prompting.PromptBuilder method)
build_few_shot() (folktexts.prompting.PromptBuilder method)
C
ChainOfThoughtQA (class in folktexts.qa_interface)
chat_prompt (folktexts.benchmark.BenchmarkConfig attribute)
,
[1]
check_task_columns_are_available() (folktexts.task.TaskMetadata method)
check_webAPI_deps() (folktexts.classifier.web_api_classifier.WebAPILLMClassifier static method)
Choice (class in folktexts.qa_interface)
choice_to_key (folktexts.qa_interface.MultipleChoiceQA property)
choices (folktexts.qa_interface.MultipleChoiceQA attribute)
col (folktexts.prompting.FeatureItem attribute)
cols_to_text (folktexts.prompting.VaryValueMap attribute)
(folktexts.task.TaskMetadata attribute)
column (folktexts.qa_interface.QAInterface attribute)
ColumnToText (class in folktexts.col_to_text)
compose (folktexts.prompting.FewShotConfig attribute)
compute_best_threshold() (in module folktexts.evaluation)
compute_feature_importance() (in module folktexts.cli.eval_feature_importance)
compute_risk_estimates_for_dataframe() (folktexts.classifier.base.LLMClassifier method)
compute_risk_estimates_for_dataset() (folktexts.classifier.base.LLMClassifier method)
configs_dict (folktexts.benchmark.Benchmark property)
connected (folktexts.prompting.FeatureItem attribute)
connector (folktexts.prompting.PromptConfig attribute)
(folktexts.prompting.VaryConnector attribute)
context_size (folktexts.benchmark.BenchmarkConfig attribute)
,
[1]
correct_order_bias (folktexts.benchmark.BenchmarkConfig attribute)
,
[1]
(folktexts.classifier.base.LLMClassifier property)
cot_prompting (folktexts.benchmark.BenchmarkConfig attribute)
,
[1]
cot_qa (folktexts.task.TaskMetadata attribute)
create_answer_keys_permutations() (folktexts.qa_interface.MultipleChoiceQA class method)
create_question_from_value_map() (folktexts.qa_interface.MultipleChoiceQA class method)
create_task_with_feature_subset() (folktexts.task.TaskMetadata method)
custom_prefix (folktexts.prompting.VaryPrefix attribute)
custom_suffix (folktexts.prompting.VarySuffix attribute)
D
data (folktexts.dataset.Dataset property)
data_value (folktexts.qa_interface.Choice attribute)
,
[1]
Dataset (class in folktexts.dataset)
decode_topk_logprobs_to_risk_estimate() (in module folktexts.llm_utils)
default() (folktexts.prompting.PromptConfig class method)
default_chat_prompt (folktexts.qa_interface.ChainOfThoughtQA attribute)
(folktexts.qa_interface.DirectNumericQA attribute)
(folktexts.qa_interface.QAInterface attribute)
default_config() (folktexts.benchmark.BenchmarkConfig class method)
DEFAULT_INFERENCE_KWARGS (folktexts.classifier.base.LLMClassifier attribute)
DEFAULT_PROMPT_STYLE (in module folktexts.prompting)
default_system_prompt (folktexts.qa_interface.ChainOfThoughtQA attribute)
(folktexts.qa_interface.DirectNumericQA attribute)
(folktexts.qa_interface.QAInterface attribute)
describe_income_to_poverty_ratio_pct() (in module folktexts.acs.acs_columns)
description (folktexts.task.TaskMetadata attribute)
direct_numeric_qa (folktexts.task.TaskMetadata attribute)
DirectNumericQA (class in folktexts.qa_interface)
E
enable_thinking (folktexts.benchmark.BenchmarkConfig attribute)
,
[1]
(folktexts.qa_interface.ChainOfThoughtQA attribute)
,
[1]
encode_row (folktexts.classifier.base.LLMClassifier property)
encode_row_prompt() (in module folktexts.prompting)
encode_row_prompt_chat() (in module folktexts.prompting)
encode_row_prompt_few_shot() (in module folktexts.prompting)
evaluate_binary_predictions() (in module folktexts.evaluation)
evaluate_binary_predictions_fairness() (in module folktexts.evaluation)
evaluate_predictions() (in module folktexts.evaluation)
evaluate_predictions_bootstrap() (in module folktexts.evaluation)
example_order (folktexts.prompting.FewShotConfig attribute)
extract_probability_from_text() (folktexts.qa_interface.ChainOfThoughtQA static method)
F
feature_subset (folktexts.benchmark.BenchmarkConfig attribute)
,
[1]
FeatureItem (class in folktexts.prompting)
features (folktexts.task.TaskMetadata attribute)
few_shot_config (folktexts.benchmark.BenchmarkConfig attribute)
,
[1]
FewShotConfig (class in folktexts.prompting)
filter() (folktexts.dataset.Dataset method)
fit() (folktexts.classifier.base.LLMClassifier method)
folktables_obj (folktexts.acs.acs_tasks.ACSTaskMetadata attribute)
folktexts
module
folktexts.acs
module
folktexts.acs.acs_columns
module
folktexts.acs.acs_columns_simplified
module
folktexts.acs.acs_dataset
module
folktexts.acs.acs_questions
module
folktexts.acs.acs_tasks
module
folktexts.acs.acs_thresholds
module
folktexts.benchmark
module
folktexts.classifier
module
folktexts.classifier.base
module
folktexts.classifier.transformers_classifier
module
folktexts.classifier.vllm_classifier
module
folktexts.classifier.web_api_classifier
module
folktexts.cli
module
folktexts.cli.download_models
module
folktexts.cli.eval_feature_importance
module
folktexts.cli.run_acs_benchmark
module
folktexts.col_to_text
module
folktexts.dataset
module
folktexts.evaluation
module
folktexts.llm_utils
module
folktexts.plotting
module
folktexts.prompting
module
folktexts.qa_interface
module
folktexts.task
module
folktexts.threshold
module
format (folktexts.prompting.PromptConfig attribute)
(folktexts.prompting.VaryFormat attribute)
from_dict() (folktexts.prompting.PromptConfig class method)
G
generate_text_batch() (in module folktexts.llm_utils)
get_answer_from_model_output() (folktexts.qa_interface.ChainOfThoughtQA method)
(folktexts.qa_interface.DirectNumericQA method)
(folktexts.qa_interface.MultipleChoiceQA method)
(folktexts.qa_interface.QAInterface method)
get_answer_from_text() (folktexts.qa_interface.MultipleChoiceQA method)
get_answer_key_from_value() (folktexts.qa_interface.MultipleChoiceQA method)
get_answer_prefix() (folktexts.qa_interface.DirectNumericQA method)
(folktexts.qa_interface.MultipleChoiceQA method)
(folktexts.qa_interface.QAInterface method)
get_data_split() (folktexts.dataset.Dataset method)
get_features_data() (folktexts.dataset.Dataset method)
get_model_folder_path() (in module folktexts.llm_utils)
get_model_size_B() (in module folktexts.llm_utils)
get_numeric_value() (folktexts.qa_interface.Choice method)
get_question_prompt() (folktexts.qa_interface.ChainOfThoughtQA method)
(folktexts.qa_interface.DirectNumericQA method)
(folktexts.qa_interface.MultipleChoiceQA method)
(folktexts.qa_interface.QAInterface method)
get_row_description() (folktexts.task.TaskMetadata method)
get_sensitive_attribute_data() (folktexts.dataset.Dataset method)
get_target() (folktexts.task.TaskMetadata method)
get_target_data() (folktexts.dataset.Dataset method)
get_task() (folktexts.task.TaskMetadata class method)
get_test() (folktexts.dataset.Dataset method)
get_text() (folktexts.col_to_text.ColumnToText method)
get_train() (folktexts.dataset.Dataset method)
get_val() (folktexts.dataset.Dataset method)
get_value_to_text_map() (folktexts.qa_interface.MultipleChoiceQA method)
granularity (folktexts.prompting.VaryValueMap attribute)
I
inference_kwargs (folktexts.classifier.base.LLMClassifier property)
is_bf16_compatible() (in module folktexts.cli.download_models)
(in module folktexts.llm_utils)
K
key_to_choice (folktexts.qa_interface.MultipleChoiceQA property)
L
label (folktexts.prompting.FeatureItem attribute)
(folktexts.prompting.VarySuffix attribute)
llm (folktexts.classifier.vllm_classifier.VLLMClassifier property)
LLMClassifier (class in folktexts.classifier.base)
load_from_disk() (folktexts.benchmark.BenchmarkConfig class method)
load_model_tokenizer() (in module folktexts.llm_utils)
load_vllm_model() (in module folktexts.llm_utils)
M
main() (in module folktexts.cli.download_models)
(in module folktexts.cli.eval_feature_importance)
(in module folktexts.cli.run_acs_benchmark)
make_acs_benchmark() (folktexts.benchmark.Benchmark class method)
make_benchmark() (folktexts.benchmark.Benchmark class method)
make_folktables_task() (folktexts.acs.acs_tasks.ACSTaskMetadata class method)
make_from_task() (folktexts.acs.acs_dataset.ACSDataset class method)
make_task() (folktexts.acs.acs_tasks.ACSTaskMetadata class method)
max_new_tokens (folktexts.qa_interface.ChainOfThoughtQA attribute)
model (folktexts.classifier.transformers_classifier.TransformersLLMClassifier property)
model_name (folktexts.benchmark.Benchmark property)
(folktexts.classifier.base.LLMClassifier property)
module
folktexts
folktexts.acs
folktexts.acs.acs_columns
folktexts.acs.acs_columns_simplified
folktexts.acs.acs_dataset
folktexts.acs.acs_questions
folktexts.acs.acs_tasks
folktexts.acs.acs_thresholds
folktexts.benchmark
folktexts.classifier
folktexts.classifier.base
folktexts.classifier.transformers_classifier
folktexts.classifier.vllm_classifier
folktexts.classifier.web_api_classifier
folktexts.cli
folktexts.cli.download_models
folktexts.cli.eval_feature_importance
folktexts.cli.run_acs_benchmark
folktexts.col_to_text
folktexts.dataset
folktexts.evaluation
folktexts.llm_utils
folktexts.plotting
folktexts.prompting
folktexts.qa_interface
folktexts.task
folktexts.threshold
multiple_choice_qa (folktexts.task.TaskMetadata attribute)
MultipleChoiceQA (class in folktexts.qa_interface)
N
n_shots (folktexts.prompting.FewShotConfig attribute)
name (folktexts.col_to_text.ColumnToText property)
(folktexts.dataset.Dataset property)
(folktexts.task.TaskMetadata attribute)
num_forward_passes (folktexts.qa_interface.ChainOfThoughtQA attribute)
(folktexts.qa_interface.DirectNumericQA attribute)
(folktexts.qa_interface.MultipleChoiceQA attribute)
(folktexts.qa_interface.QAInterface attribute)
numeric_risk_prompting (folktexts.benchmark.BenchmarkConfig attribute)
,
[1]
numeric_value (folktexts.qa_interface.Choice attribute)
,
[1]
O
op (folktexts.threshold.Threshold attribute)
,
[1]
order (folktexts.prompting.PromptConfig attribute)
(folktexts.prompting.VaryOrder attribute)
P
parse_feature_importance() (in module folktexts.cli.eval_feature_importance)
plot_results() (folktexts.benchmark.Benchmark method)
population_filter (folktexts.benchmark.BenchmarkConfig attribute)
,
[1]
predict() (folktexts.classifier.base.LLMClassifier method)
predict_proba() (folktexts.classifier.base.LLMClassifier method)
prefix (folktexts.prompting.PromptConfig attribute)
prompt_config (folktexts.classifier.base.LLMClassifier property)
PROMPT_DEFAULT (in module folktexts.prompting)
prompt_variation (folktexts.benchmark.BenchmarkConfig attribute)
,
[1]
PromptBuilder (class in folktexts.prompting)
PromptConfig (class in folktexts.prompting)
Q
QAInterface (class in folktexts.qa_interface)
query_model_batch() (in module folktexts.llm_utils)
query_model_batch_multiple_passes() (in module folktexts.llm_utils)
question (folktexts.col_to_text.ColumnToText property)
(folktexts.prompting.VarySuffix attribute)
(folktexts.task.TaskMetadata property)
R
raw_value (folktexts.prompting.FeatureItem attribute)
render_evaluation_plots() (in module folktexts.plotting)
render_fairness_plots() (in module folktexts.plotting)
resolve_chat_defaults() (in module folktexts.prompting)
results (folktexts.benchmark.Benchmark property)
results_dir (folktexts.benchmark.Benchmark property)
results_root_dir (folktexts.benchmark.Benchmark property)
reuse_examples (folktexts.prompting.FewShotConfig attribute)
run() (folktexts.benchmark.Benchmark method)
S
sample_n_train_examples() (folktexts.dataset.Dataset method)
save_fig() (in module folktexts.plotting)
save_results() (folktexts.benchmark.Benchmark method)
save_to_disk() (folktexts.benchmark.BenchmarkConfig method)
seed (folktexts.benchmark.BenchmarkConfig attribute)
,
[1]
(folktexts.classifier.base.LLMClassifier property)
(folktexts.dataset.Dataset property)
sensitive_attribute (folktexts.task.TaskMetadata attribute)
sensitive_attribute_value_map() (folktexts.task.TaskMetadata method)
set_fit_request() (folktexts.classifier.base.LLMClassifier method)
(folktexts.classifier.transformers_classifier.TransformersLLMClassifier method)
(folktexts.classifier.vllm_classifier.VLLMClassifier method)
(folktexts.classifier.web_api_classifier.WebAPILLMClassifier method)
set_inference_kwargs() (folktexts.classifier.base.LLMClassifier method)
set_predict_proba_request() (folktexts.classifier.base.LLMClassifier method)
(folktexts.classifier.transformers_classifier.TransformersLLMClassifier method)
(folktexts.classifier.vllm_classifier.VLLMClassifier method)
(folktexts.classifier.web_api_classifier.WebAPILLMClassifier method)
set_predict_request() (folktexts.classifier.base.LLMClassifier method)
(folktexts.classifier.transformers_classifier.TransformersLLMClassifier method)
(folktexts.classifier.vllm_classifier.VLLMClassifier method)
(folktexts.classifier.web_api_classifier.WebAPILLMClassifier method)
set_question() (folktexts.task.TaskMetadata method)
set_score_request() (folktexts.classifier.base.LLMClassifier method)
(folktexts.classifier.transformers_classifier.TransformersLLMClassifier method)
(folktexts.classifier.vllm_classifier.VLLMClassifier method)
(folktexts.classifier.web_api_classifier.WebAPILLMClassifier method)
setup_arg_parser() (in module folktexts.cli.download_models)
(in module folktexts.cli.eval_feature_importance)
(in module folktexts.cli.run_acs_benchmark)
short_description (folktexts.col_to_text.ColumnToText property)
show_label (folktexts.prompting.VarySuffix attribute)
show_question (folktexts.prompting.VarySuffix attribute)
show_question_in_examples (folktexts.prompting.FewShotConfig attribute)
subsample() (folktexts.dataset.Dataset method)
subsampling (folktexts.dataset.Dataset property)
suffix (folktexts.prompting.PromptConfig attribute)
system_prompt (folktexts.benchmark.BenchmarkConfig attribute)
,
[1]
(folktexts.prompting.PromptConfig attribute)
(folktexts.prompting.VarySystemPrompt attribute)
T
target (folktexts.task.TaskMetadata attribute)
target_threshold (folktexts.task.TaskMetadata attribute)
task (folktexts.acs.acs_dataset.ACSDataset property)
(folktexts.benchmark.Benchmark property)
(folktexts.classifier.base.LLMClassifier property)
(folktexts.dataset.Dataset property)
task_description (folktexts.prompting.VaryPrefix attribute)
TaskMetadata (class in folktexts.task)
test_size (folktexts.dataset.Dataset property)
text (folktexts.qa_interface.Choice attribute)
,
[1]
(folktexts.qa_interface.QAInterface attribute)
text_value (folktexts.prompting.FeatureItem attribute)
Threshold (class in folktexts.threshold)
threshold (folktexts.classifier.base.LLMClassifier property)
tokenizer (folktexts.classifier.transformers_classifier.TransformersLLMClassifier property)
(folktexts.classifier.vllm_classifier.VLLMClassifier property)
tokenizer_supports_system_prompt() (in module folktexts.prompting)
track_cost_callback() (folktexts.classifier.web_api_classifier.WebAPILLMClassifier method)
train_size (folktexts.dataset.Dataset property)
transform_age() (in module folktexts.acs.acs_columns_simplified)
transform_cow() (in module folktexts.acs.acs_columns_simplified)
transform_occp() (in module folktexts.acs.acs_columns_simplified)
transform_pobp() (in module folktexts.acs.acs_columns_simplified)
transform_pobp_unsd() (in module folktexts.acs.acs_columns_simplified)
transform_rac1p() (in module folktexts.acs.acs_columns_simplified)
transform_rac1p_binary() (in module folktexts.acs.acs_columns_simplified)
transform_relp() (in module folktexts.acs.acs_columns_simplified)
transform_schooling() (in module folktexts.acs.acs_columns_simplified)
transform_wkhp() (in module folktexts.acs.acs_columns_simplified)
TransformersLLMClassifier (class in folktexts.classifier.transformers_classifier)
U
update() (folktexts.benchmark.BenchmarkConfig method)
use_chat_template (folktexts.benchmark.BenchmarkConfig attribute)
,
[1]
use_cot_qa (folktexts.task.TaskMetadata property)
use_numeric_qa (folktexts.task.TaskMetadata property)
V
val_size (folktexts.dataset.Dataset property)
valid_ops (folktexts.threshold.Threshold attribute)
value (folktexts.threshold.Threshold attribute)
,
[1]
value_map (folktexts.col_to_text.ColumnToText property)
(folktexts.prompting.PromptConfig attribute)
VaryConnector (class in folktexts.prompting)
VaryFeatureOrder (in module folktexts.prompting)
VaryFormat (class in folktexts.prompting)
VaryOrder (class in folktexts.prompting)
VaryPrefix (class in folktexts.prompting)
VarySuffix (class in folktexts.prompting)
VarySystemPrompt (class in folktexts.prompting)
VaryValueMap (class in folktexts.prompting)
VLLMClassifier (class in folktexts.classifier.vllm_classifier)
W
WebAPILLMClassifier (class in folktexts.classifier.web_api_classifier)
with_answer_prefill (folktexts.prompting.VarySuffix attribute)
with_low_granularity() (folktexts.prompting.VaryValueMap class method)