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,73 +1,74 @@
1
- from dataclasses import dataclass
2
- from typing import List
3
- from textwrap import dedent
4
-
5
-
6
- from edsl import Scenario
7
- from edsl import Model
8
- from edsl.questions.QuestionList import QuestionList
9
-
10
- from edsl.auto.StageBase import StageBase
11
- from edsl.auto.StageBase import FlowDataBase
12
-
13
- from edsl.auto.utilities import gen_pipeline
14
-
15
-
16
- class StageQuestions(StageBase):
17
- "This stages takes as input an overall question and returns a list of questions"
18
-
19
- @dataclass
20
- class Input(FlowDataBase):
21
- overall_question: str
22
- population: str
23
-
24
- @dataclass
25
- class Output(FlowDataBase):
26
- questions: List[str]
27
- population: str
28
-
29
- input = Input
30
- output = Output
31
-
32
- def handle_data(self, data):
33
- m = Model()
34
- overall_question = data.overall_question
35
- population = data.population
36
- s = Scenario({"overall_question": overall_question, "population": population})
37
- q = QuestionList(
38
- question_text=dedent(
39
- """\
40
- Suppose I am interested in the question:
41
- "{{ overall_question }}"
42
- What would be some survey questions I could ask to {{ population }} that might shed light on this question?
43
- """
44
- ),
45
- question_name="questions",
46
- )
47
- results = q.by(s).by(m).run()
48
- (
49
- results.select("questions").print(
50
- pretty_labels={
51
- "answer.questions": f'Questions for overall question: "{overall_question }"'
52
- },
53
- split_at_dot=False,
54
- )
55
- )
56
-
57
- raw_questions = results.select("questions").first()
58
- questions = [q.replace("'", "").replace(":", "") for q in raw_questions]
59
- return self.Output(questions=questions, population=population)
60
-
61
-
62
- if __name__ == "__main__":
63
- pipeline = gen_pipeline([StageQuestions])
64
-
65
- pipeline.process(
66
- pipeline.input(
67
- overall_question="What are some factors that could determine whether someone likes ice cream?",
68
- population="Consumers",
69
- )
70
- )
71
- StageQuestions.func(
72
- overall_question="Why aren't my students studying more?", population="Tech"
73
- )
1
+ from dataclasses import dataclass
2
+ from typing import List
3
+ from textwrap import dedent
4
+
5
+
6
+ from edsl import Scenario
7
+ from edsl import Model
8
+ from edsl.questions.QuestionList import QuestionList
9
+
10
+ from edsl.auto.StageBase import StageBase
11
+ from edsl.auto.StageBase import FlowDataBase
12
+
13
+ from edsl.auto.utilities import gen_pipeline
14
+
15
+
16
+ class StageQuestions(StageBase):
17
+ "This stages takes as input an overall question and returns a list of questions"
18
+
19
+ @dataclass
20
+ class Input(FlowDataBase):
21
+ overall_question: str
22
+ population: str
23
+
24
+ @dataclass
25
+ class Output(FlowDataBase):
26
+ questions: List[str]
27
+ population: str
28
+
29
+ input = Input
30
+ output = Output
31
+
32
+ def handle_data(self, data):
33
+ m = Model()
34
+ overall_question = data.overall_question
35
+ population = data.population
36
+ s = Scenario({"overall_question": overall_question, "population": population})
37
+ q = QuestionList(
38
+ question_text=dedent(
39
+ """\
40
+ Suppose I am interested in the question:
41
+ "{{ overall_question }}"
42
+ What would be some survey questions I could ask to {{ population }} that might shed light on this question?
43
+ """
44
+ ),
45
+ question_name="questions",
46
+ )
47
+ results = q.by(s).by(m).run()
48
+ (
49
+ results.select("questions").print(
50
+ pretty_labels={
51
+ "answer.questions": f'Questions for overall question: "{overall_question }"'
52
+ },
53
+ split_at_dot=False,
54
+ )
55
+ )
56
+
57
+ raw_questions = results.select("questions").first()
58
+ questions = [q.replace("'", "").replace(":", "") for q in raw_questions]
59
+ return self.Output(questions=questions, population=population)
60
+
61
+
62
+ if __name__ == "__main__":
63
+ pipeline = gen_pipeline([StageQuestions])
64
+
65
+ pipeline.process(
66
+ pipeline.input(
67
+ overall_question="What are some factors that could determine whether someone likes ice cream?",
68
+ population="Consumers",
69
+ )
70
+ )
71
+
72
+ results = StageQuestions.func(
73
+ overall_question="Why aren't my students studying more?", population="Tech"
74
+ )
@@ -1,21 +1,21 @@
1
- import random
2
- from typing import Dict, List, Any, TypeVar, Generator, Optional
3
-
4
- from textwrap import dedent
5
-
6
- # from edsl.language_models.model_interfaces.LanguageModelOpenAIFour import LanguageModelOpenAIFour
7
- from edsl import Model
8
- from edsl.agents.AgentList import AgentList
9
- from edsl.results.Results import Results
10
- from edsl import Agent
11
-
12
- from edsl import Scenario
13
- from edsl.surveys.Survey import Survey
14
-
15
- from edsl.questions.QuestionMultipleChoice import QuestionMultipleChoice
16
- from edsl.questions.QuestionFreeText import QuestionFreeText
17
- from edsl.auto.utilities import gen_pipeline
18
- from edsl.utilities.naming_utilities import sanitize_string
19
-
20
-
21
- m = Model()
1
+ import random
2
+ from typing import Dict, List, Any, TypeVar, Generator, Optional
3
+
4
+ from textwrap import dedent
5
+
6
+ # from edsl.language_models.model_interfaces.LanguageModelOpenAIFour import LanguageModelOpenAIFour
7
+ from edsl import Model
8
+ from edsl.agents.AgentList import AgentList
9
+ from edsl.results.Results import Results
10
+ from edsl import Agent
11
+
12
+ from edsl import Scenario
13
+ from edsl.surveys.Survey import Survey
14
+
15
+ from edsl.questions.QuestionMultipleChoice import QuestionMultipleChoice
16
+ from edsl.questions.QuestionFreeText import QuestionFreeText
17
+ from edsl.auto.utilities import gen_pipeline
18
+ from edsl.utilities.naming_utilities import sanitize_string
19
+
20
+
21
+ m = Model()
edsl/auto/utilities.py CHANGED
@@ -1,224 +1,218 @@
1
- from textwrap import dedent
2
- import random
3
- from typing import List, TypeVar, Generator, Optional
4
- from edsl.auto.StageBase import StageBase
5
- from edsl.utilities.naming_utilities import sanitize_string
6
- from edsl import Agent, Survey, Model, Cache, AgentList
7
- from edsl import QuestionFreeText, Scenario
8
- from edsl import QuestionMultipleChoice, Scenario, Agent, ScenarioList
9
-
10
- StageClassType = TypeVar("StageClassType", bound=StageBase)
11
-
12
-
13
- def gen_pipeline(stages_list: List[StageClassType]) -> StageBase:
14
- """Takes as input a list of Stage classes & returns a pipeline of instantiated stages.
15
- A pipeline is a linked list of stages where each stage has a next_stage attribute.
16
-
17
- """
18
- pipeline = stages_list[0]()
19
- last_stage = pipeline
20
- for stage in stages_list[1:]:
21
- while last_stage.next_stage is not None: # find the end of the pipeline
22
- last_stage = last_stage.next_stage
23
- stage_to_add = stage()
24
- last_stage.next_stage = stage_to_add
25
- return pipeline
26
-
27
-
28
- q_eligibility = QuestionMultipleChoice(
29
- question_text=dedent(
30
- """\
31
- Consider this set of question: '{{ questions }}'.
32
- Consider this persona: '{{ persona }}'.
33
- Would this persona be able to answer all of these questions?
34
- """
35
- ),
36
- question_options=["No", "Yes"],
37
- question_name="eligibility",
38
- )
39
-
40
-
41
- def agent_list_eligibility(
42
- agent_list: AgentList,
43
- survey: Optional[Survey] = None,
44
- model: Optional[Model] = None,
45
- cache: Optional[Cache] = None,
46
- ) -> List[bool]:
47
- """
48
- Returns whether each agent in a list is elgible for a survey i.e., can answer every question.
49
-
50
- >>> from edsl.language_models import LanguageModel
51
- >>> m = LanguageModel.example(canned_response = "1", test_model = True)
52
- >>> agent_list_eligibility(AgentList.example())
53
- [True, True]
54
- >>> agent_list_eligibility(AgentList.example().add_trait('persona', 2*["Cool dude"]), survey = Survey.example(), model = m)
55
- [True, True]
56
- """
57
- if survey is None:
58
- return [True] * len(agent_list)
59
- if "persona" not in agent_list.all_traits:
60
- raise ValueError(
61
- f"Each agent needs to have a persona attribute; traits are {agent_list.all_traits}"
62
- )
63
- sl = agent_list.select("persona").to_scenario_list()
64
- sl.add_value("questions", [q.question_text for q in survey._questions])
65
- results = q_eligibility.by(sl).by(model).run(cache=cache)
66
- return [r == "Yes" for r in results.select("eligibility").to_list()]
67
-
68
-
69
- def agent_eligibility(
70
- agent: Agent,
71
- survey: Survey,
72
- model: Optional[Model] = None,
73
- cache: Optional[Cache] = None,
74
- ) -> bool:
75
- """NB: This could be parallelized.
76
-
77
- >>> from edsl.language_models import LanguageModel
78
- >>> m = LanguageModel.example(canned_response = "1", test_model = True)
79
- >>> agent_eligibility(agent = Agent.example().add_trait({'persona': "Persona"}), survey = Survey.example(), model = m)
80
- True
81
-
82
- """
83
- model = model or Model()
84
-
85
- questions = [q.question_text for q in survey._questions]
86
- persona = agent.traits["persona"]
87
- return (
88
- q_eligibility(model=model, questions=questions, persona=persona, cache=cache)
89
- == "Yes"
90
- )
91
- # results = (
92
- # q.by(model)
93
- # .by(Scenario({"questions": questions, "persona": persona}))
94
- # .run(cache=cache)
95
- # )
96
- # return results.select("eligibility").first() == "Yes"
97
-
98
-
99
- def gen_agent_traits(dimension_dict: dict, seed_value: Optional[str] = None):
100
- """
101
- >>> dimension_dict = {'attitude':['positive', 'negative']}
102
- >>> ag = gen_agent_traits(dimension_dict)
103
- >>> a = next(ag)
104
- >>> a == {'attitude': 'positive'} or a == {'attitude': 'negative'}
105
- True
106
- >>> len([next(ag) for _ in range(100)])
107
- 100
108
- """
109
- if seed_value is None:
110
- seed_value = "edsl"
111
-
112
- random.seed(seed_value)
113
-
114
- while True:
115
- new_agent_traits = {}
116
- for key, list_of_values in dimension_dict.items():
117
- new_agent_traits[key] = random.choice(list_of_values)
118
- yield new_agent_traits
119
-
120
-
121
- def agent_generator(
122
- persona: str,
123
- dimension_dict: dict,
124
- model: Optional[Model] = None,
125
- cache: Optional["Cache"] = None,
126
- ) -> Generator["Results", None, None]:
127
- """
128
- >>> from edsl.language_models import LanguageModel
129
- >>> m = LanguageModel.example(canned_response = "This is a cool dude.", test_model = True)
130
- >>> ag = agent_generator(persona = "Base person", dimension_dict = {'attitude':['Positive', 'Negative']}, model = m)
131
- >>> next(ag).select('new_agent_persona').first()
132
- 'This is a cool dude.'
133
- >>> next(ag).select('new_agent_persona').first()
134
- 'This is a cool dude.'
135
- """
136
-
137
- if model is None:
138
- model = Model()
139
-
140
- q = QuestionFreeText(
141
- question_text=dedent(
142
- """\
143
- Consider this persona: '{{ persona }}'.
144
- Now imagine writing a new persona with these traits:
145
- '{{ new_agent_traits }}'
146
- Please write this persona as a narrative.
147
- """
148
- ),
149
- question_name="new_agent_persona",
150
- )
151
- agent_trait_generator = gen_agent_traits(dimension_dict)
152
- codebook = {sanitize_string(k): k for k in dimension_dict.keys()}
153
- while True:
154
- new_agent_traits = next(agent_trait_generator)
155
- yield q(
156
- persona=persona,
157
- new_agent_traits=new_agent_traits,
158
- codebook=codebook,
159
- just_answer=False,
160
- cache=cache,
161
- model=model,
162
- )
163
-
164
-
165
- def create_agents(
166
- agent_generator: Generator["Results", None, None],
167
- survey: Optional[Survey] = None,
168
- num_agents=11,
169
- ) -> AgentList:
170
- """
171
- >>> from edsl.language_models import LanguageModel
172
- >>> m = LanguageModel.example(canned_response = "This is a cool dude.", test_model = True)
173
- >>> ag = agent_generator(persona = "Base person", dimension_dict = {'attitude':['Positive', 'Negative']}, model = m)
174
- >>> new_agent_list = create_agents(agent_generator = ag)
175
- >>> new_agent_list
176
-
177
- """
178
- agent_list = AgentList([])
179
-
180
- MAX_ITERATIONS_MULTIPLIER = 2
181
- iterations = 0
182
-
183
- while len(agent_list) < num_agents:
184
- iterations += 1
185
- candidate_agent = next(agent_generator)
186
- codebook = candidate_agent.select("codebook").to_list()[0]
187
-
188
- koobedoc = {v: k for k, v in codebook.items()}
189
- persona = candidate_agent.select("new_agent_persona").to_list()[0]
190
- traits = candidate_agent.select("new_agent_traits").to_list()[0]
191
- new_traits = {koobedoc[key]: value for key, value in traits.items()} | {
192
- "persona": persona
193
- }
194
- agent = Agent(traits=new_traits, codebook=codebook)
195
- if survey is not None:
196
- if agent_eligibility(agent, survey):
197
- agent_list.append(agent)
198
- else:
199
- print("Agent not eligible")
200
- else:
201
- agent_list.append(agent)
202
-
203
- if iterations > MAX_ITERATIONS_MULTIPLIER * num_agents:
204
- raise Exception("Too many failures")
205
-
206
- return agent_list
207
-
208
-
209
- if __name__ == "__main__":
210
- import doctest
211
-
212
- doctest.testmod()
213
- # from edsl.language_models import LanguageModel
214
-
215
- # m = LanguageModel.example(canned_response="This is a cool dude.", test_model=True)
216
- # ag = agent_generator(
217
- # persona="Base person",
218
- # dimension_dict={"attitude": ["Positive", "Negative"]},
219
- # model=m,
220
- # )
221
- # example = [next(ag).select("new_agent_persona").first() for _ in range(10)]
222
- # dimension_dict = {"attitude": ["positive", "negative"]}
223
- # ag = gen_agent_traits(dimension_dict)
224
- # example = [next(ag) for _ in range(100)]
1
+ from textwrap import dedent
2
+ import random
3
+ from typing import List, TypeVar, Generator, Optional
4
+ from edsl.auto.StageBase import StageBase
5
+ from edsl.utilities.naming_utilities import sanitize_string
6
+ from edsl import Agent, Survey, Model, Cache, AgentList
7
+ from edsl import QuestionFreeText, Scenario
8
+ from edsl import QuestionMultipleChoice, Scenario, Agent, ScenarioList
9
+
10
+ StageClassType = TypeVar("StageClassType", bound=StageBase)
11
+
12
+
13
+ def gen_pipeline(stages_list: List[StageClassType]) -> StageBase:
14
+ """Takes as input a list of Stage classes & returns a pipeline of instantiated stages.
15
+ A pipeline is a linked list of stages where each stage has a next_stage attribute.
16
+
17
+ """
18
+ pipeline = stages_list[0]()
19
+ last_stage = pipeline
20
+ for stage in stages_list[1:]:
21
+ while last_stage.next_stage is not None: # find the end of the pipeline
22
+ last_stage = last_stage.next_stage
23
+ stage_to_add = stage()
24
+ last_stage.next_stage = stage_to_add
25
+ return pipeline
26
+
27
+
28
+ q_eligibility = QuestionMultipleChoice(
29
+ question_text=dedent(
30
+ """\
31
+ Consider this set of question: '{{ questions }}'.
32
+ Consider this persona: '{{ persona }}'.
33
+ Would this persona be able to answer all of these questions?
34
+ """
35
+ ),
36
+ question_options=["No", "Yes"],
37
+ question_name="eligibility",
38
+ )
39
+
40
+
41
+ def agent_list_eligibility(
42
+ agent_list: AgentList,
43
+ survey: Optional[Survey] = None,
44
+ model: Optional[Model] = None,
45
+ cache: Optional[Cache] = None,
46
+ ) -> List[bool]:
47
+ """
48
+ Returns whether each agent in a list is elgible for a survey i.e., can answer every question.
49
+
50
+ >>> from edsl.language_models import LanguageModel
51
+ >>> m = LanguageModel.example(canned_response = "1", test_model = True)
52
+ >>> agent_list_eligibility(AgentList.example())
53
+ [True, True]
54
+ >>> agent_list_eligibility(AgentList.example().add_trait('persona', 2*["Cool dude"]), survey = Survey.example(), model = m)
55
+ [True, True]
56
+ """
57
+ if survey is None:
58
+ return [True] * len(agent_list)
59
+ if "persona" not in agent_list.all_traits:
60
+ raise ValueError(
61
+ f"Each agent needs to have a persona attribute; traits are {agent_list.all_traits}"
62
+ )
63
+ sl = agent_list.select("persona").to_scenario_list()
64
+ sl.add_value("questions", [q.question_text for q in survey._questions])
65
+ results = q_eligibility.by(sl).by(model).run(cache=cache)
66
+ return [r == "Yes" for r in results.select("eligibility").to_list()]
67
+
68
+
69
+ def agent_eligibility(
70
+ agent: Agent,
71
+ survey: Survey,
72
+ model: Optional[Model] = None,
73
+ cache: Optional[Cache] = None,
74
+ ) -> bool:
75
+ """NB: This could be parallelized.
76
+
77
+ >>> from edsl.language_models import LanguageModel
78
+ >>> m = LanguageModel.example(canned_response = "1", test_model = True)
79
+ >>> agent_eligibility(agent = Agent.example().add_trait({'persona': "Persona"}), survey = Survey.example(), model = m)
80
+ True
81
+
82
+ """
83
+ model = model or Model()
84
+
85
+ questions = [q.question_text for q in survey._questions]
86
+ persona = agent.traits["persona"]
87
+ return (
88
+ q_eligibility(model=model, questions=questions, persona=persona, cache=cache)
89
+ == "Yes"
90
+ )
91
+
92
+
93
+ def gen_agent_traits(dimension_dict: dict, seed_value: Optional[str] = None):
94
+ """
95
+ >>> dimension_dict = {'attitude':['positive', 'negative']}
96
+ >>> ag = gen_agent_traits(dimension_dict)
97
+ >>> a = next(ag)
98
+ >>> a == {'attitude': 'positive'} or a == {'attitude': 'negative'}
99
+ True
100
+ >>> len([next(ag) for _ in range(100)])
101
+ 100
102
+ """
103
+ if seed_value is None:
104
+ seed_value = "edsl"
105
+
106
+ random.seed(seed_value)
107
+
108
+ while True:
109
+ new_agent_traits = {}
110
+ for key, list_of_values in dimension_dict.items():
111
+ new_agent_traits[key] = random.choice(list_of_values)
112
+ yield new_agent_traits
113
+
114
+
115
+ def agent_generator(
116
+ persona: str,
117
+ dimension_dict: dict,
118
+ model: Optional[Model] = None,
119
+ cache: Optional["Cache"] = None,
120
+ ) -> Generator["Results", None, None]:
121
+ """
122
+ >>> from edsl.language_models import LanguageModel
123
+ >>> m = LanguageModel.example(canned_response = "This is a cool dude.", test_model = True)
124
+ >>> ag = agent_generator(persona = "Base person", dimension_dict = {'attitude':['Positive', 'Negative']}, model = m)
125
+ >>> next(ag).select('new_agent_persona').first()
126
+ 'This is a cool dude.'
127
+ >>> next(ag).select('new_agent_persona').first()
128
+ 'This is a cool dude.'
129
+ """
130
+
131
+ if model is None:
132
+ model = Model()
133
+
134
+ q = QuestionFreeText(
135
+ question_text=dedent(
136
+ """\
137
+ Consider this persona: '{{ persona }}'.
138
+ Now imagine writing a new persona with these traits:
139
+ '{{ new_agent_traits }}'
140
+ Please write this persona as a narrative.
141
+ """
142
+ ),
143
+ question_name="new_agent_persona",
144
+ )
145
+ agent_trait_generator = gen_agent_traits(dimension_dict)
146
+ codebook = {sanitize_string(k): k for k in dimension_dict.keys()}
147
+ while True:
148
+ new_agent_traits = next(agent_trait_generator)
149
+ yield q(
150
+ persona=persona,
151
+ new_agent_traits=new_agent_traits,
152
+ codebook=codebook,
153
+ just_answer=False,
154
+ cache=cache,
155
+ model=model,
156
+ )
157
+
158
+
159
+ def create_agents(
160
+ agent_generator: Generator["Results", None, None],
161
+ survey: Optional[Survey] = None,
162
+ num_agents=11,
163
+ ) -> AgentList:
164
+ """
165
+ >>> from edsl.language_models import LanguageModel
166
+ >>> m = LanguageModel.example(canned_response = "This is a cool dude.", test_model = True)
167
+ >>> ag = agent_generator(persona = "Base person", dimension_dict = {'attitude':['Positive', 'Negative']}, model = m)
168
+ >>> new_agent_list = create_agents(agent_generator = ag)
169
+ >>> new_agent_list
170
+
171
+ """
172
+ agent_list = AgentList([])
173
+
174
+ MAX_ITERATIONS_MULTIPLIER = 2
175
+ iterations = 0
176
+
177
+ while len(agent_list) < num_agents:
178
+ iterations += 1
179
+ candidate_agent = next(agent_generator)
180
+ codebook = candidate_agent.select("codebook").to_list()[0]
181
+
182
+ koobedoc = {v: k for k, v in codebook.items()}
183
+ persona = candidate_agent.select("new_agent_persona").to_list()[0]
184
+ traits = candidate_agent.select("new_agent_traits").to_list()[0]
185
+ new_traits = {koobedoc[key]: value for key, value in traits.items()} | {
186
+ "persona": persona
187
+ }
188
+ agent = Agent(traits=new_traits, codebook=codebook)
189
+ if survey is not None:
190
+ if agent_eligibility(agent, survey):
191
+ agent_list.append(agent)
192
+ else:
193
+ print("Agent not eligible")
194
+ else:
195
+ agent_list.append(agent)
196
+
197
+ if iterations > MAX_ITERATIONS_MULTIPLIER * num_agents:
198
+ raise Exception("Too many failures")
199
+
200
+ return agent_list
201
+
202
+
203
+ if __name__ == "__main__":
204
+ import doctest
205
+
206
+ doctest.testmod()
207
+ # from edsl.language_models import LanguageModel
208
+
209
+ # m = LanguageModel.example(canned_response="This is a cool dude.", test_model=True)
210
+ # ag = agent_generator(
211
+ # persona="Base person",
212
+ # dimension_dict={"attitude": ["Positive", "Negative"]},
213
+ # model=m,
214
+ # )
215
+ # example = [next(ag).select("new_agent_persona").first() for _ in range(10)]
216
+ # dimension_dict = {"attitude": ["positive", "negative"]}
217
+ # ag = gen_agent_traits(dimension_dict)
218
+ # example = [next(ag) for _ in range(100)]