UserSimCRS
Contents:
Installation
Usage
Agenda-based simulator
LLM-based simulators
User modeling
Experiment Configuration
Evaluation
API Reference
UserSimCRS
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
A
action_slots (tus_feature_handler.TUSFeatureHandler attribute)
add_item() (usersimcrs.items.item_collection.ItemCollection method)
add_user_item_rating() (usersimcrs.items.ratings.Ratings method)
Agenda (class in usersimcrs.simulator.agenda_based.agenda)
AgendaBasedSimulator (class in usersimcrs.simulator.agenda_based.agenda_based_simulator)
agent_dialogue_acts (usersimcrs.dialogue_management.dialogue_state.DialogueState attribute)
,
[1]
args (in module usersimcrs.run_simulation)
B
belief_state (usersimcrs.dialogue_management.dialogue_state.DialogueState attribute)
,
[1]
build_input_vector() (core.feature_handler.FeatureHandler method)
(tus_feature_handler.TUSFeatureHandler method)
build_new_prompt() (usersimcrs.simulator.llm.prompt.prompt.Prompt method)
(usersimcrs.simulator.llm.prompt.stop_prompt.StopPrompt method)
(usersimcrs.simulator.llm.prompt.utterance_generation_prompt.UtteranceGenerationPrompt method)
C
characteristics (usersimcrs.user_modeling.persona.Persona attribute)
clean_agenda() (usersimcrs.simulator.agenda_based.agenda.Agenda method)
client (usersimcrs.llm_interfaces.ollama_interface.OllamaLLMInterface attribute)
(usersimcrs.llm_interfaces.openai_interface.OpenAILLMInterface attribute)
close() (usersimcrs.items.item_collection.ItemCollection method)
connect() (usersimcrs.items.item_collection.ItemCollection method)
(usersimcrs.simulation_platform.SimulationPlatform method)
constraints (usersimcrs.core.information_need.InformationNeed attribute)
context_depth (tus_feature_handler.TUSFeatureHandler attribute)
ContextModel (class in usersimcrs.user_modeling.context_model)
core
module
core.feature_handler
module
core.transformer
module
create_split() (usersimcrs.items.ratings.Ratings method)
D
d_model (core.transformer.TransformerEncoderModel attribute)
DEFAULT_CONFIG_PATH (in module usersimcrs.run_simulation)
default_response (usersimcrs.llm_interfaces.llm_interface.LLMInterface attribute)
DEFAULT_STOP_DEFINITION (in module usersimcrs.simulator.llm.prompt.stop_prompt)
DEFAULT_TASK_DEFINITION (in module usersimcrs.simulator.llm.prompt.utterance_generation_prompt)
dialogue_state_tracker (usersimcrs.simulator.agenda_based.interaction_model.InteractionModel attribute)
DialogueState (class in usersimcrs.dialogue_management.dialogue_state)
DialogueStateTracker (class in usersimcrs.dialogue_management.dialogue_state_tracker)
display_agent_utterance() (usersimcrs.simulation_platform.SimulationPlatform method)
display_user_utterance() (usersimcrs.simulation_platform.SimulationPlatform method)
dropout (core.transformer.PositionalEncoding attribute)
E
embedding (core.transformer.TransformerEncoderModel attribute)
encoder (core.transformer.TransformerEncoderModel attribute)
exists() (usersimcrs.items.item_collection.ItemCollection method)
extract_dialogue_acts() (usersimcrs.nlu.llm.llm_dialogue_act_extractor.LLMDialogueActsExtractor method)
F
FeatureHandler (class in core.feature_handler)
FeatureMask (in module core.feature_handler)
FeatureVector (in module core.feature_handler)
filter_invalid_dialogue_acts() (usersimcrs.nlu.llm.llm_dialogue_act_extractor.LLMDialogueActsExtractor method)
forward() (core.transformer.PositionalEncoding method)
(core.transformer.TransformerEncoderModel method)
from_dict() (usersimcrs.core.information_need.InformationNeed class method)
G
generate_random_information_need() (in module usersimcrs.core.information_need)
generate_response() (usersimcrs.simulator.agenda_based.agenda_based_simulator.AgendaBasedSimulator method)
generate_utterance() (usersimcrs.llm_interfaces.llm_interface.LLMInterface method)
(usersimcrs.llm_interfaces.ollama_interface.OllamaLLMInterface method)
(usersimcrs.llm_interfaces.openai_interface.OpenAILLMInterface method)
generate_utterance_text() (usersimcrs.nlg.llm.nlg_generative_llm.LLMGenerativeNLG method)
generation_prompt (usersimcrs.simulator.llm.llm_dual_prompt_user_simulator.LLMDualPromptUserSimulator attribute)
get_agent_action_feature() (tus_feature_handler.TUSFeatureHandler method)
get_agent_information() (in module usersimcrs.utils.simulation_utils)
get_basic_information_feature() (tus_feature_handler.TUSFeatureHandler method)
get_constraint_value() (usersimcrs.core.information_need.InformationNeed method)
get_current_state() (usersimcrs.dialogue_management.dialogue_state_tracker.DialogueStateTracker method)
get_informable_slots() (usersimcrs.core.simulation_domain.SimulationDomain method)
get_item() (usersimcrs.items.item_collection.ItemCollection method)
get_item_preference() (usersimcrs.user_modeling.pkg_preference_model.PKGPreferenceModel method)
(usersimcrs.user_modeling.preference_model.PreferenceModel method)
(usersimcrs.user_modeling.simple_preference_model.SimplePreferenceModel method)
get_item_ratings() (usersimcrs.items.ratings.Ratings method)
get_items_by_properties() (usersimcrs.items.item_collection.ItemCollection method)
get_label_vector() (tus_feature_handler.TUSFeatureHandler method)
get_llm_api_response() (usersimcrs.llm_interfaces.llm_interface.LLMInterface method)
(usersimcrs.llm_interfaces.ollama_interface.OllamaLLMInterface method)
(usersimcrs.llm_interfaces.openai_interface.OpenAILLMInterface method)
get_new_information_need() (usersimcrs.simulator.user_simulator.UserSimulator method)
get_next_dialogue_acts() (usersimcrs.simulator.agenda_based.agenda.Agenda method)
(usersimcrs.simulator.agenda_based.interaction_model.InteractionModel method)
get_NLG() (in module usersimcrs.utils.simulation_utils)
get_NLU() (in module usersimcrs.utils.simulation_utils)
get_possible_property_values() (usersimcrs.items.item_collection.ItemCollection method)
get_property() (usersimcrs.items.item.Item method)
get_random_item() (usersimcrs.items.item_collection.ItemCollection method)
get_random_user_id() (usersimcrs.items.ratings.Ratings method)
get_requestable_slots() (usersimcrs.core.information_need.InformationNeed method)
(usersimcrs.core.simulation_domain.SimulationDomain method)
get_simulator_information() (in module usersimcrs.utils.simulation_utils)
get_slot_feature_vector() (tus_feature_handler.TUSFeatureHandler method)
get_slot_index_feature() (tus_feature_handler.TUSFeatureHandler method)
get_slot_preference() (usersimcrs.user_modeling.preference_model.PreferenceModel method)
get_slot_value_preference() (usersimcrs.user_modeling.pkg_preference_model.PKGPreferenceModel method)
(usersimcrs.user_modeling.preference_model.PreferenceModel method)
(usersimcrs.user_modeling.simple_preference_model.SimplePreferenceModel method)
get_turn_feature_vectors() (tus_feature_handler.TUSFeatureHandler method)
get_user_item_rating() (usersimcrs.items.ratings.Ratings method)
get_user_ratings() (usersimcrs.items.ratings.Ratings method)
I
id (usersimcrs.items.item.Item property)
inform_intent (usersimcrs.simulator.agenda_based.agenda.Agenda attribute)
information_need (usersimcrs.simulator.llm.prompt.prompt.Prompt attribute)
InformationNeed (class in usersimcrs.core.information_need)
init_weights() (core.transformer.TransformerEncoderModel method)
initialize_agenda() (usersimcrs.simulator.agenda_based.interaction_model.InteractionModel method)
initialize_transition_matrices() (usersimcrs.simulator.agenda_based.interaction_model.InteractionModel method)
intent_labels (usersimcrs.nlu.llm.llm_dialogue_act_extractor.LLMDialogueActsExtractor attribute)
InteractionModel (class in usersimcrs.simulator.agenda_based.interaction_model)
is_agent_intent_elicit() (usersimcrs.simulator.agenda_based.interaction_model.InteractionModel method)
is_agent_intent_inquire() (usersimcrs.simulator.agenda_based.interaction_model.InteractionModel method)
is_agent_intent_set_retrieval() (usersimcrs.simulator.agenda_based.interaction_model.InteractionModel method)
is_item_consumed() (usersimcrs.user_modeling.preference_model.PreferenceModel method)
Item (class in usersimcrs.items.item)
item_type (usersimcrs.simulator.llm.prompt.prompt.Prompt attribute)
ItemCollection (class in usersimcrs.items.item_collection)
K
KEY_ITEM_ID (in module usersimcrs.user_modeling.preference_model)
L
linear (core.transformer.TransformerEncoderModel attribute)
llm_interface (usersimcrs.nlg.llm.nlg_generative_llm.LLMGenerativeNLG attribute)
(usersimcrs.nlu.llm.llm_dialogue_act_extractor.LLMDialogueActsExtractor attribute)
(usersimcrs.simulator.llm.llm_dual_prompt_user_simulator.LLMDualPromptUserSimulator attribute)
(usersimcrs.simulator.llm.llm_single_prompt_user_simulator.LLMSinglePromptUserSimulator attribute)
LLMDialogueActsExtractor (class in usersimcrs.nlu.llm.llm_dialogue_act_extractor)
LLMDualPromptUserSimulator (class in usersimcrs.simulator.llm.llm_dual_prompt_user_simulator)
LLMGenerativeNLG (class in usersimcrs.nlg.llm.nlg_generative_llm)
LLMInterface (class in usersimcrs.llm_interfaces.llm_interface)
LLMSinglePromptUserSimulator (class in usersimcrs.simulator.llm.llm_single_prompt_user_simulator)
load() (usersimcrs.nlu.llm.llm_dialogue_act_extractor.LLMDialogueActsExtractor class method)
load_config() (in module usersimcrs.run_simulation)
load_handler() (tus_feature_handler.TUSFeatureHandler class method)
load_items_csv() (usersimcrs.items.item_collection.ItemCollection method)
load_preference_model() (usersimcrs.user_modeling.preference_model.PreferenceModel class method)
load_ratings_csv() (usersimcrs.items.ratings.Ratings method)
logger (in module usersimcrs.items.ratings)
(in module usersimcrs.run_simulation)
(in module usersimcrs.simulator.agenda_based.interaction_model)
M
main() (in module usersimcrs.run_simulation)
map_path_to_class() (in module usersimcrs.utils.simulation_utils)
MappingConfig (in module usersimcrs.items.item_collection)
max_turn_feature_length (tus_feature_handler.TUSFeatureHandler attribute)
model (usersimcrs.llm_interfaces.ollama_interface.OllamaLLMInterface attribute)
(usersimcrs.llm_interfaces.openai_interface.OpenAILLMInterface attribute)
module
core
core.feature_handler
core.transformer
tus_feature_handler
usersimcrs
usersimcrs.core
usersimcrs.core.information_need
usersimcrs.core.simulation_domain
usersimcrs.dialogue_management
usersimcrs.dialogue_management.dialogue_state
usersimcrs.dialogue_management.dialogue_state_tracker
usersimcrs.items
usersimcrs.items.item
usersimcrs.items.item_collection
usersimcrs.items.ratings
usersimcrs.llm_interfaces
usersimcrs.llm_interfaces.llm_interface
usersimcrs.llm_interfaces.ollama_interface
usersimcrs.llm_interfaces.openai_interface
usersimcrs.nlg
usersimcrs.nlg.llm
usersimcrs.nlg.llm.nlg_generative_llm
usersimcrs.nlu
usersimcrs.nlu.llm
usersimcrs.nlu.llm.llm_dialogue_act_extractor
usersimcrs.run_simulation
usersimcrs.simulation_platform
usersimcrs.simulator
usersimcrs.simulator.agenda_based
usersimcrs.simulator.agenda_based.agenda
usersimcrs.simulator.agenda_based.agenda_based_simulator
usersimcrs.simulator.agenda_based.interaction_model
usersimcrs.simulator.llm
usersimcrs.simulator.llm.llm_dual_prompt_user_simulator
usersimcrs.simulator.llm.llm_single_prompt_user_simulator
usersimcrs.simulator.llm.prompt
usersimcrs.simulator.llm.prompt.prompt
usersimcrs.simulator.llm.prompt.stop_prompt
usersimcrs.simulator.llm.prompt.utterance_generation_prompt
usersimcrs.simulator.user_simulator
usersimcrs.user_modeling
usersimcrs.user_modeling.context_model
usersimcrs.user_modeling.persona
usersimcrs.user_modeling.pkg_preference_model
usersimcrs.user_modeling.preference_model
usersimcrs.user_modeling.simple_preference_model
usersimcrs.utils
usersimcrs.utils.simulation_utils
N
num_items() (usersimcrs.items.item_collection.ItemCollection method)
O
OllamaLLMInterface (class in usersimcrs.llm_interfaces.ollama_interface)
OpenAILLMInterface (class in usersimcrs.llm_interfaces.openai_interface)
OUTPUT_DIR (in module usersimcrs.run_simulation)
P
parse_args() (in module usersimcrs.run_simulation)
Persona (class in usersimcrs.user_modeling.persona)
persona (usersimcrs.simulator.llm.prompt.prompt.Prompt attribute)
PKGPreferenceModel (class in usersimcrs.user_modeling.pkg_preference_model)
pos_encoder (core.transformer.TransformerEncoderModel attribute)
PositionalEncoding (class in core.transformer)
PREFERENCE_THRESHOLD (usersimcrs.user_modeling.preference_model.PreferenceModel attribute)
PreferenceModel (class in usersimcrs.user_modeling.preference_model)
Prompt (class in usersimcrs.simulator.llm.prompt.prompt)
prompt (usersimcrs.nlg.llm.nlg_generative_llm.LLMGenerativeNLG attribute)
(usersimcrs.simulator.llm.llm_single_prompt_user_simulator.LLMSinglePromptUserSimulator attribute)
prompt_definition (usersimcrs.simulator.llm.prompt.prompt.Prompt attribute)
prompt_prefix (usersimcrs.nlg.llm.nlg_generative_llm.LLMGenerativeNLG attribute)
prompt_text (usersimcrs.simulator.llm.prompt.prompt.Prompt property)
(usersimcrs.simulator.llm.prompt.stop_prompt.StopPrompt property)
properties (usersimcrs.items.item.Item property)
push_dialogue_act() (usersimcrs.simulator.agenda_based.agenda.Agenda method)
push_dialogue_acts() (usersimcrs.simulator.agenda_based.agenda.Agenda method)
R
Ratings (class in usersimcrs.items.ratings)
receive_utterance() (usersimcrs.simulator.user_simulator.UserSimulator method)
request_intent (usersimcrs.simulator.agenda_based.agenda.Agenda attribute)
requested_slots (usersimcrs.core.information_need.InformationNeed attribute)
REQUIRED_INTENTS (usersimcrs.simulator.agenda_based.interaction_model.InteractionModel attribute)
reset() (tus_feature_handler.TUSFeatureHandler method)
reset_state() (usersimcrs.dialogue_management.dialogue_state_tracker.DialogueStateTracker method)
reset_user_feature_history() (tus_feature_handler.TUSFeatureHandler method)
S
sample_context() (usersimcrs.user_modeling.context_model.ContextModel method)
save() (usersimcrs.nlu.llm.llm_dialogue_act_extractor.LLMDialogueActsExtractor method)
save_handler() (tus_feature_handler.TUSFeatureHandler method)
save_preference_model() (usersimcrs.user_modeling.preference_model.PreferenceModel method)
set_property() (usersimcrs.items.item.Item method)
SimplePreferenceModel (class in usersimcrs.user_modeling.simple_preference_model)
SimulationDomain (class in usersimcrs.core.simulation_domain)
SimulationPlatform (class in usersimcrs.simulation_platform)
slot_labels (usersimcrs.nlu.llm.llm_dialogue_act_extractor.LLMDialogueActsExtractor attribute)
softmax (core.transformer.TransformerEncoderModel attribute)
SQL_DELIMITER (in module usersimcrs.items.item_collection)
stack (usersimcrs.simulator.agenda_based.agenda.Agenda property)
start() (usersimcrs.simulation_platform.SimulationPlatform method)
stop_prompt (usersimcrs.simulator.llm.llm_dual_prompt_user_simulator.LLMDualPromptUserSimulator attribute)
StopPrompt (class in usersimcrs.simulator.llm.prompt.stop_prompt)
T
target_items (usersimcrs.core.information_need.InformationNeed attribute)
to_dict() (usersimcrs.core.information_need.InformationNeed method)
train_cosine_classifier() (in module usersimcrs.utils.simulation_utils)
TransformerEncoderModel (class in core.transformer)
tus_feature_handler
module
TUSFeatureHandler (class in tus_feature_handler)
U
update_action_slots() (tus_feature_handler.TUSFeatureHandler method)
update_agenda() (usersimcrs.simulator.agenda_based.interaction_model.InteractionModel method)
update_belief_state() (usersimcrs.dialogue_management.dialogue_state_tracker.DialogueStateTracker method)
update_prompt_context() (usersimcrs.simulator.llm.prompt.prompt.Prompt method)
(usersimcrs.simulator.llm.prompt.utterance_generation_prompt.UtteranceGenerationPrompt method)
update_state() (usersimcrs.dialogue_management.dialogue_state_tracker.DialogueStateTracker method)
use_chat_api (usersimcrs.llm_interfaces.openai_interface.OpenAILLMInterface attribute)
user_dialogue_acts (usersimcrs.dialogue_management.dialogue_state.DialogueState attribute)
,
[1]
user_feature_history (tus_feature_handler.TUSFeatureHandler attribute)
user_item_sampler() (in module usersimcrs.items.ratings)
usersimcrs
module
usersimcrs.core
module
usersimcrs.core.information_need
module
usersimcrs.core.simulation_domain
module
usersimcrs.dialogue_management
module
usersimcrs.dialogue_management.dialogue_state
module
usersimcrs.dialogue_management.dialogue_state_tracker
module
usersimcrs.items
module
usersimcrs.items.item
module
usersimcrs.items.item_collection
module
usersimcrs.items.ratings
module
usersimcrs.llm_interfaces
module
usersimcrs.llm_interfaces.llm_interface
module
usersimcrs.llm_interfaces.ollama_interface
module
usersimcrs.llm_interfaces.openai_interface
module
usersimcrs.nlg
module
usersimcrs.nlg.llm
module
usersimcrs.nlg.llm.nlg_generative_llm
module
usersimcrs.nlu
module
usersimcrs.nlu.llm
module
usersimcrs.nlu.llm.llm_dialogue_act_extractor
module
usersimcrs.run_simulation
module
usersimcrs.simulation_platform
module
usersimcrs.simulator
module
usersimcrs.simulator.agenda_based
module
usersimcrs.simulator.agenda_based.agenda
module
usersimcrs.simulator.agenda_based.agenda_based_simulator
module
usersimcrs.simulator.agenda_based.interaction_model
module
usersimcrs.simulator.llm
module
usersimcrs.simulator.llm.llm_dual_prompt_user_simulator
module
usersimcrs.simulator.llm.llm_single_prompt_user_simulator
module
usersimcrs.simulator.llm.prompt
module
usersimcrs.simulator.llm.prompt.prompt
module
usersimcrs.simulator.llm.prompt.stop_prompt
module
usersimcrs.simulator.llm.prompt.utterance_generation_prompt
module
usersimcrs.simulator.user_simulator
module
usersimcrs.user_modeling
module
usersimcrs.user_modeling.context_model
module
usersimcrs.user_modeling.persona
module
usersimcrs.user_modeling.pkg_preference_model
module
usersimcrs.user_modeling.preference_model
module
usersimcrs.user_modeling.simple_preference_model
module
usersimcrs.utils
module
usersimcrs.utils.simulation_utils
module
UserSimulator (class in usersimcrs.simulator.user_simulator)
utterance_count (usersimcrs.dialogue_management.dialogue_state.DialogueState attribute)
,
[1]
UtteranceGenerationPrompt (class in usersimcrs.simulator.llm.prompt.utterance_generation_prompt)