Imitation Dynamics and Regret Minimization models added to the repo

[sandeepvshenoy]

This PR has the following changes.

Modified File
game.py -> Modified the file to add two new function calls within the code regret_minimization and imitation_dynamics

New Files
The following new files are added to attach the above functions and their corresponding test files into the repo
src/nashpy/egt/imitation_dynamics.py
src/nashpy/algorithms/regret_minimization.py

tests/unit/test_regret_minimization.py
tests/unit/test_imitation_dynamics.py

[drvinceknight]

This all looks like a good potential contribution. Nice work.

Can you how imitation dynamics is a different algorithm than fictitious play?

I'd like you to add some documentation.:

In docs/text-book add two new files (1 for each of these algorithms). Please follow the style of some of the earlier chapters like: https://nashpy.readthedocs.io/en/stable/text-book/support-enumeration.html

Also indocs/how add clear and to the point instructions on how to use the two new algorithms (you can take a look at the other how to guides to see examples of what are required).

The docs are currently failing because the formatting is not quite right. The format is checked using black. After installing black you can run it on the code base using python -m black src/ and python -m black tests/.

[drvinceknight]

The test suite is still failing at black:

 py310: commands[0]> python -m black --check src/
  would reformat /home/runner/work/Nashpy/Nashpy/src/nashpy/game.py
  
  Oh no! 💥 💔 💥
  1 file would be reformatted, 22 files would be left unchanged.

Check the black version: black==24.3.0

[sandeepvshenoy]

The test suite is still failing at black:

 py310: commands[0]> python -m black --check src/
  would reformat /home/runner/work/Nashpy/Nashpy/src/nashpy/game.py
  
  Oh no! 💥 💔 💥
  1 file would be reformatted, 22 files would be left unchanged.

Check the black version: black==24.3.0

Reformatted using black version 24.3.0

[drvinceknight]

As discussed in our call right now:

• Let's get the CI passing :)
• Also if you could move the modules to the learning dir that would be great.

[sandeepvshenoy]

As discussed in our call right now:

• Let's get the CI passing :)
• Also if you could move the modules to the learning dir that would be great.

The local tox has passed all the checks; I have also moved the functions under the learning folder. Thanks.
I am afraid to add the exercise examples; I need a little more time. I assure you that I will look into that and create a new PR once I am free from the 2nd of April.

[drvinceknight]

Thanks for the contribution @sandeepvshenoy 👍