Added docstrings to strategy methods #1375

caddycarine · 2020-09-26T09:27:12Z

Added docstrings to strategy methods so they don't display the default placeholder docstring from the Player class.
Corrected (comments) typos in player, tournament, and _strategy_utils
Extracted calculation of cooperation ratio into a new method in averagecopier.

…t placeholder docstring from the Player class. Corrected (comments) typos in player, tournament, and _strategy_utils Extracted calculation of cooperation ratio into a new method in averagecopier.

drvinceknight · 2020-09-26T11:08:47Z

Thanks for this @caddycarine.

I believe the test are failing because of a small error in the docs that was fixed in #1372. Specifically in docs/tutorials/advanced/setting_a_seed.rst where:

>>> import axelrod as axl
>>> players = (axl.Random(), axl.Cooperator(), axl.MetaMixer())
>>> tournament = axl.Tournament(players, turns=5, repetitions=5, seed=201)
>>> results = tournament.play(processes=2)
>>> tournament2 = axl.Tournament(players, turns=5, repetitions=5, seed=201)
>>> results2 = tournament.play(processes=2)
>>> results.ranked_names == results2.ranked_names
True

should be:

>>> import axelrod as axl
>>> players = (axl.Random(), axl.Cooperator(), axl.MetaMixer())
>>> tournament = axl.Tournament(players, turns=5, repetitions=5, seed=201)
>>> results = tournament.play(processes=2)
>>> tournament2 = axl.Tournament(players, turns=5, repetitions=5, seed=201)
>>> results2 = tournament2.play(processes=2)
>>> results.ranked_names == results2.ranked_names
True

(There's actually two spots where that occurs).

There are two fixes here:

Rebase the up to date dev branch. (Preferred)
Tweak that yourself and the tests should pass. (Potential for merge conflicts)

* Add check to config.yml * Install black before trying to use it. * Move black installation This is just to avoid installing in case the CI fails beforehand. * Run black * Additional documentation on running black * Revert "Run black" This reverts commit c50a6e3. * Remove unnecessary installs. * Revert "Revert "Run black"" This reverts commit 10ab222. * Run isort. * Make black and isort compatible. Co-authored-by: T.J. Gaffney <[email protected]>

* Write a new documentation page with branch info This is related to #1352. Once this PR is merged we should: - Change github default branch to `dev` - Delete `master` - Confirm that read the docs is looking at `release` Am I missing anything? We should also remove the release process information from the wiki (assuming we're happy with what I've written here). Finally, once #1360 is done we should make sure we update the docs with the relevant information. * Remove ambiguous `very`. * Remove hypothesis version specification in docs. This is actually no longer correct since #1288 * Test properties not affected by floating point error This build found a particular failing example of `TestTournament.test_seeding_equality` https://github.com/Axelrod-Python/Axelrod/pull/1368/checks?check_run_id=975415322 Upon closer investigation it looks like that was not due to seeding but due to the floating point error of some calculations made by the result set. I investigated using: ``` import axelrod as axl import numpy as np seed = 2 repetitions = 10 rng = axl.RandomGenerator(seed=seed) players = [axl.Random(rng.random()) for _ in range(8)] tournament1 = axl.Tournament( players=players, turns=10, repetitions=repetitions, seed=seed ) tournament2 = axl.Tournament( players=players, turns=10, repetitions=repetitions, seed=seed ) for _ in range(4): results1 = tournament1.play(processes=2, progress_bar=False) results2 = tournament2.play(processes=2, progress_bar=False) assert results1.wins == results2.wins assert results1.match_lengths == results2.match_lengths assert results1.scores == results2.scores assert np.allclose(results1.normalised_scores, results2.normalised_scores) assert np.allclose(results1.ranking, results2.ranking) assert results1.ranked_names == results2.ranked_names assert results1.payoffs == results2.payoffs assert results1.payoff_matrix == results2.payoff_matrix assert np.allclose(results1.payoff_stddevs, results2.payoff_stddevs) assert results1.score_diffs == results2.score_diffs assert results1.payoff_diffs_means == results2.payoff_diffs_means assert results1.cooperation == results2.cooperation assert results1.normalised_cooperation == results2.normalised_cooperation assert results1.vengeful_cooperation == results2.vengeful_cooperation assert results1.cooperating_rating == results2.cooperating_rating assert results1.good_partner_matrix == results2.good_partner_matrix assert results1.good_partner_rating == results2.good_partner_rating assert np.allclose(results1.eigenmoses_rating, results2.eigenmoses_rating) assert np.allclose(results1.eigenjesus_rating, results2.eigenjesus_rating) ``` Note I'm using `np.isclose` for some properties. In this commit: - I add the specific seed for which the error was found as a hypothesis example (`seed=2`). - Replace the `results1 == results2` check with just a check of some properties (from which the others are essentially calculated). - Added `progress_bar=False` * Add instructions for using venv. * s/requirements/requirements.txt * Spell requirements correctly..

* Added new SpitefulCC Player to grudger.py, updated the list of all strategies and added coverage test in test_grudger.py * changed 236 strategies to 237 in docs/index.rst * changed SpitefulCC classifier and added strategy description * changed description spitefulCC strategy * Fix doctest. This was failing on #1364 but the fix is trivial. * Correct expected actions for meta strategy. * Run black and isort. Co-authored-by: Laura Romero <[email protected]>

@marcharper

* [#1370] Remove some tests from test_meta.py Removes some tests that do not target specific strategy behaviors and can change when new strategies are added. * Add a property based test for valid strategies Not sure if this is overkill @marcharper, just thought it could be worth having. * Run isort. Co-authored-by: Vince Knight <[email protected]>

…t placeholder docstring from the Player class. Corrected (comments) typos in player, tournament, and _strategy_utils Extracted calculation of cooperation ratio into a new method in averagecopier.

…rategies and added coverage test in test_grudger.py

change line 641 of axelrod/tests/strategies/test_meta.py

drvinceknight · 2020-09-26T18:16:56Z

The CI is failing on black https://github.com/psf/black:

would reformat /home/runner/work/Axelrod/Axelrod/axelrod/strategies/averagecopier.py
36
would reformat /home/runner/work/Axelrod/Axelrod/axelrod/strategies/hunter.py
37
would reformat /home/runner/work/Axelrod/Axelrod/axelrod/tests/strategies/test_meta.py

Could you run:

python -m black -l 80 .

at the root of the repo (should modify those 3 files).

* Add check to config.yml * Install black before trying to use it. * Move black installation This is just to avoid installing in case the CI fails beforehand. * Run black * Additional documentation on running black * Revert "Run black" This reverts commit c50a6e3. * Remove unnecessary installs. * Revert "Revert "Run black"" This reverts commit 10ab222. * Run isort. * Make black and isort compatible. Co-authored-by: T.J. Gaffney <[email protected]> Rebase with dev branch Resolved merge conflicts in last commit

* Add check to config.yml * Install black before trying to use it. * Move black installation This is just to avoid installing in case the CI fails beforehand. * Run black * Additional documentation on running black * Revert "Run black" This reverts commit c50a6e3. * Remove unnecessary installs. * Revert "Revert "Run black"" This reverts commit 10ab222. * Run isort. * Make black and isort compatible. Co-authored-by: T.J. Gaffney <[email protected]> Rebased to dev branch Resolved merge conflicts Rebase with dev branch

drvinceknight · 2020-09-26T20:16:13Z

There seems to be a merge conflict in test_meta if you could rebase/merge dev please.

Rebase with main

* Add check to config.yml * Install black before trying to use it. * Move black installation This is just to avoid installing in case the CI fails beforehand. * Run black * Additional documentation on running black * Revert "Run black" This reverts commit c50a6e3. * Remove unnecessary installs. * Revert "Revert "Run black"" This reverts commit 10ab222. * Run isort. * Make black and isort compatible. Co-authored-by: T.J. Gaffney <[email protected]> Rebase with main Rebase with master

* Added new SpitefulCC Player to grudger.py, updated the list of all strategies and added coverage test in test_grudger.py * changed 236 strategies to 237 in docs/index.rst * changed SpitefulCC classifier and added strategy description * changed description spitefulCC strategy * Fix doctest. This was failing on #1364 but the fix is trivial. * Correct expected actions for meta strategy. * Run black and isort. Co-authored-by: Laura Romero <[email protected]>

Resolved merge conflicts Modified for loop to stop initialization the filterset dictionary and comprehension set in each iteration.

drvinceknight

Looks good to me. Thank you @caddycarine.

marcharper · 2020-09-29T01:18:51Z

Why are so many files affected? I thought we ran black recently.

drvinceknight · 2020-09-29T08:16:28Z

Why are so many files affected? I thought we ran black recently.

We did so I'm not too sure but I think this is because of how the commits were applied. Looks like a commit from the "applying black" PR 87fa66e was perhaps cherry picked which added merge conflicts and then black was run again. So my guess is that a local rebase would clean up the history.

It could be worth:

$ git checkout dev
$ git pull origin dev
$ git checkout -b add_docstrings
$ git cherry-pick 5639e7f
$ python -m black -l 80
$ git commit # if necessary

If I'm reading everything correctly the only commit that's actually needed in this PR is
5639e7f

Changed the test to make it use hypothesis to generate a list of classifiers to be used in the filters. Also made some minor modifications in some strategies' tests, like changing set(["game"]) to {"game"} to reduce function call.

marcharper · 2020-09-30T04:54:17Z

@caddycarine After you follow the commands above, you'll need to open a new PR from the add_docstrings branch

Changed the test to make it use hypothesis to generate a list of classifiers to be used in the filters. Also made some minor modifications in some strategies' tests, like changing set(["game"]) to {"game"} to reduce function call. Formatted with black and isort

caddycarine · 2020-09-30T05:45:24Z

@caddycarine After you follow the commands above, you'll need to open a new PR from the add_docstrings branch

After following the commands, do i rebase onto master before opening the PR?

drvinceknight · 2020-09-30T08:05:00Z

The second command git pull origin dev would mean that you don't need to as you would be branch from the latest version of dev (note that there is no master branch #1352 but the dev branch essentially serves that purpose now).

drvinceknight · 2020-10-07T14:27:29Z

Closing this as #1377 has been merged.

Added docstrings to strategy methods so they don't display the defaul…

1622f94

…t placeholder docstring from the Player class. Corrected (comments) typos in player, tournament, and _strategy_utils Extracted calculation of cooperation ratio into a new method in averagecopier.

drvinceknight and others added 9 commits September 26, 2020 18:41

Added docstrings to strategy methods so they don't display the defaul…

5639e7f

…t placeholder docstring from the Player class. Corrected (comments) typos in player, tournament, and _strategy_utils Extracted calculation of cooperation ratio into a new method in averagecopier.

Added new SpitefulCC Player to grudger.py, updated the list of all st…

e036f2d

…rategies and added coverage test in test_grudger.py

changed SpitefulCC classifier and added strategy description

b5ad28a

changed description spitefulCC strategy

f6e2f3c

fix test_meta.py

2bd889d

change line 641 of axelrod/tests/strategies/test_meta.py

drvinceknight added 2 commits September 26, 2020 19:27

RomeroLaura and others added 6 commits September 26, 2020 21:52

changed SpitefulCC classifier and added strategy description

2c61618

Rebase with main

Rebased to dev branch

1c62084

Resolved merge conflicts Modified for loop to stop initialization the filterset dictionary and comprehension set in each iteration.

Resolve merge conflicts

4c3da85

Reformatted with black

075c3d9

drvinceknight approved these changes Sep 28, 2020

View reviewed changes

drvinceknight added the ready-to-merge label Sep 28, 2020

CaddyC added 2 commits September 30, 2020 02:40

Modified test_boolean_filtering() test

a4e9cd6

Changed the test to make it use hypothesis to generate a list of classifiers to be used in the filters. Also made some minor modifications in some strategies' tests, like changing set(["game"]) to {"game"} to reduce function call.

Modified test_boolean_filtering() test

2325486

Changed the test to make it use hypothesis to generate a list of classifiers to be used in the filters. Also made some minor modifications in some strategies' tests, like changing set(["game"]) to {"game"} to reduce function call.

Nikoleta-v3 removed the ready-to-merge label Sep 30, 2020

drvinceknight closed this Oct 7, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added docstrings to strategy methods #1375

Added docstrings to strategy methods #1375

caddycarine commented Sep 26, 2020

drvinceknight commented Sep 26, 2020 •

edited

Loading

drvinceknight commented Sep 26, 2020 •

edited

Loading

drvinceknight commented Sep 26, 2020 •

edited

Loading

drvinceknight left a comment

marcharper commented Sep 29, 2020

drvinceknight commented Sep 29, 2020

marcharper commented Sep 30, 2020

caddycarine commented Sep 30, 2020

drvinceknight commented Sep 30, 2020

drvinceknight commented Oct 7, 2020

Added docstrings to strategy methods #1375

Added docstrings to strategy methods #1375

Conversation

caddycarine commented Sep 26, 2020

drvinceknight commented Sep 26, 2020 • edited Loading

drvinceknight commented Sep 26, 2020 • edited Loading

drvinceknight commented Sep 26, 2020 • edited Loading

drvinceknight left a comment

Choose a reason for hiding this comment

marcharper commented Sep 29, 2020

drvinceknight commented Sep 29, 2020

marcharper commented Sep 30, 2020

caddycarine commented Sep 30, 2020

drvinceknight commented Sep 30, 2020

drvinceknight commented Oct 7, 2020

drvinceknight commented Sep 26, 2020 •

edited

Loading

drvinceknight commented Sep 26, 2020 •

edited

Loading

drvinceknight commented Sep 26, 2020 •

edited

Loading