project_dilemma

项目困境

Project Dilemma是一种用于测试囚犯困境中算法的模拟工具。它提供了一个标准接口来定义算法和仿真类，以便可以轻松测试它们。受此Veritasium视频的启发。

目录

• 安装
  • PYPI
  • 手动的
• 配置
  • 配置文件位置
  • 配置格式
  • 动态导入
• 算法
• 模拟
• 世代模拟

安装

PYPI

1. pip install project-dilemma

手动的

1. 下载Git Repo
2. 更改为repo root目录
3. pip install .

配置

配置文件位置

项目困境将自动尝试从用户和系统的配置目录中加载配置，通常由$XDG_CONFIG_DIRS设置。对于大多数Linux用户，这将检查~/.config/project_dilemma ，并且它们在/etc中的某个地方。

可以通过将--config标志指定到要使用的配置文件来覆盖此行为。

配置格式

项目困境使用TOML格式进行配置文件。这是一种易于编写的人类可读格式。该架构已在下面提供：

 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/ "

• 算法_directory
  • 通往包含算法文件目录的路径
• Generational_simulation
  • 在世代模拟中为动态导入而在世代模拟中运行的模拟
• 节点
  • 指定的一系列表：
    • 节点ID
    • 算法，如动态导入中所定义
    • 数量，如果未指定，则假定1个节点
      • 注意：节点索引将附加到node_id部分
• 模拟
  • 作为动态导入运行的模拟
• simulation_id
  • 模拟的名称
• simulation_arguments
  • 参数传递到模拟中
• simulation_data
  • 通往包含先前仿真数据的JSON文件的路径
• simulation_data_output
  • 将仿真数据写入JSON的路径
• simulation_results_output
  • 写模拟结果的路径
• simulates_directory
  • 包含其他仿真文件的目录的路径
  • 用户提供的模拟所需

动态导入

由于可以或必须由用户提供许多对象，例如算法和仿真，因此必须动态导入此数据。为了轻松地导入这些对象而不导入所有仿真和算法，可以使用以下格式告诉程序在哪里查找导入：

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

• 文件
  • 包含对象相对于配置中关联目录的文件的路径
  • 算法和用户提供的模拟所需
• 目的
  • 导入的对象
    • 对于内置模拟，请在此处指定模拟类名称

算法

算法可以很容易地定义。仅需做四件事即可亚级算法接口：

1. 设置类名
2. 设置algorithm_id
3. 将突变传递到接口的初始化（例如，请参见模板）
4. 实施decide功能
5. 设置突变（可选）

decide函数是模拟运行算法的方法。它接受一个project_dilemma.interfaces.base.Rounds对象，该对象可用于获得先前的回合结果。该功能应True合作，而False违反。

如果要添加突变，请在定义类后设置静态突变列表以避免循环进口。

在templates/algorithm_template.py中提供了一个模板，以易于使用。

模拟

与算法相比，模拟更复杂的配置。您只需要覆盖run_simulation和process_simulation方法，但是这些方法非常重要。

run_simulation返回一个project_dilemma.interfaces.base.Simulations对象，该对象将由process_simulation使用以获取结果。

例如，提供的标准仿真处理回合数据以计算每个节点的分数一个模板可以在templates/simulation_template.py中找到。

世代模拟

世代模拟看似简单。只有一个函数可以覆盖： generational_hook 。但是，这意味着所有世代处理都必须在此功能中完成。

templates/generational_simulation_template.py中提供了模板。

执照

版权2023 Gabriele Ron

根据Apache许可证（版本2.0（“许可”）获得许可；除了符合许可外，您不得使用此文件。您可以在

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

除非适用法律要求或以书面形式同意，否则根据许可证分配的软件是按照“原样”分发的，没有任何明示或暗示的任何形式的保证或条件。请参阅许可证，以获取执行许可条款和限制的特定语言。

该项目利用了根据MIT许可证获得许可的PlatformDirs项目。版权（c）2010-202X平台开发人员