Update README.md

nialloulton · Apr 19, 2023 · a757a05 · a757a05
1 parent c2a9248
commit a757a05
Showing 1 changed file with 26 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -53,6 +53,32 @@ Here's a high-level explanation of how the automodeller works:
 - This iterative process continues until the model converges to a satisfactory solution based on both statistical and practical considerations, or until the maximum number of iterations is reached.
 - Throughout this process, the automodeller ensures that it does not overfit the model or select variables that do not make sense in the context of a marketing mix model. The goal is to find a model with the best balance of performance (highest R-squared and lowest AIC) and practical relevance, considering the impact of media channels, price, distribution, and other relevant factors.
 
+## Holidays Supported
+| Country                     | Code | Subdivisions Available                                                                                                                                                                                                                                                                                                                                 |
+|-----------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| American Samoa              | AS   | Can also be loaded as country US, subdivision AS                                                                                                                                                                                                                                                                                                       |
+| Andorra                     | AD   | Parishes: 02, 03, 04, 05, 06, 07, 08                                                                                                                                                                                                                                                                                                                   |
+| Australia                   | AU   | States and territories: ACT (default), NSW, NT, QLD, SA, TAS, VIC, WA                                                                                                                                                                                                                                                                                 |
+| Austria                     | AT   | States: 1, 2, 3, 4, 5, 6, 7, 8, 9 (default)                                                                                                                                                                                                                                                                                                            |
+| Bolivia                     | BO   | Departments: B, C, H, L, N, O, P, S, T                                                                                                                                                                                                                                                                                                                 |
+| Bosnia and Herzegovina      | BA   | Departments: BD, FBiH, RS                                                                                                                                                                                                                                                                                                                              |
+| Brazil                      | BR   | States: AC, AL, AM, AP, BA, CE, DF, ES, GO, MA, MG, MS, MT, PA, PB, PE, PI, PR, RJ, RN, RO, RR, RS, SC, SE, SP, TO                                                                                                                                                                                                                                   |
+| Canada                      | CA   | Provinces and territories: AB, BC, MB, NB, NL, NS, NT, NU, ON (default), PE, QC, SK, YT                                                                                                                                                                                                                                                              |
+| Chile                       | CL   | Regions: AI, AN, AP, AR, AT, BI, CO, LI, LL, LR, MA, ML, NB, RM, TA, VS                                                                                                                                                                                                                                                                               |
+| France                      | FR   | Départements: Alsace-Moselle, Guadeloupe, Guyane, La Réunion, Martinique, Mayotte, Métropole, Nouvelle-Calédonie, Polynésie Française, Saint-Barthélémy, Saint-Martin, Wallis-et-Futuna                                                                                                                                                              |
+| Germany                     | DE   | States: BB, BE, BW, BY, BYP, HB, HE, HH, MV, NI, NW, RP, SH, SL, SN, ST, TH                                                                                                                                                                                                                                                                            |
+| Guam                        | GU   | Can also be loaded as country US, subdivision GU                                                                                                                                                                                                                                                                                                       |
+| India                       | IN   | States: AN, AP, AR, AS, BR, CG, CH, DD, DH, DL, GA, GJ, HP, HR, JH, JK, KA, KL, LA, LD, MH, ML, MN, MP, MZ, NL, OR, PB, PY, RJ, SK, TN, TR, TS, UK, UP, WB                                                                                                                                                                                           |
+| Italy                       | IT   | Provinces: AG, AL, AN, AO, AP, AQ, AR, AT, AV, BA, BG, BI, BL, BN, BO, BR, BS, BT, BZ, CA, CB, CE, CH, CL, CN, CO, CR, CS, CT, CZ, EN, FC, FE, FG, FI, FM, FR, GE, GO, GR, IM, IS, KR, LC, LE, LI, LO, LT, LU, MB, MC, ME, MI, MN, MO, MS, MT, NA, NO, NU, OR, PA, PC, PD, PE, PG, PI, PN, PO, PR, PT, PU
+| Puerto Rico                 | PR   | Can also be loaded as country US, subdivision PR                                                                                                                                                                                                                                                                                                     |
+| Nicaragua                   | NI   | Departments: AN, AS, BO, CA, CI, CO, ES, GR, JI, LE, MD, MN (default), MS, MT, NS, RI, SJ                                                                                                                                                                                                                                                            |
+| Portugal                    | PT   | Districts: 01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12, 13, 14, 15, 16, 17, 18, 20, 30, Ext; Use subdiv=’Ext’ to include holidays most people have off                                                                                                                                                                                            |
+| Spain                       | ES   | Autonomous communities: AN, AR, AS, CB, CE, CL, CM, CN, CT, EX, GA, IB, MC, MD, ML, NC, PV, RI, VC                                                                                                                                                                                                                                                   |
+| United Kingdom              | GB   | Subdivisions: England, Northern Ireland, Scotland, UK (default), Wales; For Isle of Man use country code IM                                                                                                                                                                                                                                          |
+| United States of America     | US   | States and territories: AL, AK, AS, AZ, AR, CA, CO, CT, DE, DC, FL, GA, GU, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MH, MA, MI, FM, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, MP, OH, OK, OR, PW, PA, PR, RI, SC, SD, TN, TX, UM, UT, VT, VA, VI, WA, WV, WI, WY                     |
+| United States Minor Outlying Islands | UM   | Can also be loaded as country US, subdivision UM                                                                                                                                                                                                                                                                                                     |
+| Virgin Islands (U.S.)       | VI   | Can also be loaded as country US, subdivision VI                                                                                                                                                                                                                                                                                         
+
 ## Limitations and Risks
 - As an experimental library, AutoMMM.ai may produce unexpected or suboptimal results.
 - There is a risk of misuse through looping a self-prompt, which may lead to unintended consequences. Users should exercise caution and be aware of the risks involved.