Skip to content

Commit

Permalink
docs(frontend): adding a Game of Life example
Browse files Browse the repository at this point in the history
closes #457
  • Loading branch information
bcm-at-zama committed Sep 25, 2023
1 parent d64c9b0 commit abfaaa6
Show file tree
Hide file tree
Showing 4 changed files with 555 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@

* [Key Value Database](application-tutorial/key\_value\_database.md)
* [SHA-256](application-tutorial/sha256.md)
* [Game of Life](application-tutorial/game_of_life.md)

## How To

Expand Down
Binary file added docs/_static/game-of-life.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
54 changes: 54 additions & 0 deletions docs/application-tutorial/game_of_life.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Game of Life

In the associated [Python file](https://github.com/zama-ai/concrete/blob/main/frontends/concrete-python/examples/game_of_life/game_of_life.py), you can run the Game of Life, written in Concrete Python.

![ Game of Life](../_static/game_of_life.gif)

### Installation

In addition to Concrete, you must install `pygame` in your virtual environment:

- `pip3 install pygame`

Once done, if you go to `frontends/concrete-python/examples/game_of_life`, `python game_of_life.py --help` should give you the manpage:

```
Game of Life in Concrete Python.
options:
-h, --help show this help message and exit
--dimension DIMENSION
Dimension of the grid
--refresh_every REFRESH_EVERY
Refresh the grid every X steps
--method {method_3b,method_4b,method_5b,method_basic}
Method for refreshing the grid
--log2_global_p_error LOG2_GLOBAL_P_ERROR
Probability of correctness issue (full circuit)
--log2_p_error LOG2_P_ERROR
Probability of correctness issue (individual TLU)
--simulate Simulate instead of running computations in FHE
--show_mlir Show the MLIR
--stop_after_compilation
Stop after compilation
--text_output Print a text output of the grid
```

### Running

Then, you can play with the different options, and in particular:

- `dimension`, to chose the size of the grid; the larger, the slower
- `method`, to chose which implementation is used for the grid update
- `log2_global_p_error` and `log2_p_error`, to chose the probability of correctness issue (see the Concrete documentation for more information)
- `simulate`, to do computations only in simulation, i.e., not in FHE

### Typical Executions

In simulation: `python3 game_of_life.py --dimension 100 --refresh_every 50 --simulate`

In FHE: `python3 game_of_life.py --dimension 6 --refresh_every 8 --log2_p_error -40 --method method_4b`

### Technical Explanations

A blog is currently being under writening, and a link will be added it here when it's available. In the meantime, some explanations are given in the code.
Loading

0 comments on commit abfaaa6

Please sign in to comment.