updated examples

README.md

@@ -1,6 +1,6 @@
 # EconomicAgents
 
-This is an implementation and Python package for the paper [`Large Language Models as Simulated Economic Agents: What Can We Learn from Homo Silicus?`](https://arxiv.org/abs/2301.07543). This Python package enables you to run all four simulations from the paper. 
+This is an implementation and Python package for the paper [Large Language Models as Simulated Economic Agents: What Can We Learn from Homo Silicus?](https://arxiv.org/abs/2301.07543). This Python package enables you to run all four simulations from the paper. 
 
 If you like this work, consider joining our [![Discord](https://img.shields.io/badge/Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/Qy69gzmpt4).
 

examples.py

@@ -2,7 +2,7 @@
 #TEST RABIN
 from economic_agents import CharnessRabin
 
-charness_rabin = CharnessRabin(api_key="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", model="gpt-3.5-turbo", personality=1, image_path="random/file", logging=True)
+charness_rabin = CharnessRabin(api_key="openai_key", model="gpt-3.5-turbo", personality=1, image_path="random/file", logging=True)
 results = charness_rabin.play()
 charness_rabin.create_plot(results)
 """
@@ -11,7 +11,7 @@
 #TEST HORTON
 from economic_agents import Horton
 #def __init__(self, api_key, model, image_path, logging):
-horton = Horton(api_key="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", model="gpt-3.5-turbo", image_path="random/horton", logging=True)
+horton = Horton(api_key="openai_key", model="gpt-3.5-turbo", image_path="random/horton", logging=True)
 results = horton.play()
 horton.create_plot(results)
 """
@@ -20,14 +20,16 @@
 #TEST Kahneman
 from economic_agents import Kahneman
 
-kahneman = Kahneman(api_key="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", model="gpt-3.5-turbo", image_path="results/kahneman", logging=True)
+kahneman = Kahneman(api_key="openai_key", model="gpt-3.5-turbo", image_path="results/kahneman", logging=True)
 results = kahneman.play()
 kahneman.create_plot(results)
 """
 
+"""
 #TEST ZECKAUSER
 from economic_agents import Zeckhauser
 
-zeckhauser = Zeckhauser(api_key="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", model="gpt-3.5-turbo", image_path="results/zeckhauser", logging=True)
+zeckhauser = Zeckhauser(api_key="openai_key", model="gpt-3.5-turbo", image_path="results/zeckhauser", logging=True)
 results = zeckhauser.play()
-zeckhauser.create_plot(results)
+zeckhauser.create_plot(results)
+"""

setup.py

@@ -4,6 +4,8 @@
     name='economic_agents',
     version='0.1',
     description='A Python package for the paper "Large Language Models as Simulated Economic Agents: What Can We Learn from Homo Silicus?"',
+    long_description=open('README.md').read(),
+    long_description_content_type='text/markdown',
     author='Max Hager',
     author_email='[email protected]',
     packages=find_packages(),