edsl 0.1.39.dev3__py3-none-any.whl → 0.1.39.dev4__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (344) hide show
  1. edsl/Base.py +413 -332
  2. edsl/BaseDiff.py +260 -260
  3. edsl/TemplateLoader.py +24 -24
  4. edsl/__init__.py +57 -49
  5. edsl/__version__.py +1 -1
  6. edsl/agents/Agent.py +1071 -867
  7. edsl/agents/AgentList.py +551 -413
  8. edsl/agents/Invigilator.py +284 -233
  9. edsl/agents/InvigilatorBase.py +257 -270
  10. edsl/agents/PromptConstructor.py +272 -354
  11. edsl/agents/QuestionInstructionPromptBuilder.py +128 -0
  12. edsl/agents/QuestionTemplateReplacementsBuilder.py +137 -0
  13. edsl/agents/__init__.py +2 -3
  14. edsl/agents/descriptors.py +99 -99
  15. edsl/agents/prompt_helpers.py +129 -129
  16. edsl/agents/question_option_processor.py +172 -0
  17. edsl/auto/AutoStudy.py +130 -117
  18. edsl/auto/StageBase.py +243 -230
  19. edsl/auto/StageGenerateSurvey.py +178 -178
  20. edsl/auto/StageLabelQuestions.py +125 -125
  21. edsl/auto/StagePersona.py +61 -61
  22. edsl/auto/StagePersonaDimensionValueRanges.py +88 -88
  23. edsl/auto/StagePersonaDimensionValues.py +74 -74
  24. edsl/auto/StagePersonaDimensions.py +69 -69
  25. edsl/auto/StageQuestions.py +74 -73
  26. edsl/auto/SurveyCreatorPipeline.py +21 -21
  27. edsl/auto/utilities.py +218 -224
  28. edsl/base/Base.py +279 -279
  29. edsl/config.py +177 -157
  30. edsl/conversation/Conversation.py +290 -290
  31. edsl/conversation/car_buying.py +59 -58
  32. edsl/conversation/chips.py +95 -95
  33. edsl/conversation/mug_negotiation.py +81 -81
  34. edsl/conversation/next_speaker_utilities.py +93 -93
  35. edsl/coop/CoopFunctionsMixin.py +15 -0
  36. edsl/coop/ExpectedParrotKeyHandler.py +125 -0
  37. edsl/coop/PriceFetcher.py +54 -54
  38. edsl/coop/__init__.py +2 -2
  39. edsl/coop/coop.py +1106 -1028
  40. edsl/coop/utils.py +131 -131
  41. edsl/data/Cache.py +573 -555
  42. edsl/data/CacheEntry.py +230 -233
  43. edsl/data/CacheHandler.py +168 -149
  44. edsl/data/RemoteCacheSync.py +186 -78
  45. edsl/data/SQLiteDict.py +292 -292
  46. edsl/data/__init__.py +5 -4
  47. edsl/data/hack.py +10 -0
  48. edsl/data/orm.py +10 -10
  49. edsl/data_transfer_models.py +74 -73
  50. edsl/enums.py +202 -175
  51. edsl/exceptions/BaseException.py +21 -21
  52. edsl/exceptions/__init__.py +54 -54
  53. edsl/exceptions/agents.py +54 -42
  54. edsl/exceptions/cache.py +5 -5
  55. edsl/exceptions/configuration.py +16 -16
  56. edsl/exceptions/coop.py +10 -10
  57. edsl/exceptions/data.py +14 -14
  58. edsl/exceptions/general.py +34 -34
  59. edsl/exceptions/inference_services.py +5 -0
  60. edsl/exceptions/jobs.py +33 -33
  61. edsl/exceptions/language_models.py +63 -63
  62. edsl/exceptions/prompts.py +15 -15
  63. edsl/exceptions/questions.py +109 -91
  64. edsl/exceptions/results.py +29 -29
  65. edsl/exceptions/scenarios.py +29 -22
  66. edsl/exceptions/surveys.py +37 -37
  67. edsl/inference_services/AnthropicService.py +106 -87
  68. edsl/inference_services/AvailableModelCacheHandler.py +184 -0
  69. edsl/inference_services/AvailableModelFetcher.py +215 -0
  70. edsl/inference_services/AwsBedrock.py +118 -120
  71. edsl/inference_services/AzureAI.py +215 -217
  72. edsl/inference_services/DeepInfraService.py +18 -18
  73. edsl/inference_services/GoogleService.py +143 -148
  74. edsl/inference_services/GroqService.py +20 -20
  75. edsl/inference_services/InferenceServiceABC.py +80 -147
  76. edsl/inference_services/InferenceServicesCollection.py +138 -97
  77. edsl/inference_services/MistralAIService.py +120 -123
  78. edsl/inference_services/OllamaService.py +18 -18
  79. edsl/inference_services/OpenAIService.py +236 -224
  80. edsl/inference_services/PerplexityService.py +160 -163
  81. edsl/inference_services/ServiceAvailability.py +135 -0
  82. edsl/inference_services/TestService.py +90 -89
  83. edsl/inference_services/TogetherAIService.py +172 -170
  84. edsl/inference_services/data_structures.py +134 -0
  85. edsl/inference_services/models_available_cache.py +118 -118
  86. edsl/inference_services/rate_limits_cache.py +25 -25
  87. edsl/inference_services/registry.py +41 -41
  88. edsl/inference_services/write_available.py +10 -10
  89. edsl/jobs/AnswerQuestionFunctionConstructor.py +223 -0
  90. edsl/jobs/Answers.py +43 -56
  91. edsl/jobs/FetchInvigilator.py +47 -0
  92. edsl/jobs/InterviewTaskManager.py +98 -0
  93. edsl/jobs/InterviewsConstructor.py +50 -0
  94. edsl/jobs/Jobs.py +823 -898
  95. edsl/jobs/JobsChecks.py +172 -147
  96. edsl/jobs/JobsComponentConstructor.py +189 -0
  97. edsl/jobs/JobsPrompts.py +270 -268
  98. edsl/jobs/JobsRemoteInferenceHandler.py +311 -239
  99. edsl/jobs/JobsRemoteInferenceLogger.py +239 -0
  100. edsl/jobs/RequestTokenEstimator.py +30 -0
  101. edsl/jobs/__init__.py +1 -1
  102. edsl/jobs/async_interview_runner.py +138 -0
  103. edsl/jobs/buckets/BucketCollection.py +104 -63
  104. edsl/jobs/buckets/ModelBuckets.py +65 -65
  105. edsl/jobs/buckets/TokenBucket.py +283 -251
  106. edsl/jobs/buckets/TokenBucketAPI.py +211 -0
  107. edsl/jobs/buckets/TokenBucketClient.py +191 -0
  108. edsl/jobs/check_survey_scenario_compatibility.py +85 -0
  109. edsl/jobs/data_structures.py +120 -0
  110. edsl/jobs/decorators.py +35 -0
  111. edsl/jobs/interviews/Interview.py +396 -661
  112. edsl/jobs/interviews/InterviewExceptionCollection.py +99 -99
  113. edsl/jobs/interviews/InterviewExceptionEntry.py +186 -186
  114. edsl/jobs/interviews/InterviewStatistic.py +63 -63
  115. edsl/jobs/interviews/InterviewStatisticsCollection.py +25 -25
  116. edsl/jobs/interviews/InterviewStatusDictionary.py +78 -78
  117. edsl/jobs/interviews/InterviewStatusLog.py +92 -92
  118. edsl/jobs/interviews/ReportErrors.py +66 -66
  119. edsl/jobs/interviews/interview_status_enum.py +9 -9
  120. edsl/jobs/jobs_status_enums.py +9 -0
  121. edsl/jobs/loggers/HTMLTableJobLogger.py +304 -0
  122. edsl/jobs/results_exceptions_handler.py +98 -0
  123. edsl/jobs/runners/JobsRunnerAsyncio.py +151 -466
  124. edsl/jobs/runners/JobsRunnerStatus.py +297 -330
  125. edsl/jobs/tasks/QuestionTaskCreator.py +244 -242
  126. edsl/jobs/tasks/TaskCreators.py +64 -64
  127. edsl/jobs/tasks/TaskHistory.py +470 -450
  128. edsl/jobs/tasks/TaskStatusLog.py +23 -23
  129. edsl/jobs/tasks/task_status_enum.py +161 -163
  130. edsl/jobs/tokens/InterviewTokenUsage.py +27 -27
  131. edsl/jobs/tokens/TokenUsage.py +34 -34
  132. edsl/language_models/ComputeCost.py +63 -0
  133. edsl/language_models/LanguageModel.py +626 -668
  134. edsl/language_models/ModelList.py +164 -155
  135. edsl/language_models/PriceManager.py +127 -0
  136. edsl/language_models/RawResponseHandler.py +106 -0
  137. edsl/language_models/RegisterLanguageModelsMeta.py +184 -184
  138. edsl/language_models/ServiceDataSources.py +0 -0
  139. edsl/language_models/__init__.py +2 -3
  140. edsl/language_models/fake_openai_call.py +15 -15
  141. edsl/language_models/fake_openai_service.py +61 -61
  142. edsl/language_models/key_management/KeyLookup.py +63 -0
  143. edsl/language_models/key_management/KeyLookupBuilder.py +273 -0
  144. edsl/language_models/key_management/KeyLookupCollection.py +38 -0
  145. edsl/language_models/key_management/__init__.py +0 -0
  146. edsl/language_models/key_management/models.py +131 -0
  147. edsl/language_models/model.py +256 -0
  148. edsl/language_models/repair.py +156 -156
  149. edsl/language_models/utilities.py +65 -64
  150. edsl/notebooks/Notebook.py +263 -258
  151. edsl/notebooks/NotebookToLaTeX.py +142 -0
  152. edsl/notebooks/__init__.py +1 -1
  153. edsl/prompts/Prompt.py +352 -362
  154. edsl/prompts/__init__.py +2 -2
  155. edsl/questions/ExceptionExplainer.py +77 -0
  156. edsl/questions/HTMLQuestion.py +103 -0
  157. edsl/questions/QuestionBase.py +518 -664
  158. edsl/questions/QuestionBasePromptsMixin.py +221 -217
  159. edsl/questions/QuestionBudget.py +227 -227
  160. edsl/questions/QuestionCheckBox.py +359 -359
  161. edsl/questions/QuestionExtract.py +180 -182
  162. edsl/questions/QuestionFreeText.py +113 -114
  163. edsl/questions/QuestionFunctional.py +166 -166
  164. edsl/questions/QuestionList.py +223 -231
  165. edsl/questions/QuestionMatrix.py +265 -0
  166. edsl/questions/QuestionMultipleChoice.py +330 -286
  167. edsl/questions/QuestionNumerical.py +151 -153
  168. edsl/questions/QuestionRank.py +314 -324
  169. edsl/questions/Quick.py +41 -41
  170. edsl/questions/SimpleAskMixin.py +74 -73
  171. edsl/questions/__init__.py +27 -26
  172. edsl/questions/{AnswerValidatorMixin.py → answer_validator_mixin.py} +334 -289
  173. edsl/questions/compose_questions.py +98 -98
  174. edsl/questions/data_structures.py +20 -0
  175. edsl/questions/decorators.py +21 -21
  176. edsl/questions/derived/QuestionLikertFive.py +76 -76
  177. edsl/questions/derived/QuestionLinearScale.py +90 -87
  178. edsl/questions/derived/QuestionTopK.py +93 -93
  179. edsl/questions/derived/QuestionYesNo.py +82 -82
  180. edsl/questions/descriptors.py +427 -413
  181. edsl/questions/loop_processor.py +149 -0
  182. edsl/questions/prompt_templates/question_budget.jinja +13 -13
  183. edsl/questions/prompt_templates/question_checkbox.jinja +32 -32
  184. edsl/questions/prompt_templates/question_extract.jinja +11 -11
  185. edsl/questions/prompt_templates/question_free_text.jinja +3 -3
  186. edsl/questions/prompt_templates/question_linear_scale.jinja +11 -11
  187. edsl/questions/prompt_templates/question_list.jinja +17 -17
  188. edsl/questions/prompt_templates/question_multiple_choice.jinja +33 -33
  189. edsl/questions/prompt_templates/question_numerical.jinja +36 -36
  190. edsl/questions/{QuestionBaseGenMixin.py → question_base_gen_mixin.py} +168 -161
  191. edsl/questions/question_registry.py +177 -177
  192. edsl/questions/{RegisterQuestionsMeta.py → register_questions_meta.py} +71 -71
  193. edsl/questions/{ResponseValidatorABC.py → response_validator_abc.py} +188 -174
  194. edsl/questions/response_validator_factory.py +34 -0
  195. edsl/questions/settings.py +12 -12
  196. edsl/questions/templates/budget/answering_instructions.jinja +7 -7
  197. edsl/questions/templates/budget/question_presentation.jinja +7 -7
  198. edsl/questions/templates/checkbox/answering_instructions.jinja +10 -10
  199. edsl/questions/templates/checkbox/question_presentation.jinja +22 -22
  200. edsl/questions/templates/extract/answering_instructions.jinja +7 -7
  201. edsl/questions/templates/likert_five/answering_instructions.jinja +10 -10
  202. edsl/questions/templates/likert_five/question_presentation.jinja +11 -11
  203. edsl/questions/templates/linear_scale/answering_instructions.jinja +5 -5
  204. edsl/questions/templates/linear_scale/question_presentation.jinja +5 -5
  205. edsl/questions/templates/list/answering_instructions.jinja +3 -3
  206. edsl/questions/templates/list/question_presentation.jinja +5 -5
  207. edsl/questions/templates/matrix/__init__.py +1 -0
  208. edsl/questions/templates/matrix/answering_instructions.jinja +5 -0
  209. edsl/questions/templates/matrix/question_presentation.jinja +20 -0
  210. edsl/questions/templates/multiple_choice/answering_instructions.jinja +9 -9
  211. edsl/questions/templates/multiple_choice/question_presentation.jinja +11 -11
  212. edsl/questions/templates/numerical/answering_instructions.jinja +6 -6
  213. edsl/questions/templates/numerical/question_presentation.jinja +6 -6
  214. edsl/questions/templates/rank/answering_instructions.jinja +11 -11
  215. edsl/questions/templates/rank/question_presentation.jinja +15 -15
  216. edsl/questions/templates/top_k/answering_instructions.jinja +8 -8
  217. edsl/questions/templates/top_k/question_presentation.jinja +22 -22
  218. edsl/questions/templates/yes_no/answering_instructions.jinja +6 -6
  219. edsl/questions/templates/yes_no/question_presentation.jinja +11 -11
  220. edsl/results/CSSParameterizer.py +108 -108
  221. edsl/results/Dataset.py +587 -424
  222. edsl/results/DatasetExportMixin.py +594 -731
  223. edsl/results/DatasetTree.py +295 -275
  224. edsl/results/MarkdownToDocx.py +122 -0
  225. edsl/results/MarkdownToPDF.py +111 -0
  226. edsl/results/Result.py +557 -465
  227. edsl/results/Results.py +1183 -1165
  228. edsl/results/ResultsExportMixin.py +45 -43
  229. edsl/results/ResultsGGMixin.py +121 -121
  230. edsl/results/TableDisplay.py +125 -198
  231. edsl/results/TextEditor.py +50 -0
  232. edsl/results/__init__.py +2 -2
  233. edsl/results/file_exports.py +252 -0
  234. edsl/results/{ResultsFetchMixin.py → results_fetch_mixin.py} +33 -33
  235. edsl/results/{Selector.py → results_selector.py} +145 -135
  236. edsl/results/{ResultsToolsMixin.py → results_tools_mixin.py} +98 -98
  237. edsl/results/smart_objects.py +96 -0
  238. edsl/results/table_data_class.py +12 -0
  239. edsl/results/table_display.css +77 -77
  240. edsl/results/table_renderers.py +118 -0
  241. edsl/results/tree_explore.py +115 -115
  242. edsl/scenarios/ConstructDownloadLink.py +109 -0
  243. edsl/scenarios/DocumentChunker.py +102 -0
  244. edsl/scenarios/DocxScenario.py +16 -0
  245. edsl/scenarios/FileStore.py +511 -632
  246. edsl/scenarios/PdfExtractor.py +40 -0
  247. edsl/scenarios/Scenario.py +498 -601
  248. edsl/scenarios/ScenarioHtmlMixin.py +65 -64
  249. edsl/scenarios/ScenarioList.py +1458 -1287
  250. edsl/scenarios/ScenarioListExportMixin.py +45 -52
  251. edsl/scenarios/ScenarioListPdfMixin.py +239 -261
  252. edsl/scenarios/__init__.py +3 -4
  253. edsl/scenarios/directory_scanner.py +96 -0
  254. edsl/scenarios/file_methods.py +85 -0
  255. edsl/scenarios/handlers/__init__.py +13 -0
  256. edsl/scenarios/handlers/csv.py +38 -0
  257. edsl/scenarios/handlers/docx.py +76 -0
  258. edsl/scenarios/handlers/html.py +37 -0
  259. edsl/scenarios/handlers/json.py +111 -0
  260. edsl/scenarios/handlers/latex.py +5 -0
  261. edsl/scenarios/handlers/md.py +51 -0
  262. edsl/scenarios/handlers/pdf.py +68 -0
  263. edsl/scenarios/handlers/png.py +39 -0
  264. edsl/scenarios/handlers/pptx.py +105 -0
  265. edsl/scenarios/handlers/py.py +294 -0
  266. edsl/scenarios/handlers/sql.py +313 -0
  267. edsl/scenarios/handlers/sqlite.py +149 -0
  268. edsl/scenarios/handlers/txt.py +33 -0
  269. edsl/scenarios/{ScenarioJoin.py → scenario_join.py} +131 -127
  270. edsl/scenarios/scenario_selector.py +156 -0
  271. edsl/shared.py +1 -1
  272. edsl/study/ObjectEntry.py +173 -173
  273. edsl/study/ProofOfWork.py +113 -113
  274. edsl/study/SnapShot.py +80 -80
  275. edsl/study/Study.py +521 -528
  276. edsl/study/__init__.py +4 -4
  277. edsl/surveys/ConstructDAG.py +92 -0
  278. edsl/surveys/DAG.py +148 -148
  279. edsl/surveys/EditSurvey.py +221 -0
  280. edsl/surveys/InstructionHandler.py +100 -0
  281. edsl/surveys/Memory.py +31 -31
  282. edsl/surveys/MemoryManagement.py +72 -0
  283. edsl/surveys/MemoryPlan.py +244 -244
  284. edsl/surveys/Rule.py +327 -326
  285. edsl/surveys/RuleCollection.py +385 -387
  286. edsl/surveys/RuleManager.py +172 -0
  287. edsl/surveys/Simulator.py +75 -0
  288. edsl/surveys/Survey.py +1280 -1801
  289. edsl/surveys/SurveyCSS.py +273 -261
  290. edsl/surveys/SurveyExportMixin.py +259 -259
  291. edsl/surveys/{SurveyFlowVisualizationMixin.py → SurveyFlowVisualization.py} +181 -179
  292. edsl/surveys/SurveyQualtricsImport.py +284 -284
  293. edsl/surveys/SurveyToApp.py +141 -0
  294. edsl/surveys/__init__.py +5 -3
  295. edsl/surveys/base.py +53 -53
  296. edsl/surveys/descriptors.py +60 -56
  297. edsl/surveys/instructions/ChangeInstruction.py +48 -49
  298. edsl/surveys/instructions/Instruction.py +56 -65
  299. edsl/surveys/instructions/InstructionCollection.py +82 -77
  300. edsl/templates/error_reporting/base.html +23 -23
  301. edsl/templates/error_reporting/exceptions_by_model.html +34 -34
  302. edsl/templates/error_reporting/exceptions_by_question_name.html +16 -16
  303. edsl/templates/error_reporting/exceptions_by_type.html +16 -16
  304. edsl/templates/error_reporting/interview_details.html +115 -115
  305. edsl/templates/error_reporting/interviews.html +19 -19
  306. edsl/templates/error_reporting/overview.html +4 -4
  307. edsl/templates/error_reporting/performance_plot.html +1 -1
  308. edsl/templates/error_reporting/report.css +73 -73
  309. edsl/templates/error_reporting/report.html +117 -117
  310. edsl/templates/error_reporting/report.js +25 -25
  311. edsl/test_h +1 -0
  312. edsl/tools/__init__.py +1 -1
  313. edsl/tools/clusters.py +192 -192
  314. edsl/tools/embeddings.py +27 -27
  315. edsl/tools/embeddings_plotting.py +118 -118
  316. edsl/tools/plotting.py +112 -112
  317. edsl/tools/summarize.py +18 -18
  318. edsl/utilities/PrettyList.py +56 -0
  319. edsl/utilities/SystemInfo.py +28 -28
  320. edsl/utilities/__init__.py +22 -22
  321. edsl/utilities/ast_utilities.py +25 -25
  322. edsl/utilities/data/Registry.py +6 -6
  323. edsl/utilities/data/__init__.py +1 -1
  324. edsl/utilities/data/scooter_results.json +1 -1
  325. edsl/utilities/decorators.py +77 -77
  326. edsl/utilities/gcp_bucket/cloud_storage.py +96 -96
  327. edsl/utilities/gcp_bucket/example.py +50 -0
  328. edsl/utilities/interface.py +627 -627
  329. edsl/utilities/is_notebook.py +18 -0
  330. edsl/utilities/is_valid_variable_name.py +11 -0
  331. edsl/utilities/naming_utilities.py +263 -263
  332. edsl/utilities/remove_edsl_version.py +24 -0
  333. edsl/utilities/repair_functions.py +28 -28
  334. edsl/utilities/restricted_python.py +70 -70
  335. edsl/utilities/utilities.py +436 -424
  336. {edsl-0.1.39.dev3.dist-info → edsl-0.1.39.dev4.dist-info}/LICENSE +21 -21
  337. {edsl-0.1.39.dev3.dist-info → edsl-0.1.39.dev4.dist-info}/METADATA +13 -11
  338. edsl-0.1.39.dev4.dist-info/RECORD +361 -0
  339. edsl/language_models/KeyLookup.py +0 -30
  340. edsl/language_models/registry.py +0 -190
  341. edsl/language_models/unused/ReplicateBase.py +0 -83
  342. edsl/results/ResultsDBMixin.py +0 -238
  343. edsl-0.1.39.dev3.dist-info/RECORD +0 -277
  344. {edsl-0.1.39.dev3.dist-info → edsl-0.1.39.dev4.dist-info}/WHEEL +0 -0
@@ -1,450 +1,470 @@
1
- from typing import List, Optional
2
- from io import BytesIO
3
- import webbrowser
4
- import os
5
- import base64
6
- from importlib import resources
7
- from edsl.jobs.tasks.task_status_enum import TaskStatus
8
-
9
-
10
- class TaskHistory:
11
- def __init__(
12
- self,
13
- interviews: List["Interview"],
14
- include_traceback: bool = False,
15
- max_interviews: int = 10,
16
- ):
17
- """
18
- The structure of a TaskHistory exception
19
-
20
- [Interview.exceptions, Interview.exceptions, Interview.exceptions, ...]
21
-
22
- >>> _ = TaskHistory.example()
23
- ...
24
- """
25
-
26
- self.total_interviews = interviews
27
- self.include_traceback = include_traceback
28
-
29
- self._interviews = {index: i for index, i in enumerate(self.total_interviews)}
30
- self.max_interviews = max_interviews
31
-
32
- @classmethod
33
- def example(cls):
34
- """ """
35
- from edsl.jobs.interviews.Interview import Interview
36
-
37
- from edsl.jobs.Jobs import Jobs
38
-
39
- j = Jobs.example(throw_exception_probability=1, test_model=True)
40
-
41
- from edsl.config import CONFIG
42
-
43
- results = j.run(
44
- print_exceptions=False,
45
- skip_retry=True,
46
- cache=False,
47
- raise_validation_errors=True,
48
- disable_remote_cache=True,
49
- disable_remote_inference=True,
50
- )
51
-
52
- return cls(results.task_history.total_interviews)
53
-
54
- @property
55
- def exceptions(self):
56
- """
57
- >>> len(TaskHistory.example().exceptions)
58
- 4
59
- """
60
- return [i.exceptions for k, i in self._interviews.items() if i.exceptions != {}]
61
-
62
- @property
63
- def unfixed_exceptions(self):
64
- """
65
- >>> len(TaskHistory.example().unfixed_exceptions)
66
- 4
67
- """
68
- return [
69
- i.exceptions
70
- for k, i in self._interviews.items()
71
- if i.exceptions.num_unfixed() > 0
72
- ]
73
-
74
- @property
75
- def indices(self):
76
- return [k for k, i in self._interviews.items() if i.exceptions != {}]
77
-
78
- def __repr__(self):
79
- """Return a string representation of the TaskHistory."""
80
- return f"TaskHistory(interviews={self.total_interviews})."
81
-
82
- def to_dict(self, add_edsl_version=True):
83
- """Return the TaskHistory as a dictionary."""
84
- d = {
85
- "interviews": [
86
- i.to_dict(add_edsl_version=add_edsl_version)
87
- for i in self.total_interviews
88
- ],
89
- "include_traceback": self.include_traceback,
90
- }
91
- if add_edsl_version:
92
- from edsl import __version__
93
-
94
- d["edsl_version"] = __version__
95
- d["edsl_class_name"] = "TaskHistory"
96
- return d
97
-
98
- @classmethod
99
- def from_dict(cls, data: dict):
100
- """Create a TaskHistory from a dictionary."""
101
- if data is None:
102
- return cls([], include_traceback=False)
103
-
104
- from edsl.jobs.interviews.Interview import Interview
105
-
106
- interviews = [Interview.from_dict(i) for i in data["interviews"]]
107
- return cls(interviews, include_traceback=data["include_traceback"])
108
-
109
- @property
110
- def has_exceptions(self) -> bool:
111
- """Return True if there are any exceptions.
112
-
113
- >>> TaskHistory.example().has_exceptions
114
- True
115
-
116
- """
117
- return len(self.exceptions) > 0
118
-
119
- @property
120
- def has_unfixed_exceptions(self) -> bool:
121
- """Return True if there are any exceptions."""
122
- return len(self.unfixed_exceptions) > 0
123
-
124
- def _repr_html_(self):
125
- """Return an HTML representation of the TaskHistory."""
126
- d = self.to_dict(add_edsl_version=False)
127
- data = [[k, v] for k, v in d.items()]
128
- from tabulate import tabulate
129
-
130
- return tabulate(data, headers=["keys", "values"], tablefmt="html")
131
-
132
- def show_exceptions(self, tracebacks=False):
133
- """Print the exceptions."""
134
- for index in self.indices:
135
- self.total_interviews[index].exceptions.print(tracebacks)
136
-
137
- def get_updates(self):
138
- """Return a list of all the updates."""
139
- updates = []
140
- for interview in self.total_interviews:
141
- for question_name, logs in interview.task_status_logs.items():
142
- updates.append(logs)
143
- return updates
144
-
145
- def print(self):
146
- from rich import print
147
-
148
- print(self.get_updates())
149
-
150
- def plot_completion_times(self):
151
- """Plot the completion times for each task."""
152
- import matplotlib.pyplot as plt
153
-
154
- updates = self.get_updates()
155
-
156
- elapsed = [update.max_time - update.min_time for update in updates]
157
- for i, update in enumerate(updates):
158
- if update[-1]["value"] != TaskStatus.SUCCESS:
159
- elapsed[i] = 0
160
- x = range(len(elapsed))
161
- y = elapsed
162
-
163
- plt.bar(x, y)
164
- plt.title("Per-interview completion times")
165
- plt.xlabel("Task")
166
- plt.ylabel("Time (seconds)")
167
- plt.show()
168
-
169
- def plotting_data(self, num_periods=100):
170
- updates = self.get_updates()
171
-
172
- min_t = min([update.min_time for update in updates])
173
- max_t = max([update.max_time for update in updates])
174
- delta_t = (max_t - min_t) / (num_periods * 1.0)
175
- time_periods = [min_t + delta_t * i for i in range(num_periods)]
176
-
177
- def counts(t):
178
- d = {}
179
- for update in updates:
180
- status = update.status_at_time(t)
181
- if status in d:
182
- d[status] += 1
183
- else:
184
- d[status] = 1
185
- return d
186
-
187
- status_counts = [counts(t) for t in time_periods]
188
-
189
- new_counts = []
190
- for status_count in status_counts:
191
- d = {task_status: 0 for task_status in TaskStatus}
192
- d.update(status_count)
193
- new_counts.append(d)
194
-
195
- return new_counts
196
-
197
- def plot(self, num_periods=100, get_embedded_html=False):
198
- """Plot the number of tasks in each state over time."""
199
- new_counts = self.plotting_data(num_periods)
200
- max_count = max([max(entry.values()) for entry in new_counts])
201
-
202
- rows = int(len(TaskStatus) ** 0.5) + 1
203
- cols = (len(TaskStatus) + rows - 1) // rows # Ensure all plots fit
204
-
205
- import matplotlib.pyplot as plt
206
-
207
- fig, axes = plt.subplots(rows, cols, figsize=(15, 10))
208
- axes = axes.flatten() # Flatten in case of a single row/column
209
-
210
- for i, status in enumerate(TaskStatus):
211
- ax = axes[i]
212
- x = range(len(new_counts))
213
- y = [
214
- item.get(status, 0) for item in new_counts
215
- ] # Use .get() to handle missing keys safely
216
- ax.plot(x, y, marker="o", linestyle="-")
217
- ax.set_title(status.name)
218
- ax.set_xlabel("Time Periods")
219
- ax.set_ylabel("Count")
220
- ax.grid(True)
221
- ax.set_ylim(0, max_count)
222
-
223
- # Hide any unused subplots
224
- for ax in axes[len(TaskStatus) :]:
225
- ax.axis("off")
226
-
227
- plt.tight_layout()
228
-
229
- if get_embedded_html:
230
- buffer = BytesIO()
231
- fig.savefig(buffer, format="png")
232
- plt.close(fig)
233
- buffer.seek(0)
234
-
235
- # Encode plot to base64 string
236
- img_data = base64.b64encode(buffer.getvalue()).decode("utf-8")
237
- buffer.close()
238
- return f'<img src="data:image/png;base64,{img_data}" alt="Plot">'
239
- else:
240
- plt.show()
241
-
242
- def css(self):
243
- env = resources.files("edsl").joinpath("templates/error_reporting")
244
- css = env.joinpath("report.css").read_text()
245
- return css
246
-
247
- def javascript(self):
248
- env = resources.files("edsl").joinpath("templates/error_reporting")
249
- js = env.joinpath("report.js").read_text()
250
- return js
251
-
252
- @property
253
- def exceptions_by_type(self) -> dict:
254
- """Return a dictionary of exceptions by type."""
255
- exceptions_by_type = {}
256
- for interview in self.total_interviews:
257
- for question_name, exceptions in interview.exceptions.items():
258
- for exception in exceptions:
259
- exception_type = exception.exception.__class__.__name__
260
- if exception_type in exceptions_by_type:
261
- exceptions_by_type[exception_type] += 1
262
- else:
263
- exceptions_by_type[exception_type] = 1
264
- return exceptions_by_type
265
-
266
- @property
267
- def exceptions_by_service(self) -> dict:
268
- """Return a dictionary of exceptions tallied by service."""
269
- exceptions_by_service = {}
270
- for interview in self.total_interviews:
271
- service = interview.model._inference_service_
272
- if service not in exceptions_by_service:
273
- exceptions_by_service[service] = 0
274
- if interview.exceptions != {}:
275
- exceptions_by_service[service] += len(interview.exceptions)
276
- return exceptions_by_service
277
-
278
- @property
279
- def exceptions_by_question_name(self) -> dict:
280
- """Return a dictionary of exceptions tallied by question name."""
281
- exceptions_by_question_name = {}
282
- for interview in self.total_interviews:
283
- for question_name, exceptions in interview.exceptions.items():
284
- question_type = interview.survey.get_question(
285
- question_name
286
- ).question_type
287
- if (question_name, question_type) not in exceptions_by_question_name:
288
- exceptions_by_question_name[(question_name, question_type)] = 0
289
- exceptions_by_question_name[(question_name, question_type)] += len(
290
- exceptions
291
- )
292
-
293
- for question in self.total_interviews[0].survey.questions:
294
- if (
295
- question.question_name,
296
- question.question_type,
297
- ) not in exceptions_by_question_name:
298
- exceptions_by_question_name[
299
- (question.question_name, question.question_type)
300
- ] = 0
301
-
302
- sorted_exceptions_by_question_name = {
303
- k: v
304
- for k, v in sorted(
305
- exceptions_by_question_name.items(),
306
- key=lambda item: item[1],
307
- reverse=True,
308
- )
309
- }
310
- return sorted_exceptions_by_question_name
311
-
312
- @property
313
- def exceptions_by_model(self) -> dict:
314
- """Return a dictionary of exceptions tallied by model and question name."""
315
- exceptions_by_model = {}
316
- for interview in self.total_interviews:
317
- model = interview.model.model
318
- service = interview.model._inference_service_
319
- if (service, model) not in exceptions_by_model:
320
- exceptions_by_model[(service, model)] = 0
321
- if interview.exceptions != {}:
322
- exceptions_by_model[(service, model)] += len(interview.exceptions)
323
-
324
- # sort the exceptions by model
325
- sorted_exceptions_by_model = {
326
- k: v
327
- for k, v in sorted(
328
- exceptions_by_model.items(), key=lambda item: item[1], reverse=True
329
- )
330
- }
331
- return sorted_exceptions_by_model
332
-
333
- def generate_html_report(self, css: Optional[str]):
334
- performance_plot_html = self.plot(num_periods=100, get_embedded_html=True)
335
-
336
- if css is None:
337
- css = self.css()
338
-
339
- models_used = set([i.model.model for index, i in self._interviews.items()])
340
-
341
- from jinja2 import Environment, FileSystemLoader
342
- from edsl.TemplateLoader import TemplateLoader
343
-
344
- env = Environment(loader=TemplateLoader("edsl", "templates/error_reporting"))
345
-
346
- # Get current memory usage at this point
347
-
348
- template = env.get_template("base.html")
349
-
350
- # Render the template with data
351
- output = template.render(
352
- interviews=self._interviews,
353
- css=css,
354
- javascript=self.javascript(),
355
- num_exceptions=len(self.exceptions),
356
- performance_plot_html=performance_plot_html,
357
- exceptions_by_type=self.exceptions_by_type,
358
- exceptions_by_question_name=self.exceptions_by_question_name,
359
- exceptions_by_model=self.exceptions_by_model,
360
- exceptions_by_service=self.exceptions_by_service,
361
- models_used=models_used,
362
- max_interviews=self.max_interviews,
363
- )
364
- return output
365
-
366
- def html(
367
- self,
368
- filename: Optional[str] = None,
369
- return_link=False,
370
- css=None,
371
- cta="Open Report in New Tab",
372
- open_in_browser=False,
373
- ):
374
- """Return an HTML report."""
375
-
376
- from IPython.display import display, HTML
377
- import tempfile
378
- import os
379
- from edsl.utilities.utilities import is_notebook
380
-
381
- output = self.generate_html_report(css)
382
-
383
- # Save the rendered output to a file
384
- with open("output.html", "w") as f:
385
- f.write(output)
386
-
387
- if filename is None:
388
- current_directory = os.getcwd()
389
- filename = tempfile.NamedTemporaryFile(
390
- "w", delete=False, suffix=".html", dir=current_directory
391
- ).name
392
-
393
- with open(filename, "w") as f:
394
- with open(filename, "w") as f:
395
- f.write(output)
396
-
397
- if is_notebook():
398
- import html
399
-
400
- html_url = f"/files/{filename}"
401
- html_link = f'<a href="{html_url}" target="_blank">{cta}</a>'
402
- display(HTML(html_link))
403
- escaped_output = html.escape(output)
404
- iframe = f""""
405
- <iframe srcdoc="{ escaped_output }" style="width: 800px; height: 600px;"></iframe>
406
- """
407
- display(HTML(iframe))
408
- else:
409
- print(f"Exception report saved to {filename}")
410
-
411
- if open_in_browser:
412
- webbrowser.open(f"file://{os.path.abspath(filename)}")
413
-
414
- if return_link:
415
- return filename
416
-
417
- def notebook(self):
418
- """Create a notebook with the HTML content embedded in the first cell, then delete the cell content while keeping the output."""
419
- from nbformat import v4 as nbf
420
- from nbconvert.preprocessors import ExecutePreprocessor
421
- import nbformat
422
- import os
423
-
424
- # Use the existing html method to generate the HTML content
425
- output_html = self.generate_html_report(css=None)
426
- nb = nbf.new_notebook()
427
-
428
- # Add a code cell that renders the HTML content
429
- code_cell = nbf.new_code_cell(
430
- f"""
431
- from IPython.display import HTML, display
432
- display(HTML('''{output_html}'''))
433
- """
434
- )
435
- nb.cells.append(code_cell)
436
-
437
- # Execute the notebook
438
- ep = ExecutePreprocessor(timeout=600, kernel_name="python3")
439
- ep.preprocess(nb, {"metadata": {"path": os.getcwd()}})
440
-
441
- # After execution, clear the cell's source code
442
- nb.cells[0].source = ""
443
-
444
- return nb
445
-
446
-
447
- if __name__ == "__main__":
448
- import doctest
449
-
450
- doctest.testmod(optionflags=doctest.ELLIPSIS)
1
+ from typing import List, Optional
2
+ from io import BytesIO
3
+ import base64
4
+ from edsl.jobs.tasks.task_status_enum import TaskStatus
5
+ from edsl.Base import RepresentationMixin
6
+
7
+
8
+ class TaskHistory(RepresentationMixin):
9
+ def __init__(
10
+ self,
11
+ interviews: List["Interview"] = None,
12
+ include_traceback: bool = False,
13
+ max_interviews: int = 10,
14
+ interviews_with_exceptions_only: bool = False,
15
+ ):
16
+ """
17
+ The structure of a TaskHistory exception
18
+
19
+ [Interview.exceptions, Interview.exceptions, Interview.exceptions, ...]
20
+
21
+ >>> _ = TaskHistory.example()
22
+ ...
23
+ """
24
+ self.interviews_with_exceptions_only = interviews_with_exceptions_only
25
+ self._interviews = {}
26
+ self.total_interviews = []
27
+ if interviews is not None:
28
+ for interview in interviews:
29
+ self.add_interview(interview)
30
+
31
+ self.include_traceback = include_traceback
32
+ self._interviews = {
33
+ index: interview for index, interview in enumerate(self.total_interviews)
34
+ }
35
+ self.max_interviews = max_interviews
36
+
37
+ # self.total_interviews = interviews
38
+ self.include_traceback = include_traceback
39
+
40
+ # self._interviews = {index: i for index, i in enumerate(self.total_interviews)}
41
+ self.max_interviews = max_interviews
42
+
43
+ def add_interview(self, interview: "Interview"):
44
+ """Add a single interview to the history"""
45
+ if self.interviews_with_exceptions_only and interview.exceptions == {}:
46
+ return
47
+
48
+ self.total_interviews.append(interview)
49
+ self._interviews[len(self._interviews)] = interview
50
+
51
+ @classmethod
52
+ def example(cls):
53
+ """ """
54
+ from edsl.jobs.interviews.Interview import Interview
55
+
56
+ from edsl.jobs.Jobs import Jobs
57
+
58
+ j = Jobs.example(throw_exception_probability=1, test_model=True)
59
+
60
+ from edsl.config import CONFIG
61
+
62
+ results = j.run(
63
+ print_exceptions=False,
64
+ skip_retry=True,
65
+ cache=False,
66
+ raise_validation_errors=True,
67
+ disable_remote_cache=True,
68
+ disable_remote_inference=True,
69
+ )
70
+
71
+ return cls(results.task_history.total_interviews)
72
+
73
+ @property
74
+ def exceptions(self):
75
+ """
76
+ >>> len(TaskHistory.example().exceptions)
77
+ 4
78
+ """
79
+ return [i.exceptions for k, i in self._interviews.items() if i.exceptions != {}]
80
+
81
+ @property
82
+ def unfixed_exceptions(self):
83
+ """
84
+ >>> len(TaskHistory.example().unfixed_exceptions)
85
+ 4
86
+ """
87
+ return [
88
+ i.exceptions
89
+ for k, i in self._interviews.items()
90
+ if i.exceptions.num_unfixed() > 0
91
+ ]
92
+
93
+ @property
94
+ def indices(self):
95
+ return [k for k, i in self._interviews.items() if i.exceptions != {}]
96
+
97
+ def __repr__(self):
98
+ """Return a string representation of the TaskHistory."""
99
+ return f"TaskHistory(interviews={self.total_interviews})."
100
+
101
+ def to_dict(self, add_edsl_version=True):
102
+ """Return the TaskHistory as a dictionary."""
103
+ d = {
104
+ "interviews": [
105
+ i.to_dict(add_edsl_version=add_edsl_version)
106
+ for i in self.total_interviews
107
+ ],
108
+ "include_traceback": self.include_traceback,
109
+ }
110
+ if add_edsl_version:
111
+ from edsl import __version__
112
+
113
+ d["edsl_version"] = __version__
114
+ d["edsl_class_name"] = "TaskHistory"
115
+ return d
116
+
117
+ @classmethod
118
+ def from_dict(cls, data: dict):
119
+ """Create a TaskHistory from a dictionary."""
120
+ if data is None:
121
+ return cls([], include_traceback=False)
122
+
123
+ from edsl.jobs.interviews.Interview import Interview
124
+
125
+ interviews = [Interview.from_dict(i) for i in data["interviews"]]
126
+ return cls(interviews, include_traceback=data["include_traceback"])
127
+
128
+ @property
129
+ def has_exceptions(self) -> bool:
130
+ """Return True if there are any exceptions.
131
+
132
+ >>> TaskHistory.example().has_exceptions
133
+ True
134
+
135
+ """
136
+ return len(self.exceptions) > 0
137
+
138
+ @property
139
+ def has_unfixed_exceptions(self) -> bool:
140
+ """Return True if there are any exceptions."""
141
+ return len(self.unfixed_exceptions) > 0
142
+
143
+ def show_exceptions(self, tracebacks=False):
144
+ """Print the exceptions."""
145
+ for index in self.indices:
146
+ self.total_interviews[index].exceptions.print(tracebacks)
147
+
148
+ def get_updates(self):
149
+ """Return a list of all the updates."""
150
+ updates = []
151
+ for interview in self.total_interviews:
152
+ for question_name, logs in interview.task_status_logs.items():
153
+ updates.append(logs)
154
+ return updates
155
+
156
+ def print(self):
157
+ from rich import print
158
+
159
+ print(self.get_updates())
160
+
161
+ def plot_completion_times(self):
162
+ """Plot the completion times for each task."""
163
+ import matplotlib.pyplot as plt
164
+
165
+ updates = self.get_updates()
166
+
167
+ elapsed = [update.max_time - update.min_time for update in updates]
168
+ for i, update in enumerate(updates):
169
+ if update[-1]["value"] != TaskStatus.SUCCESS:
170
+ elapsed[i] = 0
171
+ x = range(len(elapsed))
172
+ y = elapsed
173
+
174
+ plt.bar(x, y)
175
+ plt.title("Per-interview completion times")
176
+ plt.xlabel("Task")
177
+ plt.ylabel("Time (seconds)")
178
+ plt.show()
179
+
180
+ def plotting_data(self, num_periods=100):
181
+ updates = self.get_updates()
182
+
183
+ min_t = min([update.min_time for update in updates])
184
+ max_t = max([update.max_time for update in updates])
185
+ delta_t = (max_t - min_t) / (num_periods * 1.0)
186
+ time_periods = [min_t + delta_t * i for i in range(num_periods)]
187
+
188
+ def counts(t):
189
+ d = {}
190
+ for update in updates:
191
+ status = update.status_at_time(t)
192
+ if status in d:
193
+ d[status] += 1
194
+ else:
195
+ d[status] = 1
196
+ return d
197
+
198
+ status_counts = [counts(t) for t in time_periods]
199
+
200
+ new_counts = []
201
+ for status_count in status_counts:
202
+ d = {task_status: 0 for task_status in TaskStatus}
203
+ d.update(status_count)
204
+ new_counts.append(d)
205
+
206
+ return new_counts
207
+
208
+ def plot(self, num_periods=100, get_embedded_html=False):
209
+ """Plot the number of tasks in each state over time."""
210
+ new_counts = self.plotting_data(num_periods)
211
+ max_count = max([max(entry.values()) for entry in new_counts])
212
+
213
+ rows = int(len(TaskStatus) ** 0.5) + 1
214
+ cols = (len(TaskStatus) + rows - 1) // rows # Ensure all plots fit
215
+
216
+ import matplotlib.pyplot as plt
217
+
218
+ fig, axes = plt.subplots(rows, cols, figsize=(15, 10))
219
+ axes = axes.flatten() # Flatten in case of a single row/column
220
+
221
+ for i, status in enumerate(TaskStatus):
222
+ ax = axes[i]
223
+ x = range(len(new_counts))
224
+ y = [
225
+ item.get(status, 0) for item in new_counts
226
+ ] # Use .get() to handle missing keys safely
227
+ ax.plot(x, y, marker="o", linestyle="-")
228
+ ax.set_title(status.name)
229
+ ax.set_xlabel("Time Periods")
230
+ ax.set_ylabel("Count")
231
+ ax.grid(True)
232
+ ax.set_ylim(0, max_count)
233
+
234
+ # Hide any unused subplots
235
+ for ax in axes[len(TaskStatus) :]:
236
+ ax.axis("off")
237
+
238
+ plt.tight_layout()
239
+
240
+ if get_embedded_html:
241
+ buffer = BytesIO()
242
+ fig.savefig(buffer, format="png")
243
+ plt.close(fig)
244
+ buffer.seek(0)
245
+
246
+ # Encode plot to base64 string
247
+ img_data = base64.b64encode(buffer.getvalue()).decode("utf-8")
248
+ buffer.close()
249
+ return f'<img src="data:image/png;base64,{img_data}" alt="Plot">'
250
+ else:
251
+ plt.show()
252
+
253
+ def css(self):
254
+ from importlib import resources
255
+
256
+ env = resources.files("edsl").joinpath("templates/error_reporting")
257
+ css = env.joinpath("report.css").read_text()
258
+ return css
259
+
260
+ def javascript(self):
261
+ from importlib import resources
262
+
263
+ env = resources.files("edsl").joinpath("templates/error_reporting")
264
+ js = env.joinpath("report.js").read_text()
265
+ return js
266
+
267
+ @property
268
+ def exceptions_by_type(self) -> dict:
269
+ """Return a dictionary of exceptions by type."""
270
+ exceptions_by_type = {}
271
+ for interview in self.total_interviews:
272
+ for question_name, exceptions in interview.exceptions.items():
273
+ for exception in exceptions:
274
+ exception_type = exception.exception.__class__.__name__
275
+ if exception_type in exceptions_by_type:
276
+ exceptions_by_type[exception_type] += 1
277
+ else:
278
+ exceptions_by_type[exception_type] = 1
279
+ return exceptions_by_type
280
+
281
+ @property
282
+ def exceptions_by_service(self) -> dict:
283
+ """Return a dictionary of exceptions tallied by service."""
284
+ exceptions_by_service = {}
285
+ for interview in self.total_interviews:
286
+ service = interview.model._inference_service_
287
+ if service not in exceptions_by_service:
288
+ exceptions_by_service[service] = 0
289
+ if interview.exceptions != {}:
290
+ exceptions_by_service[service] += len(interview.exceptions)
291
+ return exceptions_by_service
292
+
293
+ @property
294
+ def exceptions_by_question_name(self) -> dict:
295
+ """Return a dictionary of exceptions tallied by question name."""
296
+ exceptions_by_question_name = {}
297
+ for interview in self.total_interviews:
298
+ for question_name, exceptions in interview.exceptions.items():
299
+ question_type = interview.survey._get_question_by_name(
300
+ question_name
301
+ ).question_type
302
+ if (question_name, question_type) not in exceptions_by_question_name:
303
+ exceptions_by_question_name[(question_name, question_type)] = 0
304
+ exceptions_by_question_name[(question_name, question_type)] += len(
305
+ exceptions
306
+ )
307
+
308
+ for question in self.total_interviews[0].survey.questions:
309
+ if (
310
+ question.question_name,
311
+ question.question_type,
312
+ ) not in exceptions_by_question_name:
313
+ exceptions_by_question_name[
314
+ (question.question_name, question.question_type)
315
+ ] = 0
316
+
317
+ sorted_exceptions_by_question_name = {
318
+ k: v
319
+ for k, v in sorted(
320
+ exceptions_by_question_name.items(),
321
+ key=lambda item: item[1],
322
+ reverse=True,
323
+ )
324
+ }
325
+ return sorted_exceptions_by_question_name
326
+
327
+ @property
328
+ def exceptions_by_model(self) -> dict:
329
+ """Return a dictionary of exceptions tallied by model and question name."""
330
+ exceptions_by_model = {}
331
+ for interview in self.total_interviews:
332
+ model = interview.model.model
333
+ service = interview.model._inference_service_
334
+ if (service, model) not in exceptions_by_model:
335
+ exceptions_by_model[(service, model)] = 0
336
+ if interview.exceptions != {}:
337
+ exceptions_by_model[(service, model)] += len(interview.exceptions)
338
+
339
+ # sort the exceptions by model
340
+ sorted_exceptions_by_model = {
341
+ k: v
342
+ for k, v in sorted(
343
+ exceptions_by_model.items(), key=lambda item: item[1], reverse=True
344
+ )
345
+ }
346
+ return sorted_exceptions_by_model
347
+
348
+ def generate_html_report(self, css: Optional[str], include_plot=False):
349
+ if include_plot:
350
+ performance_plot_html = self.plot(num_periods=100, get_embedded_html=True)
351
+ else:
352
+ performance_plot_html = ""
353
+
354
+ if css is None:
355
+ css = self.css()
356
+
357
+ models_used = set([i.model.model for index, i in self._interviews.items()])
358
+
359
+ from jinja2 import Environment, FileSystemLoader
360
+ from edsl.TemplateLoader import TemplateLoader
361
+
362
+ env = Environment(loader=TemplateLoader("edsl", "templates/error_reporting"))
363
+
364
+ # Get current memory usage at this point
365
+
366
+ template = env.get_template("base.html")
367
+
368
+ # Render the template with data
369
+ output = template.render(
370
+ interviews=self._interviews,
371
+ css=css,
372
+ javascript=self.javascript(),
373
+ num_exceptions=len(self.exceptions),
374
+ performance_plot_html=performance_plot_html,
375
+ exceptions_by_type=self.exceptions_by_type,
376
+ exceptions_by_question_name=self.exceptions_by_question_name,
377
+ exceptions_by_model=self.exceptions_by_model,
378
+ exceptions_by_service=self.exceptions_by_service,
379
+ models_used=models_used,
380
+ max_interviews=self.max_interviews,
381
+ )
382
+ return output
383
+
384
+ def html(
385
+ self,
386
+ filename: Optional[str] = None,
387
+ return_link=False,
388
+ css=None,
389
+ cta="Open Report in New Tab",
390
+ open_in_browser=False,
391
+ ):
392
+ """Return an HTML report."""
393
+
394
+ from IPython.display import display, HTML
395
+ import tempfile
396
+ import os
397
+ from edsl.utilities.utilities import is_notebook
398
+
399
+ output = self.generate_html_report(css)
400
+
401
+ # Save the rendered output to a file
402
+ with open("output.html", "w") as f:
403
+ f.write(output)
404
+
405
+ if filename is None:
406
+ current_directory = os.getcwd()
407
+ filename = tempfile.NamedTemporaryFile(
408
+ "w", delete=False, suffix=".html", dir=current_directory
409
+ ).name
410
+
411
+ with open(filename, "w") as f:
412
+ with open(filename, "w") as f:
413
+ f.write(output)
414
+
415
+ if is_notebook():
416
+ import html
417
+
418
+ html_url = f"/files/{filename}"
419
+ html_link = f'<a href="{html_url}" target="_blank">{cta}</a>'
420
+ display(HTML(html_link))
421
+ escaped_output = html.escape(output)
422
+ iframe = f""""
423
+ <iframe srcdoc="{ escaped_output }" style="width: 800px; height: 600px;"></iframe>
424
+ """
425
+ display(HTML(iframe))
426
+ else:
427
+ print(f"Exception report saved to {filename}")
428
+
429
+ if open_in_browser:
430
+ import webbrowser
431
+
432
+ webbrowser.open(f"file://{os.path.abspath(filename)}")
433
+
434
+ if return_link:
435
+ return filename
436
+
437
+ def notebook(self):
438
+ """Create a notebook with the HTML content embedded in the first cell, then delete the cell content while keeping the output."""
439
+ from nbformat import v4 as nbf
440
+ from nbconvert.preprocessors import ExecutePreprocessor
441
+ import nbformat
442
+ import os
443
+
444
+ # Use the existing html method to generate the HTML content
445
+ output_html = self.generate_html_report(css=None)
446
+ nb = nbf.new_notebook()
447
+
448
+ # Add a code cell that renders the HTML content
449
+ code_cell = nbf.new_code_cell(
450
+ f"""
451
+ from IPython.display import HTML, display
452
+ display(HTML('''{output_html}'''))
453
+ """
454
+ )
455
+ nb.cells.append(code_cell)
456
+
457
+ # Execute the notebook
458
+ ep = ExecutePreprocessor(timeout=600, kernel_name="python3")
459
+ ep.preprocess(nb, {"metadata": {"path": os.getcwd()}})
460
+
461
+ # After execution, clear the cell's source code
462
+ nb.cells[0].source = ""
463
+
464
+ return nb
465
+
466
+
467
+ if __name__ == "__main__":
468
+ import doctest
469
+
470
+ doctest.testmod(optionflags=doctest.ELLIPSIS)