`FileStore` examples

CSV example

Here we create an example CSV file, post it to Coop using FileStore, and then retrieve it and use it to construct a ScenarioList and an AgentList.

To create a CSV file (this step can be skipped and your own file replaced in the following steps):

[1]:

from edsl import FileStore

[2]:

data = [
    ['Age', 'City', 'Occupation'],
    [25, 'New York', 'Software Engineer'],
    [30, 'San Francisco', 'Teacher'],
    [35, 'Chicago', 'Doctor'],
    [28, 'Boston', 'Data Scientist'],
    [45, 'Seattle', 'Architect']
]

# Writing to CSV file
with open('data.csv', 'w') as file:
    for row in data:
        line = ','.join(str(item) for item in row)
        file.write(line + '\n')

fs = FileStore("data.csv")

Creating scenarios:

[4]:

from edsl import ScenarioList

scenarios = ScenarioList.from_source("csv", fs.to_tempfile())
scenarios # display the scenarios

[4]:

ScenarioList scenarios: 5; keys: ['City', 'Age', 'Occupation'];

	Age	City	Occupation
0	25	New York	Software Engineer
1	30	San Francisco	Teacher
2	35	Chicago	Doctor
3	28	Boston	Data Scientist
4	45	Seattle	Architect

Creating agents:

[5]:

from edsl import AgentList

agents = AgentList.from_csv(fs.to_tempfile())
agents # display the agents

[5]:

AgentList agents: 5;

	Age	City	Occupation
0	25	New York	Software Engineer
1	30	San Francisco	Teacher
2	35	Chicago	Doctor
3	28	Boston	Data Scientist
4	45	Seattle	Architect

These scenarios and agents can now be used with questions and surveys.

PNG example

Here we post an image file to Coop using FileStore, and then retrieve it and use it to construct a Scenario.

Note that we need to specify the scenario key for the file when we create it (whereas in CSV files the keys are taken from the text of the header row).

We also need to ensure that we have specified a vision model when running the survey (e.g., gpt-4o).

Posting a local file to Coop (replace with your own):

[8]:

from edsl import FileStore

if refresh := False:
    fs = FileStore("parrot_logo.png")
    png_info = fs.push(description = "My example PNG file", alias = "my-example-png-file", visibility = "public")

Retrieving the file:

[9]:

fs = FileStore.pull("https://www.expectedparrot.com/content/RobinHorton/my-example-png-file")

Creating a scenario:

[10]:

from edsl import Scenario

image_scenario = Scenario({"parrot_logo":fs}) # including a key for the scenario object

image_scenario.keys()

[10]:

['parrot_logo']

To rename a scenario:

[11]:

image_scenario = image_scenario.rename({"parrot_logo": "logo"}) # key = old name, value = new name
image_scenario.keys()

[11]:

['logo']

Using an image scenario:

[12]:

from edsl import QuestionFreeText, Model

model = Model("gpt-4o") # we need to use a vision model

q = QuestionFreeText(
    question_name = "test",
    question_text = "Describe this logo: {{ logo }}"
)

results = q.by(image_scenario).by(model).run()

⌃ Job Status 🦜

Completed

Links

Results

Progress Report

Identifiers

Results UUID:

6db300f7...6e41

Job UUID:

2f5e966d...76f1