Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Second Tournament Documentation #1078

Merged
merged 23 commits into from
Jul 22, 2017
Merged

Second Tournament Documentation #1078

merged 23 commits into from
Jul 22, 2017

Conversation

meatballs
Copy link
Member

Fixes #1074

meatballs and others added 9 commits July 20, 2017 17:58
This uses the following to generate the `fortrain_keys.rst` file:

```
import glob
import pathlib
strategy_files = glob.glob("./src/*.f")
with open("/home/vince/src/Axelrod/docs/reference/fortan_keys.rst", "w") as f:
    for file in strategy_files:
        path = pathlib.Path(file)
        strategy_name = path.stem.upper()
        file_name = path.name
        f.write(".. _{}: https://github.com/Axelrod-Python/TourExec/blob/master/src/{}\n".format(strategy_name, file_name))
```
Add keys to Fortran code in a separate file.
@meatballs
Copy link
Member Author

An alternative option for the links in the third column is to insert references in the text that describes each strategy, use links to those refs in the table, but then have a link to the strategy index within the text

Copy link
Member

@drvinceknight drvinceknight left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tiny typo but this looks glorious @meatballs. I reckon we could get rid of the text going over the strategies in the documentation and just use the fact that your table points at the source code (and thus the docstring). We could do the same for the other tournaments.

@@ -250,7 +250,91 @@ This strategy plays randomly (disregarding the history of play).
Axelrod's second tournament
---------------------------

Work in progress.
The code was for Axelrod's second touranment was originally published by the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo? The code for Axelrod's

The code for Axelrod's second touranment was originally published by the
`University of Michigan Center for the Study of Complex Systems <http://lsa.umich.edu/cscs/>`_
and is now available from
`Robert Axelrod's personal website <http://www-personal.umich.edu/~axe/research/Software/CC/CC2.html>`_.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we explicitly add the "license" here from the source?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what you mean? Are you talking about the disclaimer on his site?

"K56R_", "Quayle", "Not Implemented"
"K57R_", "Nydegger", ":class:`axelrod.strategies.axelrod_first.Nydegger`"
"K58R_", "Rowsam", "Not Implemented"
"K59R_", "Downing", "Not Implemented"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have RevisedDowning, which may be the same.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll put a note to that effect

"K57R_", "Nydegger", ":class:`axelrod.strategies.axelrod_first.Nydegger`"
"K58R_", "Rowsam", "Not Implemented"
"K59R_", "Downing", "Not Implemented"
"K60R_", "Graaskamp", "Not Implemented"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Someone was just working on this one...

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll put a WIP note

"K31R_", "Grisell", "Not Implemented"
"K32R_", "Kluepfel", "Not Implemented"
"K33R_", "Rabbie", "Not Implemented"
"K34R_", "Friedman", "Not Implemented"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think maybe we have this one under another name.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep. It's Grudger

"K71R_", "Hill", "Not Implemented"
"K72R_", "White", "Not Implemented"
"K73R_", "Zimmerman", "Not Implemented"
"K74R_", "Friedland", "Not Implemented"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Duplicate?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No. He submitted two separate strategies but there's no name other than his own or the K74R and K74RXX

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm guessing that's why the second of those has 'XX' in its code.

I suggest we leave it as is for the moment. Come the point when we translate this into Python, we'll have to come up with some sort of unique name for them but, until then, it's unimportant.

"K83R_", "Black", "Not Implemented"
"K84R_", "Tideman Chieruzz", "Not Implemented"
"K85R_", "Falk Langste", "Not Implemented"
"K86R_", "Grofman", "Not Implemented"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's in Axelrod First

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll fix that

"K90R_", "Smith", "Not Implemented"
"K91R_", "Pinkley", "Not Implemented"
"K92R_", "Rapoport", "Not Implemented"
"K93R_", "Unknown", "Not Implemented"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also in Axelrod First but I recall not being sure the implementation was completely correct

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is that the 'Unamed Strategy'?

"K44R_", "Adams", "Not Implemented"
"K45R_", "Mcgurrin", "Not Implemented"
"K46R_", "Eatherley", ":class:`axelrod.strategies.axelrod_second.Eatherley`"
"K47R_", "Hufford", "Not Implemented"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Names repeated...

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, there are some authors who submitted more than one strategy. I'm just listing the name here at the moment and not attempting to make it unique in any way.

@marcharper
Copy link
Member

A few minor comments from me, looks good :)

@meatballs
Copy link
Member Author

I could change the second column in the table to be the author's name and then give their full name rather than just the last name.

That would make it explicit that we are talking about the author and not the name of the strategy.

@drvinceknight
Copy link
Member

I like that idea (author name).

@meatballs
Copy link
Member Author

I'm onto to it and it's already cleared up one issue - the two called Hufford were by two different people, Richard and George Hufford!

@meatballs
Copy link
Member Author

I think I'm done with this one

@meatballs
Copy link
Member Author

Hang on, got another improvement coming.....

@meatballs
Copy link
Member Author

Really done this time

The code for Axelrod's second touranment was originally published by the
`University of Michigan Center for the Study of Complex Systems <http://lsa.umich.edu/cscs/>`_
and is now available from
`Robert Axelrod's personal website <http://www-personal.umich.edu/~axe/research/Software/CC/CC2.html>`_
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we copy the actual permissions "You are free to download these materials and use them without restriction" since that page may not last forever? Or am I being paranoid?

Copy link
Member Author

@meatballs meatballs Jul 22, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

Or am I being paranoid?

Just because you're paranoid, it doesn't mean they aren't out to get you!

Copy link
Member

@drvinceknight drvinceknight left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking really good @meatballs.

"K90R_", "John Maynard Smith", "Not Implemented"
"K91R_", "Jonathan Pinkley", "Not Implemented"
"K92R_", "Anatol Rapoport", "Not Implemented"
"K93R_", "Unknown. Probably Robert Axelrod", ":class:`UnnamedStrategy <axelrod.strategies.axelrod_first.UnnamedStrategy>`"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The author wasn't Robert Axelrod:

Apparently written by a grad student in political science whose name was withheld, this strategy cooperates with a given probability P.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps: Unnamed Graduate Student as author? Or perhaps just Unknown...?

@drvinceknight
Copy link
Member

Looks good to me. I'll let @marcharper press go.

@marcharper marcharper merged commit cbec9ed into master Jul 22, 2017
@meatballs meatballs deleted the issue-1074 branch July 28, 2017 09:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants