project_dilemma

Dilema del proyecto

El dilema del proyecto es una herramienta de simulación para probar algoritmos en el dilema del prisionero. Proporciona una interfaz estándar para definir las clases de algoritmo y simulación para que puedan probarse fácilmente. Inspirado en este video de Veritasium.

Tabla de contenido

• Instalación
  • Pypi
  • Manual
• Configuración
  • Ubicación del archivo de configuración
  • Formato de configuración
  • Importaciones dinámicas
• Algoritmos
• Simulaciones
• Simulaciones generacionales

Instalación

Pypi

1. pip install project-dilemma

Manual

1. Descargar Git Repo
2. Cambiar en el directorio de Repo Root
3. pip install .

Configuración

Ubicación del archivo de configuración

El dilema del proyecto intentará cargar automáticamente la configuración de los directorios de configuración del usuario y del sistema, generalmente establecido por $XDG_CONFIG_DIRS . Para la mayoría de los usuarios de Linux, esto verificará ~/.config/project_dilemma y ellos en algún lugar de /etc .

Este comportamiento se puede anular especificando el indicador --config al archivo de configuración que desea usar.

Formato de configuración

El dilema del proyecto utiliza el formato TomL para archivos de configuración. Este es un formato legible por humanos que es fácil de escribir. El esquema se ha proporcionado a continuación:

 simulation_id = " name of simulation "
algorithms_directory = " /path/to/algorithms/ "
nodes = [ { node_id = " node_1 " , algorithm = { file = " foo.py " , object = " Foo " }, quantity = 11 },
          { node_id = " node_2 " , algorithm = { file = " bar/baz.py " , object = " Baz " } } ]
simulation = { file = " foobar.py " , object = " GenerationalFooBar " }
generational_simulation = { file = " foobar.py " , object = " FooBar " }
simulation_arguments = { foo = " bar " }
simulation_data = " path/to/round.json "
simulation_data_output = " path/to/round.json "
simulation_results_output = " path/to/results.json "
simulations_directory = " /path/to/simulations/ "

• algorithms_directory
  • Una ruta al directorio que contiene los archivos de algoritmos
• generacional_simulación
  • La simulación para ejecutarse para cada generación en una simulación generacional como una importación dinámica
• nodos
  • Una variedad de tablas que especifican:
    • ID de nodo
    • algoritmo, como se define en las importaciones dinámicas
    • cantidad, si no se especifica, entonces se supone 1 nodo
      • Nota: El índice de nodo se agregará a la sección Node_ID
• simulación
  • La simulación para ejecutarse como una importación dinámica
• simulación_id
  • El nombre de la simulación
• simulación_argumentos
  • Argumentos para pasar a la simulación
• simulación_data
  • Ruta a un archivo JSON que contiene datos de simulación anteriores
• simulación_data_output
  • Ruta para escribir los datos de simulación como un JSON
• simulación_results_output
  • Camino para escribir los resultados de la simulación
• simulaciones_directory
  • Una ruta al directorio que contiene archivos de simulación adicionales
  • Requerido para simulaciones proporcionadas por el usuario

Importaciones dinámicas

Debido a que muchos de los objetos, como los algoritmos y las simulaciones, pueden o deben ser proporcionadas por el usuario, estos datos deben importarse dinámicamente. Para importar fácilmente estos objetos sin importar cada simulación y algoritmo, el siguiente formato se puede usar para decirle al programa dónde buscar las importaciones:

 { file = " path/to/file " , object = " ObjectToImport " }

• archivo
  • Una ruta al archivo que contiene el objeto en relación con el directorio asociado en la configuración
  • Requerido para algoritmos y simulaciones proporcionadas por el usuario
• objeto
  • El objeto para importar
    • Para simulaciones integradas, especifique el nombre de la clase de simulación aquí

Algoritmos

Los algoritmos se pueden definir muy fácilmente. Solo se deben hacer cuatro cosas para subclase la interfaz de algoritmo:

1. Establecer el nombre de la clase
2. Establecer algorithm_id
3. Pasar las mutaciones al init de la interfaz (ver plantilla, por ejemplo)
4. Implementar la función decide
5. Establecer mutaciones (opcionales)

La función decide es lo que usa la simulación para ejecutar el algoritmo. Acepta un objeto project_dilemma.interfaces.base.Rounds que puede usarse para obtener los resultados de rondas anteriores. La función debe devolver True para la cooperación y False para la deserción.

Si desea agregar mutaciones, establezca la lista de mutaciones estáticas después de definir la clase para evitar las importaciones circulares.

Se ha proporcionado una plantilla en templates/algorithm_template.py para facilitar su uso.

Simulaciones

Las simulaciones son más complicadas de configurar en comparación con los algoritmos. Solo necesita anular los métodos run_simulation y process_simulation , pero estos son increíblemente importantes.

run_simulation Devuelve un objeto project_dilemma.interfaces.base.Simulations que será utilizado por process_simulation para obtener los resultados.

Por ejemplo, las simulaciones estándar proporcionadas procesan los datos de la redacción para calcular las puntuaciones para cada nodo, una plantilla se puede encontrar en templates/simulation_template.py .

Simulaciones generacionales

Las simulaciones generacionales son engañosamente simples. Solo hay una función para anular: generational_hook . Sin embargo, esto significa que todo el procesamiento generacional debe hacerse en esta función.

Se ha proporcionado una plantilla en templates/generational_simulation_template.py .

Licencia

Copyright 2023 Gabriele Ron

Licenciado bajo la licencia Apache, versión 2.0 (la "licencia"); No puede usar este archivo, excepto de conformidad con la licencia. Puede obtener una copia de la licencia en

 http://www.apache.org/licenses/LICENSE-2.0

A menos que la ley aplicable sea requerida o acordado por escrito, el software distribuido bajo la licencia se distribuye de manera "como es", sin garantías o condiciones de ningún tipo, ya sea expresas o implícitas. Consulte la licencia para los permisos y limitaciones de rigor de idioma específico bajo la licencia.

Este proyecto utiliza el proyecto PlatformDirs que tiene licencia bajo la licencia MIT. Copyright (c) 2010-202x Los desarrolladores de PlatformDirs