edsl 0.1.39.dev2__py3-none-any.whl → 0.1.39.dev3__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 (334) hide show
  1. edsl/Base.py +332 -385
  2. edsl/BaseDiff.py +260 -260
  3. edsl/TemplateLoader.py +24 -24
  4. edsl/__init__.py +49 -57
  5. edsl/__version__.py +1 -1
  6. edsl/agents/Agent.py +867 -1079
  7. edsl/agents/AgentList.py +413 -551
  8. edsl/agents/Invigilator.py +233 -285
  9. edsl/agents/InvigilatorBase.py +270 -254
  10. edsl/agents/PromptConstructor.py +354 -252
  11. edsl/agents/__init__.py +3 -2
  12. edsl/agents/descriptors.py +99 -99
  13. edsl/agents/prompt_helpers.py +129 -129
  14. edsl/auto/AutoStudy.py +117 -117
  15. edsl/auto/StageBase.py +230 -230
  16. edsl/auto/StageGenerateSurvey.py +178 -178
  17. edsl/auto/StageLabelQuestions.py +125 -125
  18. edsl/auto/StagePersona.py +61 -61
  19. edsl/auto/StagePersonaDimensionValueRanges.py +88 -88
  20. edsl/auto/StagePersonaDimensionValues.py +74 -74
  21. edsl/auto/StagePersonaDimensions.py +69 -69
  22. edsl/auto/StageQuestions.py +73 -73
  23. edsl/auto/SurveyCreatorPipeline.py +21 -21
  24. edsl/auto/utilities.py +224 -224
  25. edsl/base/Base.py +279 -279
  26. edsl/config.py +157 -177
  27. edsl/conversation/Conversation.py +290 -290
  28. edsl/conversation/car_buying.py +58 -59
  29. edsl/conversation/chips.py +95 -95
  30. edsl/conversation/mug_negotiation.py +81 -81
  31. edsl/conversation/next_speaker_utilities.py +93 -93
  32. edsl/coop/PriceFetcher.py +54 -54
  33. edsl/coop/__init__.py +2 -2
  34. edsl/coop/coop.py +1028 -1090
  35. edsl/coop/utils.py +131 -131
  36. edsl/data/Cache.py +555 -562
  37. edsl/data/CacheEntry.py +233 -230
  38. edsl/data/CacheHandler.py +149 -170
  39. edsl/data/RemoteCacheSync.py +78 -78
  40. edsl/data/SQLiteDict.py +292 -292
  41. edsl/data/__init__.py +4 -5
  42. edsl/data/orm.py +10 -10
  43. edsl/data_transfer_models.py +73 -74
  44. edsl/enums.py +175 -195
  45. edsl/exceptions/BaseException.py +21 -21
  46. edsl/exceptions/__init__.py +54 -54
  47. edsl/exceptions/agents.py +42 -54
  48. edsl/exceptions/cache.py +5 -5
  49. edsl/exceptions/configuration.py +16 -16
  50. edsl/exceptions/coop.py +10 -10
  51. edsl/exceptions/data.py +14 -14
  52. edsl/exceptions/general.py +34 -34
  53. edsl/exceptions/jobs.py +33 -33
  54. edsl/exceptions/language_models.py +63 -63
  55. edsl/exceptions/prompts.py +15 -15
  56. edsl/exceptions/questions.py +91 -109
  57. edsl/exceptions/results.py +29 -29
  58. edsl/exceptions/scenarios.py +22 -29
  59. edsl/exceptions/surveys.py +37 -37
  60. edsl/inference_services/AnthropicService.py +87 -84
  61. edsl/inference_services/AwsBedrock.py +120 -118
  62. edsl/inference_services/AzureAI.py +217 -215
  63. edsl/inference_services/DeepInfraService.py +18 -18
  64. edsl/inference_services/GoogleService.py +148 -139
  65. edsl/inference_services/GroqService.py +20 -20
  66. edsl/inference_services/InferenceServiceABC.py +147 -80
  67. edsl/inference_services/InferenceServicesCollection.py +97 -122
  68. edsl/inference_services/MistralAIService.py +123 -120
  69. edsl/inference_services/OllamaService.py +18 -18
  70. edsl/inference_services/OpenAIService.py +224 -221
  71. edsl/inference_services/PerplexityService.py +163 -160
  72. edsl/inference_services/TestService.py +89 -92
  73. edsl/inference_services/TogetherAIService.py +170 -170
  74. edsl/inference_services/models_available_cache.py +118 -118
  75. edsl/inference_services/rate_limits_cache.py +25 -25
  76. edsl/inference_services/registry.py +41 -41
  77. edsl/inference_services/write_available.py +10 -10
  78. edsl/jobs/Answers.py +56 -43
  79. edsl/jobs/Jobs.py +898 -757
  80. edsl/jobs/JobsChecks.py +147 -172
  81. edsl/jobs/JobsPrompts.py +268 -270
  82. edsl/jobs/JobsRemoteInferenceHandler.py +239 -287
  83. edsl/jobs/__init__.py +1 -1
  84. edsl/jobs/buckets/BucketCollection.py +63 -104
  85. edsl/jobs/buckets/ModelBuckets.py +65 -65
  86. edsl/jobs/buckets/TokenBucket.py +251 -283
  87. edsl/jobs/interviews/Interview.py +661 -358
  88. edsl/jobs/interviews/InterviewExceptionCollection.py +99 -99
  89. edsl/jobs/interviews/InterviewExceptionEntry.py +186 -186
  90. edsl/jobs/interviews/InterviewStatistic.py +63 -63
  91. edsl/jobs/interviews/InterviewStatisticsCollection.py +25 -25
  92. edsl/jobs/interviews/InterviewStatusDictionary.py +78 -78
  93. edsl/jobs/interviews/InterviewStatusLog.py +92 -92
  94. edsl/jobs/interviews/ReportErrors.py +66 -66
  95. edsl/jobs/interviews/interview_status_enum.py +9 -9
  96. edsl/jobs/runners/JobsRunnerAsyncio.py +466 -421
  97. edsl/jobs/runners/JobsRunnerStatus.py +330 -330
  98. edsl/jobs/tasks/QuestionTaskCreator.py +242 -244
  99. edsl/jobs/tasks/TaskCreators.py +64 -64
  100. edsl/jobs/tasks/TaskHistory.py +450 -449
  101. edsl/jobs/tasks/TaskStatusLog.py +23 -23
  102. edsl/jobs/tasks/task_status_enum.py +163 -161
  103. edsl/jobs/tokens/InterviewTokenUsage.py +27 -27
  104. edsl/jobs/tokens/TokenUsage.py +34 -34
  105. edsl/language_models/KeyLookup.py +30 -0
  106. edsl/language_models/LanguageModel.py +668 -571
  107. edsl/language_models/ModelList.py +155 -153
  108. edsl/language_models/RegisterLanguageModelsMeta.py +184 -184
  109. edsl/language_models/__init__.py +3 -2
  110. edsl/language_models/fake_openai_call.py +15 -15
  111. edsl/language_models/fake_openai_service.py +61 -61
  112. edsl/language_models/registry.py +190 -180
  113. edsl/language_models/repair.py +156 -156
  114. edsl/language_models/unused/ReplicateBase.py +83 -0
  115. edsl/language_models/utilities.py +64 -65
  116. edsl/notebooks/Notebook.py +258 -263
  117. edsl/notebooks/__init__.py +1 -1
  118. edsl/prompts/Prompt.py +362 -352
  119. edsl/prompts/__init__.py +2 -2
  120. edsl/questions/AnswerValidatorMixin.py +289 -334
  121. edsl/questions/QuestionBase.py +664 -509
  122. edsl/questions/QuestionBaseGenMixin.py +161 -165
  123. edsl/questions/QuestionBasePromptsMixin.py +217 -221
  124. edsl/questions/QuestionBudget.py +227 -227
  125. edsl/questions/QuestionCheckBox.py +359 -359
  126. edsl/questions/QuestionExtract.py +182 -182
  127. edsl/questions/QuestionFreeText.py +114 -113
  128. edsl/questions/QuestionFunctional.py +166 -166
  129. edsl/questions/QuestionList.py +231 -229
  130. edsl/questions/QuestionMultipleChoice.py +286 -330
  131. edsl/questions/QuestionNumerical.py +153 -151
  132. edsl/questions/QuestionRank.py +324 -314
  133. edsl/questions/Quick.py +41 -41
  134. edsl/questions/RegisterQuestionsMeta.py +71 -71
  135. edsl/questions/ResponseValidatorABC.py +174 -200
  136. edsl/questions/SimpleAskMixin.py +73 -74
  137. edsl/questions/__init__.py +26 -27
  138. edsl/questions/compose_questions.py +98 -98
  139. edsl/questions/decorators.py +21 -21
  140. edsl/questions/derived/QuestionLikertFive.py +76 -76
  141. edsl/questions/derived/QuestionLinearScale.py +87 -90
  142. edsl/questions/derived/QuestionTopK.py +93 -93
  143. edsl/questions/derived/QuestionYesNo.py +82 -82
  144. edsl/questions/descriptors.py +413 -427
  145. edsl/questions/prompt_templates/question_budget.jinja +13 -13
  146. edsl/questions/prompt_templates/question_checkbox.jinja +32 -32
  147. edsl/questions/prompt_templates/question_extract.jinja +11 -11
  148. edsl/questions/prompt_templates/question_free_text.jinja +3 -3
  149. edsl/questions/prompt_templates/question_linear_scale.jinja +11 -11
  150. edsl/questions/prompt_templates/question_list.jinja +17 -17
  151. edsl/questions/prompt_templates/question_multiple_choice.jinja +33 -33
  152. edsl/questions/prompt_templates/question_numerical.jinja +36 -36
  153. edsl/questions/question_registry.py +177 -177
  154. edsl/questions/settings.py +12 -12
  155. edsl/questions/templates/budget/answering_instructions.jinja +7 -7
  156. edsl/questions/templates/budget/question_presentation.jinja +7 -7
  157. edsl/questions/templates/checkbox/answering_instructions.jinja +10 -10
  158. edsl/questions/templates/checkbox/question_presentation.jinja +22 -22
  159. edsl/questions/templates/extract/answering_instructions.jinja +7 -7
  160. edsl/questions/templates/likert_five/answering_instructions.jinja +10 -10
  161. edsl/questions/templates/likert_five/question_presentation.jinja +11 -11
  162. edsl/questions/templates/linear_scale/answering_instructions.jinja +5 -5
  163. edsl/questions/templates/linear_scale/question_presentation.jinja +5 -5
  164. edsl/questions/templates/list/answering_instructions.jinja +3 -3
  165. edsl/questions/templates/list/question_presentation.jinja +5 -5
  166. edsl/questions/templates/multiple_choice/answering_instructions.jinja +9 -9
  167. edsl/questions/templates/multiple_choice/question_presentation.jinja +11 -11
  168. edsl/questions/templates/numerical/answering_instructions.jinja +6 -6
  169. edsl/questions/templates/numerical/question_presentation.jinja +6 -6
  170. edsl/questions/templates/rank/answering_instructions.jinja +11 -11
  171. edsl/questions/templates/rank/question_presentation.jinja +15 -15
  172. edsl/questions/templates/top_k/answering_instructions.jinja +8 -8
  173. edsl/questions/templates/top_k/question_presentation.jinja +22 -22
  174. edsl/questions/templates/yes_no/answering_instructions.jinja +6 -6
  175. edsl/questions/templates/yes_no/question_presentation.jinja +11 -11
  176. edsl/results/CSSParameterizer.py +108 -108
  177. edsl/results/Dataset.py +424 -587
  178. edsl/results/DatasetExportMixin.py +731 -653
  179. edsl/results/DatasetTree.py +275 -295
  180. edsl/results/Result.py +465 -451
  181. edsl/results/Results.py +1165 -1172
  182. edsl/results/ResultsDBMixin.py +238 -0
  183. edsl/results/ResultsExportMixin.py +43 -45
  184. edsl/results/ResultsFetchMixin.py +33 -33
  185. edsl/results/ResultsGGMixin.py +121 -121
  186. edsl/results/ResultsToolsMixin.py +98 -98
  187. edsl/results/Selector.py +135 -145
  188. edsl/results/TableDisplay.py +198 -125
  189. edsl/results/__init__.py +2 -2
  190. edsl/results/table_display.css +77 -77
  191. edsl/results/tree_explore.py +115 -115
  192. edsl/scenarios/FileStore.py +632 -511
  193. edsl/scenarios/Scenario.py +601 -498
  194. edsl/scenarios/ScenarioHtmlMixin.py +64 -65
  195. edsl/scenarios/ScenarioJoin.py +127 -131
  196. edsl/scenarios/ScenarioList.py +1287 -1430
  197. edsl/scenarios/ScenarioListExportMixin.py +52 -45
  198. edsl/scenarios/ScenarioListPdfMixin.py +261 -239
  199. edsl/scenarios/__init__.py +4 -3
  200. edsl/shared.py +1 -1
  201. edsl/study/ObjectEntry.py +173 -173
  202. edsl/study/ProofOfWork.py +113 -113
  203. edsl/study/SnapShot.py +80 -80
  204. edsl/study/Study.py +528 -521
  205. edsl/study/__init__.py +4 -4
  206. edsl/surveys/DAG.py +148 -148
  207. edsl/surveys/Memory.py +31 -31
  208. edsl/surveys/MemoryPlan.py +244 -244
  209. edsl/surveys/Rule.py +326 -327
  210. edsl/surveys/RuleCollection.py +387 -385
  211. edsl/surveys/Survey.py +1801 -1229
  212. edsl/surveys/SurveyCSS.py +261 -273
  213. edsl/surveys/SurveyExportMixin.py +259 -259
  214. edsl/surveys/{SurveyFlowVisualization.py → SurveyFlowVisualizationMixin.py} +179 -181
  215. edsl/surveys/SurveyQualtricsImport.py +284 -284
  216. edsl/surveys/__init__.py +3 -5
  217. edsl/surveys/base.py +53 -53
  218. edsl/surveys/descriptors.py +56 -60
  219. edsl/surveys/instructions/ChangeInstruction.py +49 -48
  220. edsl/surveys/instructions/Instruction.py +65 -56
  221. edsl/surveys/instructions/InstructionCollection.py +77 -82
  222. edsl/templates/error_reporting/base.html +23 -23
  223. edsl/templates/error_reporting/exceptions_by_model.html +34 -34
  224. edsl/templates/error_reporting/exceptions_by_question_name.html +16 -16
  225. edsl/templates/error_reporting/exceptions_by_type.html +16 -16
  226. edsl/templates/error_reporting/interview_details.html +115 -115
  227. edsl/templates/error_reporting/interviews.html +19 -19
  228. edsl/templates/error_reporting/overview.html +4 -4
  229. edsl/templates/error_reporting/performance_plot.html +1 -1
  230. edsl/templates/error_reporting/report.css +73 -73
  231. edsl/templates/error_reporting/report.html +117 -117
  232. edsl/templates/error_reporting/report.js +25 -25
  233. edsl/tools/__init__.py +1 -1
  234. edsl/tools/clusters.py +192 -192
  235. edsl/tools/embeddings.py +27 -27
  236. edsl/tools/embeddings_plotting.py +118 -118
  237. edsl/tools/plotting.py +112 -112
  238. edsl/tools/summarize.py +18 -18
  239. edsl/utilities/SystemInfo.py +28 -28
  240. edsl/utilities/__init__.py +22 -22
  241. edsl/utilities/ast_utilities.py +25 -25
  242. edsl/utilities/data/Registry.py +6 -6
  243. edsl/utilities/data/__init__.py +1 -1
  244. edsl/utilities/data/scooter_results.json +1 -1
  245. edsl/utilities/decorators.py +77 -77
  246. edsl/utilities/gcp_bucket/cloud_storage.py +96 -96
  247. edsl/utilities/interface.py +627 -627
  248. edsl/utilities/naming_utilities.py +263 -263
  249. edsl/utilities/repair_functions.py +28 -28
  250. edsl/utilities/restricted_python.py +70 -70
  251. edsl/utilities/utilities.py +424 -436
  252. {edsl-0.1.39.dev2.dist-info → edsl-0.1.39.dev3.dist-info}/LICENSE +21 -21
  253. {edsl-0.1.39.dev2.dist-info → edsl-0.1.39.dev3.dist-info}/METADATA +10 -12
  254. edsl-0.1.39.dev3.dist-info/RECORD +277 -0
  255. edsl/agents/QuestionInstructionPromptBuilder.py +0 -128
  256. edsl/agents/QuestionOptionProcessor.py +0 -172
  257. edsl/agents/QuestionTemplateReplacementsBuilder.py +0 -137
  258. edsl/coop/CoopFunctionsMixin.py +0 -15
  259. edsl/coop/ExpectedParrotKeyHandler.py +0 -125
  260. edsl/exceptions/inference_services.py +0 -5
  261. edsl/inference_services/AvailableModelCacheHandler.py +0 -184
  262. edsl/inference_services/AvailableModelFetcher.py +0 -209
  263. edsl/inference_services/ServiceAvailability.py +0 -135
  264. edsl/inference_services/data_structures.py +0 -62
  265. edsl/jobs/AnswerQuestionFunctionConstructor.py +0 -188
  266. edsl/jobs/FetchInvigilator.py +0 -40
  267. edsl/jobs/InterviewTaskManager.py +0 -98
  268. edsl/jobs/InterviewsConstructor.py +0 -48
  269. edsl/jobs/JobsComponentConstructor.py +0 -189
  270. edsl/jobs/JobsRemoteInferenceLogger.py +0 -239
  271. edsl/jobs/RequestTokenEstimator.py +0 -30
  272. edsl/jobs/buckets/TokenBucketAPI.py +0 -211
  273. edsl/jobs/buckets/TokenBucketClient.py +0 -191
  274. edsl/jobs/decorators.py +0 -35
  275. edsl/jobs/jobs_status_enums.py +0 -9
  276. edsl/jobs/loggers/HTMLTableJobLogger.py +0 -304
  277. edsl/language_models/ComputeCost.py +0 -63
  278. edsl/language_models/PriceManager.py +0 -127
  279. edsl/language_models/RawResponseHandler.py +0 -106
  280. edsl/language_models/ServiceDataSources.py +0 -0
  281. edsl/language_models/key_management/KeyLookup.py +0 -63
  282. edsl/language_models/key_management/KeyLookupBuilder.py +0 -273
  283. edsl/language_models/key_management/KeyLookupCollection.py +0 -38
  284. edsl/language_models/key_management/__init__.py +0 -0
  285. edsl/language_models/key_management/models.py +0 -131
  286. edsl/notebooks/NotebookToLaTeX.py +0 -142
  287. edsl/questions/ExceptionExplainer.py +0 -77
  288. edsl/questions/HTMLQuestion.py +0 -103
  289. edsl/questions/LoopProcessor.py +0 -149
  290. edsl/questions/QuestionMatrix.py +0 -265
  291. edsl/questions/ResponseValidatorFactory.py +0 -28
  292. edsl/questions/templates/matrix/__init__.py +0 -1
  293. edsl/questions/templates/matrix/answering_instructions.jinja +0 -5
  294. edsl/questions/templates/matrix/question_presentation.jinja +0 -20
  295. edsl/results/MarkdownToDocx.py +0 -122
  296. edsl/results/MarkdownToPDF.py +0 -111
  297. edsl/results/TextEditor.py +0 -50
  298. edsl/results/smart_objects.py +0 -96
  299. edsl/results/table_data_class.py +0 -12
  300. edsl/results/table_renderers.py +0 -118
  301. edsl/scenarios/ConstructDownloadLink.py +0 -109
  302. edsl/scenarios/DirectoryScanner.py +0 -96
  303. edsl/scenarios/DocumentChunker.py +0 -102
  304. edsl/scenarios/DocxScenario.py +0 -16
  305. edsl/scenarios/PdfExtractor.py +0 -40
  306. edsl/scenarios/ScenarioSelector.py +0 -156
  307. edsl/scenarios/file_methods.py +0 -85
  308. edsl/scenarios/handlers/__init__.py +0 -13
  309. edsl/scenarios/handlers/csv.py +0 -38
  310. edsl/scenarios/handlers/docx.py +0 -76
  311. edsl/scenarios/handlers/html.py +0 -37
  312. edsl/scenarios/handlers/json.py +0 -111
  313. edsl/scenarios/handlers/latex.py +0 -5
  314. edsl/scenarios/handlers/md.py +0 -51
  315. edsl/scenarios/handlers/pdf.py +0 -68
  316. edsl/scenarios/handlers/png.py +0 -39
  317. edsl/scenarios/handlers/pptx.py +0 -105
  318. edsl/scenarios/handlers/py.py +0 -294
  319. edsl/scenarios/handlers/sql.py +0 -313
  320. edsl/scenarios/handlers/sqlite.py +0 -149
  321. edsl/scenarios/handlers/txt.py +0 -33
  322. edsl/surveys/ConstructDAG.py +0 -92
  323. edsl/surveys/EditSurvey.py +0 -221
  324. edsl/surveys/InstructionHandler.py +0 -100
  325. edsl/surveys/MemoryManagement.py +0 -72
  326. edsl/surveys/RuleManager.py +0 -172
  327. edsl/surveys/Simulator.py +0 -75
  328. edsl/surveys/SurveyToApp.py +0 -141
  329. edsl/utilities/PrettyList.py +0 -56
  330. edsl/utilities/is_notebook.py +0 -18
  331. edsl/utilities/is_valid_variable_name.py +0 -11
  332. edsl/utilities/remove_edsl_version.py +0 -24
  333. edsl-0.1.39.dev2.dist-info/RECORD +0 -352
  334. {edsl-0.1.39.dev2.dist-info → edsl-0.1.39.dev3.dist-info}/WHEEL +0 -0
@@ -1,63 +1,63 @@
1
- import asyncio
2
- from enum import Enum
3
- from typing import Literal, List, Type, DefaultDict
4
- from collections import UserDict, defaultdict
5
-
6
- from edsl.jobs.interviews.InterviewStatusDictionary import InterviewStatusDictionary
7
- from edsl.jobs.tokens.InterviewTokenUsage import InterviewTokenUsage
8
- from edsl.enums import pricing, TokenPricing
9
- from edsl.jobs.tasks.task_status_enum import TaskStatus
10
-
11
- InterviewTokenUsageMapping = DefaultDict[str, InterviewTokenUsage]
12
-
13
-
14
- class InterviewStatistic(UserDict):
15
- @staticmethod
16
- def _format_number(number, digits=0, units=""):
17
- """Format a number.
18
-
19
- :param number: the number to format
20
- :param digits: the number of digits to display
21
- :param units: the units to display
22
-
23
- Example usage:
24
-
25
- >>> InterviewStatistic._format_number(1000, 1, "sec.")
26
- '1,000.0 sec.'
27
- """
28
- if type(number) == str:
29
- return number
30
- else:
31
- return f"{number:,.{digits}f}" + " " + units
32
-
33
- @property
34
- def _pretty_name(self):
35
- """Return a pretty name for the statistic.
36
-
37
- Example usage:
38
-
39
- >>> InterviewStatistic("elapsed_time", value=100, digits=1, units="sec.").pretty_name
40
- 'Elapsed time'
41
- """
42
- return self.name.replace("_", " ").capitalize()
43
-
44
- def __init__(
45
- self,
46
- name: str,
47
- value: float,
48
- digits: int = 0,
49
- units: str = "",
50
- pretty_name: str = None,
51
- ):
52
- """Create a new InterviewStatistic object."""
53
- self.name = name
54
- self.value = value
55
- self.digits = digits
56
- self.units = units
57
- self.pretty_name = pretty_name or self._pretty_name
58
-
59
- super().__init__(
60
- {self.pretty_name: self._format_number(self.value, self.digits, self.units)}
61
- )
62
-
63
- self.raw: dict = {self.name: self.value}
1
+ import asyncio
2
+ from enum import Enum
3
+ from typing import Literal, List, Type, DefaultDict
4
+ from collections import UserDict, defaultdict
5
+
6
+ from edsl.jobs.interviews.InterviewStatusDictionary import InterviewStatusDictionary
7
+ from edsl.jobs.tokens.InterviewTokenUsage import InterviewTokenUsage
8
+ from edsl.enums import pricing, TokenPricing
9
+ from edsl.jobs.tasks.task_status_enum import TaskStatus
10
+
11
+ InterviewTokenUsageMapping = DefaultDict[str, InterviewTokenUsage]
12
+
13
+
14
+ class InterviewStatistic(UserDict):
15
+ @staticmethod
16
+ def _format_number(number, digits=0, units=""):
17
+ """Format a number.
18
+
19
+ :param number: the number to format
20
+ :param digits: the number of digits to display
21
+ :param units: the units to display
22
+
23
+ Example usage:
24
+
25
+ >>> InterviewStatistic._format_number(1000, 1, "sec.")
26
+ '1,000.0 sec.'
27
+ """
28
+ if type(number) == str:
29
+ return number
30
+ else:
31
+ return f"{number:,.{digits}f}" + " " + units
32
+
33
+ @property
34
+ def _pretty_name(self):
35
+ """Return a pretty name for the statistic.
36
+
37
+ Example usage:
38
+
39
+ >>> InterviewStatistic("elapsed_time", value=100, digits=1, units="sec.").pretty_name
40
+ 'Elapsed time'
41
+ """
42
+ return self.name.replace("_", " ").capitalize()
43
+
44
+ def __init__(
45
+ self,
46
+ name: str,
47
+ value: float,
48
+ digits: int = 0,
49
+ units: str = "",
50
+ pretty_name: str = None,
51
+ ):
52
+ """Create a new InterviewStatistic object."""
53
+ self.name = name
54
+ self.value = value
55
+ self.digits = digits
56
+ self.units = units
57
+ self.pretty_name = pretty_name or self._pretty_name
58
+
59
+ super().__init__(
60
+ {self.pretty_name: self._format_number(self.value, self.digits, self.units)}
61
+ )
62
+
63
+ self.raw: dict = {self.name: self.value}
@@ -1,25 +1,25 @@
1
- from collections import UserDict
2
- from edsl.jobs.interviews.InterviewStatistic import InterviewStatistic
3
-
4
-
5
- class InterviewStatisticsCollection(UserDict):
6
- """A collection of interview statistics."""
7
-
8
- def __init__(self, *args, **kwargs):
9
- super().__init__(*args, **kwargs)
10
- self.raw: dict = {}
11
-
12
- def add_stat(self, statistic: InterviewStatistic):
13
- """Add a statistic to the collection.
14
-
15
- Each statistic is a dictionary with a single key-value pair.
16
-
17
- Example usage:
18
-
19
- >>> isc = InterviewStatisticsCollection()
20
- >>> isc.add_stat(InterviewStatistic("elapsed_time", value=100, digits=1, units="sec."))
21
- >>> isc.raw
22
- {'elapsed_time': 100}
23
- """
24
- self.update(statistic)
25
- self.raw.update(statistic.raw)
1
+ from collections import UserDict
2
+ from edsl.jobs.interviews.InterviewStatistic import InterviewStatistic
3
+
4
+
5
+ class InterviewStatisticsCollection(UserDict):
6
+ """A collection of interview statistics."""
7
+
8
+ def __init__(self, *args, **kwargs):
9
+ super().__init__(*args, **kwargs)
10
+ self.raw: dict = {}
11
+
12
+ def add_stat(self, statistic: InterviewStatistic):
13
+ """Add a statistic to the collection.
14
+
15
+ Each statistic is a dictionary with a single key-value pair.
16
+
17
+ Example usage:
18
+
19
+ >>> isc = InterviewStatisticsCollection()
20
+ >>> isc.add_stat(InterviewStatistic("elapsed_time", value=100, digits=1, units="sec."))
21
+ >>> isc.raw
22
+ {'elapsed_time': 100}
23
+ """
24
+ self.update(statistic)
25
+ self.raw.update(statistic.raw)
@@ -1,78 +1,78 @@
1
- from __future__ import annotations
2
- import json
3
- from collections import UserDict
4
- from typing import Union, Dict
5
-
6
- from edsl.jobs.tasks.task_status_enum import TaskStatus, get_enum_from_string
7
-
8
-
9
- class InterviewStatusDictionary(UserDict):
10
- """A dictionary that keeps track of the status of all the tasks in an interview."""
11
-
12
- def __init__(self, data: Union[Dict[TaskStatus, int], None] = None):
13
- if data:
14
- # checks to make sure every task status is in the enum
15
- assert all([task_status in data for task_status in TaskStatus])
16
- super().__init__(data)
17
- else:
18
- # sets all the task statuses to 0
19
- d = {}
20
- for task_status in TaskStatus:
21
- d[task_status] = 0
22
- d["number_from_cache"] = 0
23
- super().__init__(d)
24
-
25
- def __add__(
26
- self, other: "InterviewStatusDictionary"
27
- ) -> "InterviewStatusDictionary":
28
- """Adds two InterviewStatusDictionaries together."""
29
- if not isinstance(other, InterviewStatusDictionary):
30
- raise ValueError(f"Can't add {type(other)} to InterviewStatusDictionary")
31
- new_dict = {}
32
- for key in self.keys():
33
- new_dict[key] = self[key] + other[key]
34
- return InterviewStatusDictionary(new_dict)
35
-
36
- @property
37
- def waiting(self) -> int:
38
- """Return the number of tasks that are in a waiting status of some kind."""
39
-
40
- waiting_status_list = [
41
- TaskStatus.WAITING_FOR_REQUEST_CAPACITY,
42
- TaskStatus.WAITING_FOR_TOKEN_CAPACITY,
43
- TaskStatus.WAITING_FOR_DEPENDENCIES,
44
- ]
45
-
46
- return sum([self[status] for status in waiting_status_list])
47
-
48
- def __repr__(self):
49
- return f"InterviewStatusDictionary({self.data})"
50
-
51
- def to_dict(self):
52
- new_data = {str(key): value for key, value in self.data.items()}
53
- return new_data
54
-
55
- def print(self):
56
- d = {}
57
- for key, value in self.data.items():
58
- d[str(key)] = value
59
- from edsl.utilities.interface import print_dict_with_rich
60
-
61
- print_dict_with_rich(d)
62
-
63
- @classmethod
64
- def from_dict(cls, data):
65
- new_data = {get_enum_from_string(key): value for key, value in data.items()}
66
- return cls(new_data)
67
-
68
- def to_json(self):
69
- import json
70
-
71
- return json.dumps(self.to_dict())
72
-
73
- @classmethod
74
- def from_json(cls, data):
75
- import json
76
-
77
- data = json.loads(data)
78
- return cls.from_dict(data)
1
+ from __future__ import annotations
2
+ import json
3
+ from collections import UserDict
4
+ from typing import Union, Dict
5
+
6
+ from edsl.jobs.tasks.task_status_enum import TaskStatus, get_enum_from_string
7
+
8
+
9
+ class InterviewStatusDictionary(UserDict):
10
+ """A dictionary that keeps track of the status of all the tasks in an interview."""
11
+
12
+ def __init__(self, data: Union[Dict[TaskStatus, int], None] = None):
13
+ if data:
14
+ # checks to make sure every task status is in the enum
15
+ assert all([task_status in data for task_status in TaskStatus])
16
+ super().__init__(data)
17
+ else:
18
+ # sets all the task statuses to 0
19
+ d = {}
20
+ for task_status in TaskStatus:
21
+ d[task_status] = 0
22
+ d["number_from_cache"] = 0
23
+ super().__init__(d)
24
+
25
+ def __add__(
26
+ self, other: "InterviewStatusDictionary"
27
+ ) -> "InterviewStatusDictionary":
28
+ """Adds two InterviewStatusDictionaries together."""
29
+ if not isinstance(other, InterviewStatusDictionary):
30
+ raise ValueError(f"Can't add {type(other)} to InterviewStatusDictionary")
31
+ new_dict = {}
32
+ for key in self.keys():
33
+ new_dict[key] = self[key] + other[key]
34
+ return InterviewStatusDictionary(new_dict)
35
+
36
+ @property
37
+ def waiting(self) -> int:
38
+ """Return the number of tasks that are in a waiting status of some kind."""
39
+
40
+ waiting_status_list = [
41
+ TaskStatus.WAITING_FOR_REQUEST_CAPACITY,
42
+ TaskStatus.WAITING_FOR_TOKEN_CAPACITY,
43
+ TaskStatus.WAITING_FOR_DEPENDENCIES,
44
+ ]
45
+
46
+ return sum([self[status] for status in waiting_status_list])
47
+
48
+ def __repr__(self):
49
+ return f"InterviewStatusDictionary({self.data})"
50
+
51
+ def to_dict(self):
52
+ new_data = {str(key): value for key, value in self.data.items()}
53
+ return new_data
54
+
55
+ def print(self):
56
+ d = {}
57
+ for key, value in self.data.items():
58
+ d[str(key)] = value
59
+ from edsl.utilities.interface import print_dict_with_rich
60
+
61
+ print_dict_with_rich(d)
62
+
63
+ @classmethod
64
+ def from_dict(cls, data):
65
+ new_data = {get_enum_from_string(key): value for key, value in data.items()}
66
+ return cls(new_data)
67
+
68
+ def to_json(self):
69
+ import json
70
+
71
+ return json.dumps(self.to_dict())
72
+
73
+ @classmethod
74
+ def from_json(cls, data):
75
+ import json
76
+
77
+ data = json.loads(data)
78
+ return cls.from_dict(data)
@@ -1,92 +1,92 @@
1
- from collections import UserDict
2
-
3
- from edsl.jobs.tasks.task_status_enum import TaskStatus, status_colors
4
-
5
-
6
- class InterviewStatusLog(UserDict):
7
- """A dictionary of TaskStatusLog objects.
8
-
9
- The key is the name of the task.
10
- """
11
-
12
- @property
13
- def min_time(self):
14
- return min([log.min_time for log in self.values()])
15
-
16
- @property
17
- def max_time(self):
18
- return max([log.max_time for log in self.values()])
19
-
20
- def status_matrix(self, num_periods):
21
- """Return a matrix of status values."""
22
- start_time = self.min_time
23
- end_time = self.max_time
24
- time_increment = (end_time - start_time) / num_periods
25
- status_matrix = {}
26
- time_periods = [start_time + i * time_increment for i in range(num_periods)]
27
- for task_name, log in self.items():
28
- status_matrix[task_name] = [log.status_at_time(t) for t in time_periods]
29
- return status_matrix
30
-
31
- def numerical_matrix(self, num_periods):
32
- """Return a numerical matrix of status values."""
33
- status_dicts = self.status_matrix(num_periods)
34
-
35
- num_cols = num_periods
36
- num_rows = len(status_dicts)
37
- matrix = [[0 for _ in range(num_cols)] for _ in range(num_rows)]
38
-
39
- for row_index, (task_name, status_list) in enumerate(status_dicts.items()):
40
- matrix[row_index] = [
41
- list(status_colors.keys()).index(status) for status in status_list
42
- ]
43
-
44
- index_to_names = {i: name for i, name in enumerate(status_dicts.keys())}
45
- return matrix, index_to_names
46
-
47
- def visualize(self, num_periods=10):
48
- """Visualize the status matrix with outlined squares."""
49
- import matplotlib.pyplot as plt
50
- from matplotlib.colors import ListedColormap
51
- import numpy as np
52
- from matplotlib.patches import Rectangle
53
-
54
- # Define your custom colormap
55
- custom_cmap = ListedColormap(list(status_colors.values()))
56
-
57
- # Generate the matrix
58
- matrix, index_to_names = self.numerical_matrix(num_periods)
59
-
60
- # Create the figure and axes
61
- plt.figure(figsize=(10, 5))
62
- ax = plt.gca()
63
-
64
- # Display the matrix and keep a reference to the imshow object
65
- im = ax.imshow(matrix, aspect="auto", cmap=custom_cmap)
66
-
67
- # Adding color bar, now correctly associating it with 'im'
68
- cbar = plt.colorbar(im, ticks=range(len(status_colors)), label="Task Status")
69
-
70
- cbar_labels = [status.name for status in status_colors.keys()]
71
- # breakpoint()
72
- cbar.set_ticklabels(cbar_labels) # Setting the custom labels for the colorbar
73
-
74
- im.set_clim(
75
- -0.5, len(status_colors) - 0.5
76
- ) # Setting color limits directly on the imshow object
77
-
78
- # Outline each cell by drawing rectangles
79
- for (j, i), val in np.ndenumerate(matrix):
80
- ax.add_patch(
81
- Rectangle(
82
- (i - 0.5, j - 0.5), 1, 1, fill=False, edgecolor="black", lw=0.5
83
- )
84
- )
85
-
86
- # Set custom y-axis ticks and labels
87
- yticks = list(index_to_names.keys())
88
- yticklabels = list(index_to_names.values())
89
- plt.yticks(ticks=yticks, labels=yticklabels)
90
-
91
- # Show the plot
92
- plt.show()
1
+ from collections import UserDict
2
+
3
+ from edsl.jobs.tasks.task_status_enum import TaskStatus, status_colors
4
+
5
+
6
+ class InterviewStatusLog(UserDict):
7
+ """A dictionary of TaskStatusLog objects.
8
+
9
+ The key is the name of the task.
10
+ """
11
+
12
+ @property
13
+ def min_time(self):
14
+ return min([log.min_time for log in self.values()])
15
+
16
+ @property
17
+ def max_time(self):
18
+ return max([log.max_time for log in self.values()])
19
+
20
+ def status_matrix(self, num_periods):
21
+ """Return a matrix of status values."""
22
+ start_time = self.min_time
23
+ end_time = self.max_time
24
+ time_increment = (end_time - start_time) / num_periods
25
+ status_matrix = {}
26
+ time_periods = [start_time + i * time_increment for i in range(num_periods)]
27
+ for task_name, log in self.items():
28
+ status_matrix[task_name] = [log.status_at_time(t) for t in time_periods]
29
+ return status_matrix
30
+
31
+ def numerical_matrix(self, num_periods):
32
+ """Return a numerical matrix of status values."""
33
+ status_dicts = self.status_matrix(num_periods)
34
+
35
+ num_cols = num_periods
36
+ num_rows = len(status_dicts)
37
+ matrix = [[0 for _ in range(num_cols)] for _ in range(num_rows)]
38
+
39
+ for row_index, (task_name, status_list) in enumerate(status_dicts.items()):
40
+ matrix[row_index] = [
41
+ list(status_colors.keys()).index(status) for status in status_list
42
+ ]
43
+
44
+ index_to_names = {i: name for i, name in enumerate(status_dicts.keys())}
45
+ return matrix, index_to_names
46
+
47
+ def visualize(self, num_periods=10):
48
+ """Visualize the status matrix with outlined squares."""
49
+ import matplotlib.pyplot as plt
50
+ from matplotlib.colors import ListedColormap
51
+ import numpy as np
52
+ from matplotlib.patches import Rectangle
53
+
54
+ # Define your custom colormap
55
+ custom_cmap = ListedColormap(list(status_colors.values()))
56
+
57
+ # Generate the matrix
58
+ matrix, index_to_names = self.numerical_matrix(num_periods)
59
+
60
+ # Create the figure and axes
61
+ plt.figure(figsize=(10, 5))
62
+ ax = plt.gca()
63
+
64
+ # Display the matrix and keep a reference to the imshow object
65
+ im = ax.imshow(matrix, aspect="auto", cmap=custom_cmap)
66
+
67
+ # Adding color bar, now correctly associating it with 'im'
68
+ cbar = plt.colorbar(im, ticks=range(len(status_colors)), label="Task Status")
69
+
70
+ cbar_labels = [status.name for status in status_colors.keys()]
71
+ # breakpoint()
72
+ cbar.set_ticklabels(cbar_labels) # Setting the custom labels for the colorbar
73
+
74
+ im.set_clim(
75
+ -0.5, len(status_colors) - 0.5
76
+ ) # Setting color limits directly on the imshow object
77
+
78
+ # Outline each cell by drawing rectangles
79
+ for (j, i), val in np.ndenumerate(matrix):
80
+ ax.add_patch(
81
+ Rectangle(
82
+ (i - 0.5, j - 0.5), 1, 1, fill=False, edgecolor="black", lw=0.5
83
+ )
84
+ )
85
+
86
+ # Set custom y-axis ticks and labels
87
+ yticks = list(index_to_names.keys())
88
+ yticklabels = list(index_to_names.values())
89
+ plt.yticks(ticks=yticks, labels=yticklabels)
90
+
91
+ # Show the plot
92
+ plt.show()
@@ -1,66 +1,66 @@
1
- import json
2
- import requests
3
- import threading
4
- from edsl.coop import Coop
5
-
6
-
7
- class ReportErrors:
8
- def __init__(self, task_history):
9
- self.task_history = task_history
10
- self.email = None
11
-
12
- @property
13
- def data(self):
14
- return {
15
- "text": self.task_history.to_dict(),
16
- "email": self.email,
17
- }
18
-
19
- def get_email(self, timeout=10):
20
- """Helper method to get user input with a timeout."""
21
- input_queue = []
22
-
23
- def input_thread_method():
24
- email_input = input(
25
- "Please enter your email address (if you want us to get in touch): "
26
- )
27
- input_queue.append(email_input)
28
-
29
- input_thread = threading.Thread(target=input_thread_method)
30
- input_thread.start()
31
- input_thread.join(timeout=timeout)
32
-
33
- if input_queue:
34
- self.email = input_queue[0]
35
- else:
36
- print("No input received within the timeout period.")
37
-
38
- def upload(self):
39
- # The previous implementation was removed because it relied on the old Coop ErrorModel
40
- pass
41
-
42
-
43
- def main():
44
- from edsl.jobs.interviews.ReportErrors import ReportErrors
45
-
46
- class TaskHistory:
47
- def __init__(self, data):
48
- self.data = data
49
-
50
- def to_dict(self):
51
- """Converts the internal data of the task history to a dictionary format."""
52
- return self.data
53
-
54
- task_history_data = {
55
- "task": "Example Task",
56
- "status": "Completed",
57
- "details": "This is an example of a task history.",
58
- }
59
- task_history = TaskHistory(task_history_data)
60
-
61
- reporter = ReportErrors(task_history)
62
- # one without email
63
- reporter.upload()
64
- # one with email
65
- reporter.email = "fake@gmail.com"
66
- reporter.upload()
1
+ import json
2
+ import requests
3
+ import threading
4
+ from edsl.coop import Coop
5
+
6
+
7
+ class ReportErrors:
8
+ def __init__(self, task_history):
9
+ self.task_history = task_history
10
+ self.email = None
11
+
12
+ @property
13
+ def data(self):
14
+ return {
15
+ "text": self.task_history.to_dict(),
16
+ "email": self.email,
17
+ }
18
+
19
+ def get_email(self, timeout=10):
20
+ """Helper method to get user input with a timeout."""
21
+ input_queue = []
22
+
23
+ def input_thread_method():
24
+ email_input = input(
25
+ "Please enter your email address (if you want us to get in touch): "
26
+ )
27
+ input_queue.append(email_input)
28
+
29
+ input_thread = threading.Thread(target=input_thread_method)
30
+ input_thread.start()
31
+ input_thread.join(timeout=timeout)
32
+
33
+ if input_queue:
34
+ self.email = input_queue[0]
35
+ else:
36
+ print("No input received within the timeout period.")
37
+
38
+ def upload(self):
39
+ # The previous implementation was removed because it relied on the old Coop ErrorModel
40
+ pass
41
+
42
+
43
+ def main():
44
+ from edsl.jobs.interviews.ReportErrors import ReportErrors
45
+
46
+ class TaskHistory:
47
+ def __init__(self, data):
48
+ self.data = data
49
+
50
+ def to_dict(self):
51
+ """Converts the internal data of the task history to a dictionary format."""
52
+ return self.data
53
+
54
+ task_history_data = {
55
+ "task": "Example Task",
56
+ "status": "Completed",
57
+ "details": "This is an example of a task history.",
58
+ }
59
+ task_history = TaskHistory(task_history_data)
60
+
61
+ reporter = ReportErrors(task_history)
62
+ # one without email
63
+ reporter.upload()
64
+ # one with email
65
+ reporter.email = "fake@gmail.com"
66
+ reporter.upload()
@@ -1,9 +1,9 @@
1
- import enum
2
-
3
-
4
- class InterviewStatus(enum.Enum):
5
- "These are the possible states an interview can be in."
6
- NOT_STARTED = enum.auto()
7
- SUCCESS = enum.auto()
8
- WAITING_FOR_RESOURCES = enum.auto()
9
- FAILED = enum.auto()
1
+ import enum
2
+
3
+
4
+ class InterviewStatus(enum.Enum):
5
+ "These are the possible states an interview can be in."
6
+ NOT_STARTED = enum.auto()
7
+ SUCCESS = enum.auto()
8
+ WAITING_FOR_RESOURCES = enum.auto()
9
+ FAILED = enum.auto()