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

Add description of noise in glossary and match.rst #727

Merged
merged 1 commit into from
Oct 12, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/reference/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,3 +91,9 @@ A tournament
------------

A **tournament** is a repetition of round robins so as to smooth out stochastic effects.

Noise
-----

A match or tournament can be played with **noise**: this is the probability that
indicates the chance of an action dictated by a strategy being swapped.
4 changes: 3 additions & 1 deletion docs/tutorials/getting_started/match.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ For example, to create a 5 turn match between :code:`Cooperator` and
>>> match.play()
[('C', 'C'), ('C', 'D'), ('C', 'C'), ('C', 'D'), ('C', 'C')]

By default, a match will not be noisy, but you can introduce noise if you wish::
By default, a match will not be noisy, but you can introduce noise if you wish.
Noise is the probability with which any action dictated by a strategy will be
swapped::

>>> match = axl.Match(players=players, turns=5, noise=0.2)
>>> match.play() # doctest: +SKIP
Expand Down