GABM
Project Documents
License
Contributor Covenant Code of Conduct
Contributors
User Guide
Developer Guide
Developer Quickstart
Requirements (Developer)
Requirements
Requirements for Local LLMs
API Key Setup
Hugging Face Model Usage Guide
Roadmap
Change Log
Development History
JOSS Submission Planning and Draft
Security and Code of Conduct Reporting
Contact
API Reference
gabm.abm package
gabm.abm.agent module
gabm.abm.attribute module
gabm.abm.environment module
gabm.abm.group module
gabm.abm.survey module
gabm.abm.attributes package
gabm.abm.democracy package
gabm.core package
gabm.core.environment module
gabm.core.id module
gabm.io package
gabm.io.read_data module
gabm.io.llm package
gabm.io.llm.apertus module
gabm.io.llm.deepseek module
gabm.io.llm.genai module
gabm.io.llm.llm_service module
gabm.io.llm.openai module
gabm.io.llm.publicai module
gabm.io.llm.utils module
gabm.utils package
gabm.utils.logging module
GABM
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
|
Y
|
Z
A
add() (gabm.abm.attribute.GABMAttributeMap method)
add_answer() (gabm.abm.survey.Question method)
add_member() (gabm.abm.group.Group method)
add_opinion() (gabm.abm.agent.Person method)
add_question() (gabm.abm.survey.Survey method)
AFRICAN (gabm.abm.attributes.ethnicity.EthnicityID attribute)
Agent (class in gabm.abm.agent)
AgentID (class in gabm.abm.agent)
AMERICAN (gabm.abm.attributes.ethnicity.EthnicityID attribute)
Answer (class in gabm.abm.survey)
AnswerID (class in gabm.abm.survey)
ANTIPODIAN (gabm.abm.attributes.ethnicity.EthnicityID attribute)
API_KEY_ENV_VAR (gabm.io.llm.llm_service.LLMService property)
ASIAN (gabm.abm.attributes.ethnicity.EthnicityID attribute)
B
BAD (gabm.abm.attributes.health.HealthID attribute)
C
cache_and_log() (in module gabm.io.llm.utils)
call_and_cache_response() (in module gabm.io.llm.utils)
Candidate (class in gabm.abm.democracy.candidate)
CENTRAL (gabm.abm.attributes.region.RegionID attribute)
CENTRE (gabm.abm.attributes.politics.PoliticsID attribute)
Citizen (class in gabm.abm.agent)
CitizenID (class in gabm.abm.agent)
COLLEGE (gabm.abm.attributes.education.EducationID attribute)
communicate() (gabm.abm.agent.Person method)
communicate_with_llm() (gabm.abm.agent.Person method)
conduct() (gabm.abm.survey.SurveyConversation method)
D
DeepSeekService (class in gabm.io.llm.deepseek)
DOCTORATE (gabm.abm.attributes.education.EducationID attribute)
download_apertus_model() (in module gabm.io.llm.apertus)
E
EAST (gabm.abm.attributes.region.RegionID attribute)
ECONOMICALLY_INACTIVE (gabm.abm.attributes.employment.EmploymentID attribute)
Education (class in gabm.abm.attributes.education)
EducationID (class in gabm.abm.attributes.education)
EducationMap (class in gabm.abm.attributes.education)
Election (class in gabm.abm.democracy.election)
ElectionID (class in gabm.abm.democracy.election)
EMPLOYED_FULL_TIME (gabm.abm.attributes.employment.EmploymentID attribute)
EMPLOYED_PART_TIME (gabm.abm.attributes.employment.EmploymentID attribute)
Employment (class in gabm.abm.attributes.employment)
EmploymentID (class in gabm.abm.attributes.employment)
EmploymentMap (class in gabm.abm.attributes.employment)
Environment (class in gabm.abm.environment)
Ethnicity (class in gabm.abm.attributes.ethnicity)
EthnicityID (class in gabm.abm.attributes.ethnicity)
EthnicityMap (class in gabm.abm.attributes.ethnicity)
EUROPEAN (gabm.abm.attributes.ethnicity.EthnicityID attribute)
extract_text_from_response() (gabm.io.llm.genai.GenAIService method)
(in module gabm.io.llm.utils)
F
FAIR (gabm.abm.attributes.health.HealthID attribute)
Family (class in gabm.abm.attributes.family)
FamilyID (class in gabm.abm.attributes.family)
FamilyMap (class in gabm.abm.attributes.family)
FAR_LEFT (gabm.abm.attributes.politics.PoliticsID attribute)
FAR_RIGHT (gabm.abm.attributes.politics.PoliticsID attribute)
FEMALE (gabm.abm.attributes.gender.GenderID attribute)
G
gabm
module
,
[1]
gabm.abm
module
gabm.abm.agent
module
gabm.abm.attribute
module
gabm.abm.attributes
module
gabm.abm.attributes.education
module
gabm.abm.attributes.employment
module
gabm.abm.attributes.ethnicity
module
gabm.abm.attributes.family
module
gabm.abm.attributes.gender
module
gabm.abm.attributes.health
module
gabm.abm.attributes.income
module
gabm.abm.attributes.opinion
module
gabm.abm.attributes.politics
module
gabm.abm.attributes.region
module
gabm.abm.attributes.wealth
module
gabm.abm.democracy
module
gabm.abm.democracy.candidate
module
gabm.abm.democracy.election
module
gabm.abm.democracy.elections
module
gabm.abm.democracy.elections.uk
module
gabm.abm.democracy.elections.uk.general_election
module
gabm.abm.democracy.elections.uk.referendum
module
gabm.abm.democracy.political_party
module
gabm.abm.environment
module
gabm.abm.group
module
gabm.abm.survey
module
gabm.core
module
gabm.core.environment
module
gabm.core.id
module
gabm.io
module
gabm.io.llm
module
gabm.io.llm.apertus
module
gabm.io.llm.deepseek
module
gabm.io.llm.genai
module
gabm.io.llm.llm_service
module
gabm.io.llm.openai
module
gabm.io.llm.publicai
module
gabm.io.llm.utils
module
gabm.io.read_data
module
gabm.utils
module
gabm.utils.logging
module
GABMAttribute (class in gabm.abm.attribute)
GABMAttributeID (class in gabm.abm.attribute)
GABMAttributeMap (class in gabm.abm.attribute)
GABMID (class in gabm.core.id)
GenAIService (class in gabm.io.llm.genai)
Gender (class in gabm.abm.attributes.gender)
GenderID (class in gabm.abm.attributes.gender)
GenderMap (class in gabm.abm.attributes.gender)
GeneralElection (class in gabm.abm.democracy.election)
get() (gabm.abm.attribute.GABMAttributeMap method)
get_age() (gabm.abm.agent.Person method)
get_AverageOpinion() (gabm.abm.group.OpinionatedGroup method)
get_description() (gabm.abm.attributes.opinion.Opinion method)
get_gender() (gabm.abm.agent.Person method)
get_llm_cache_paths() (in module gabm.io.llm.utils)
get_opinion() (gabm.abm.agent.Person method)
get_opinion_profile() (gabm.abm.agent.Person method)
get_prompt() (gabm.abm.survey.Question method)
get_question() (gabm.abm.survey.Survey method)
get_self_description() (gabm.abm.agent.Person method)
get_value() (gabm.abm.attributes.opinion.Opinion method)
GOOD (gabm.abm.attributes.health.HealthID attribute)
Group (class in gabm.abm.group)
GroupID (class in gabm.abm.group)
H
Health (class in gabm.abm.attributes.health)
HealthID (class in gabm.abm.attributes.health)
HealthMap (class in gabm.abm.attributes.health)
I
Income (class in gabm.abm.attributes.income)
IncomeID (class in gabm.abm.attributes.income)
IncomeMap (class in gabm.abm.attributes.income)
items() (gabm.abm.attribute.GABMAttributeMap method)
J
join_group() (gabm.abm.agent.Agent method)
K
keys() (gabm.abm.attribute.GABMAttributeMap method)
L
leave_group() (gabm.abm.agent.Agent method)
LEFT (gabm.abm.attributes.politics.PoliticsID attribute)
list_available_models() (gabm.io.llm.deepseek.DeepSeekService method)
(gabm.io.llm.genai.GenAIService method)
(gabm.io.llm.llm_service.LLMService method)
(gabm.io.llm.openai.OpenAIService method)
(gabm.io.llm.publicai.PublicAIService method)
list_members() (gabm.abm.group.Group method)
list_models_to_txt() (in module gabm.io.llm.utils)
LLMService (class in gabm.io.llm.llm_service)
load_llm_cache() (in module gabm.io.llm.utils)
load_models_from_json() (in module gabm.io.llm.utils)
local_apertus_infer() (in module gabm.io.llm.apertus)
M
MALE (gabm.abm.attributes.gender.GenderID attribute)
MARRIED (gabm.abm.attributes.family.FamilyID attribute)
MEDIAN_TO_Q3 (gabm.abm.attributes.income.IncomeID attribute)
(gabm.abm.attributes.wealth.WealthID attribute)
module
gabm
,
[1]
gabm.abm
gabm.abm.agent
gabm.abm.attribute
gabm.abm.attributes
gabm.abm.attributes.education
gabm.abm.attributes.employment
gabm.abm.attributes.ethnicity
gabm.abm.attributes.family
gabm.abm.attributes.gender
gabm.abm.attributes.health
gabm.abm.attributes.income
gabm.abm.attributes.opinion
gabm.abm.attributes.politics
gabm.abm.attributes.region
gabm.abm.attributes.wealth
gabm.abm.democracy
gabm.abm.democracy.candidate
gabm.abm.democracy.election
gabm.abm.democracy.elections
gabm.abm.democracy.elections.uk
gabm.abm.democracy.elections.uk.general_election
gabm.abm.democracy.elections.uk.referendum
gabm.abm.democracy.political_party
gabm.abm.environment
gabm.abm.group
gabm.abm.survey
gabm.core
gabm.core.environment
gabm.core.id
gabm.io
gabm.io.llm
gabm.io.llm.apertus
gabm.io.llm.deepseek
gabm.io.llm.genai
gabm.io.llm.llm_service
gabm.io.llm.openai
gabm.io.llm.publicai
gabm.io.llm.utils
gabm.io.read_data
gabm.utils
gabm.utils.logging
N
Nation (class in gabm.abm.environment)
NEGATIVE (gabm.abm.attributes.opinion.OpinionTopicID attribute)
(gabm.abm.attributes.wealth.WealthID attribute)
NEUTRAL (gabm.abm.attributes.opinion.OpinionTopicID attribute)
NON_BINARY (gabm.abm.attributes.gender.GenderID attribute)
NORTH (gabm.abm.attributes.region.RegionID attribute)
NORTH_EAST (gabm.abm.attributes.region.RegionID attribute)
NORTH_WEST (gabm.abm.attributes.region.RegionID attribute)
NOT_MARRIED (gabm.abm.attributes.family.FamilyID attribute)
O
OpenAIService (class in gabm.io.llm.openai)
Opinion (class in gabm.abm.attributes.opinion)
OpinionatedGroup (class in gabm.abm.group)
OpinionTopic (class in gabm.abm.attributes.opinion)
OpinionTopicID (class in gabm.abm.attributes.opinion)
OpinionValue (class in gabm.abm.attributes.opinion)
OpinionValueMap (class in gabm.abm.attributes.opinion)
OTHER (gabm.abm.attributes.ethnicity.EthnicityID attribute)
P
Person (class in gabm.abm.agent)
PersonID (class in gabm.abm.agent)
PoliticalParty (class in gabm.abm.democracy.political_party)
PoliticalPartyID (class in gabm.abm.democracy.political_party)
Politics (class in gabm.abm.attributes.politics)
PoliticsID (class in gabm.abm.attributes.politics)
PoliticsMap (class in gabm.abm.attributes.politics)
POSITIVE (gabm.abm.attributes.opinion.OpinionTopicID attribute)
pre_send_check_and_cache() (in module gabm.io.llm.utils)
PRIMARY (gabm.abm.attributes.education.EducationID attribute)
PublicAIService (class in gabm.io.llm.publicai)
Q
Q1_TO_MEDIAN (gabm.abm.attributes.income.IncomeID attribute)
(gabm.abm.attributes.wealth.WealthID attribute)
Q3_TO_TOP_10 (gabm.abm.attributes.income.IncomeID attribute)
(gabm.abm.attributes.wealth.WealthID attribute)
Question (class in gabm.abm.survey)
QuestionID (class in gabm.abm.survey)
R
read_api_keys() (in module gabm.io.read_data)
Referendum (class in gabm.abm.democracy.election)
Region (class in gabm.abm.attributes.region)
RegionID (class in gabm.abm.attributes.region)
RegionMap (class in gabm.abm.attributes.region)
remove_member() (gabm.abm.group.Group method)
RETIRED (gabm.abm.attributes.employment.EmploymentID attribute)
RIGHT (gabm.abm.attributes.politics.PoliticsID attribute)
S
safe_api_call() (in module gabm.io.llm.utils)
SECONDARY (gabm.abm.attributes.education.EducationID attribute)
send() (gabm.io.llm.deepseek.DeepSeekService method)
(gabm.io.llm.genai.GenAIService method)
(gabm.io.llm.llm_service.LLMService method)
(gabm.io.llm.openai.OpenAIService method)
(gabm.io.llm.publicai.PublicAIService method)
SERVICE_NAME (gabm.io.llm.deepseek.DeepSeekService attribute)
(gabm.io.llm.genai.GenAIService attribute)
(gabm.io.llm.llm_service.LLMService attribute)
(gabm.io.llm.openai.OpenAIService attribute)
(gabm.io.llm.publicai.PublicAIService attribute)
set_opinion() (gabm.abm.agent.Person method)
set_value() (gabm.abm.attributes.opinion.Opinion method)
setup_module_logger() (in module gabm.utils.logging)
simple_extract_text() (gabm.io.llm.deepseek.DeepSeekService static method)
(gabm.io.llm.genai.GenAIService static method)
(gabm.io.llm.openai.OpenAIService static method)
(gabm.io.llm.publicai.PublicAIService static method)
SOUTH (gabm.abm.attributes.region.RegionID attribute)
SOUTH_EAST (gabm.abm.attributes.region.RegionID attribute)
SOUTH_WEST (gabm.abm.attributes.region.RegionID attribute)
STUDENT (gabm.abm.attributes.employment.EmploymentID attribute)
Survey (class in gabm.abm.survey)
SurveyConversation (class in gabm.abm.survey)
T
T (gabm.abm.attribute.GABMAttributeMap attribute)
TOP_0_001 (gabm.abm.attributes.income.IncomeID attribute)
(gabm.abm.attributes.wealth.WealthID attribute)
TOP_0_01_TO_TOP_0_001 (gabm.abm.attributes.income.IncomeID attribute)
(gabm.abm.attributes.wealth.WealthID attribute)
TOP_0_1_TO_TOP_0_01 (gabm.abm.attributes.income.IncomeID attribute)
(gabm.abm.attributes.wealth.WealthID attribute)
TOP_10_TO_TOP_1 (gabm.abm.attributes.income.IncomeID attribute)
(gabm.abm.attributes.wealth.WealthID attribute)
TOP_1_TO_TOP_0_1 (gabm.abm.attributes.income.IncomeID attribute)
(gabm.abm.attributes.wealth.WealthID attribute)
U
UKGE (class in gabm.abm.democracy.elections.uk.general_election)
UKGEVote (class in gabm.abm.democracy.elections.uk.general_election)
UKGEVoteID (class in gabm.abm.democracy.elections.uk.general_election)
UKReferendum (class in gabm.abm.democracy.elections.uk.referendum)
UKReferendumVote (class in gabm.abm.democracy.elections.uk.referendum)
UKReferendumVoteID (class in gabm.abm.democracy.elections.uk.referendum)
UNEMPLOYED (gabm.abm.attributes.employment.EmploymentID attribute)
UNIVERSITY (gabm.abm.attributes.education.EducationID attribute)
UNKNOWN (gabm.abm.attributes.education.EducationID attribute)
(gabm.abm.attributes.employment.EmploymentID attribute)
(gabm.abm.attributes.ethnicity.EthnicityID attribute)
(gabm.abm.attributes.family.FamilyID attribute)
(gabm.abm.attributes.gender.GenderID attribute)
(gabm.abm.attributes.health.HealthID attribute)
(gabm.abm.attributes.income.IncomeID attribute)
(gabm.abm.attributes.opinion.OpinionTopicID attribute)
(gabm.abm.attributes.politics.PoliticsID attribute)
(gabm.abm.attributes.region.RegionID attribute)
(gabm.abm.attributes.wealth.WealthID attribute)
V
values() (gabm.abm.attribute.GABMAttributeMap method)
VERY_BAD (gabm.abm.attributes.health.HealthID attribute)
VERY_GOOD (gabm.abm.attributes.health.HealthID attribute)
Vote (class in gabm.abm.democracy.election)
VoteID (class in gabm.abm.democracy.election)
W
Wealth (class in gabm.abm.attributes.wealth)
wealth_map (gabm.abm.attributes.wealth.WealthMap attribute)
WealthID (class in gabm.abm.attributes.wealth)
WealthMap (class in gabm.abm.attributes.wealth)
WEST (gabm.abm.attributes.region.RegionID attribute)
write_models_json_and_txt() (in module gabm.io.llm.utils)
Y
year_of_birth (gabm.abm.agent.Person attribute)
Z
ZERO_TO_Q1 (gabm.abm.attributes.income.IncomeID attribute)
(gabm.abm.attributes.wealth.WealthID attribute)