Add mention of SpielViz in documentation.

rickshilling · Sep 7, 2020 · aa816ae · aa816ae
1 parent 3f79a3c
commit aa816ae
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -237,3 +237,7 @@ release!). Contributions are certainly not limited to these suggestions!
     for running a batch of episodes using Tensorflow directly from C++ (in
     `contrib/`). It has not yet been tested with CMake and public Tensorflow. We
     would like to officially support this and move it into the core library.
+
+-   **Visualizations of games**. There exists an interactive viewer for
+    OpenSpiel games called [SpielViz](https://github.com/michalsustr/spielviz).
+    Contributions to this project are welcome.  
diff --git a/docs/developer_guide.md b/docs/developer_guide.md
@@ -103,3 +103,11 @@ When you add a new conditional dependency, you need to touch:
 -   change `install.sh` to make sure the dependency is installed
 -   use constructs like `if (${BUILD_WITH_HANABI})` in CMake to optionally add
     the targets to build.
+
+## Debugging tools
+
+For complex games it may be tricky to get all the details right. You can 
+visualize (very small) game trees using 
+`open_spiel/python/examples/treeviz_example.py` or for large games there is 
+an interactive viewer for OpenSpiel games called 
+[SpielViz](https://github.com/michalsustr/spielviz).
diff --git a/docs/intro.md b/docs/intro.md
@@ -40,3 +40,8 @@ available from Python.
 
 OpenSpiel has been tested on Linux (Debian 10 and Ubuntu 19.04), MacOS, and
 [Windows 10 (through Windows Subsystem for Linux)](windows.md).
+
+**Visualization of games**
+
+There is an interactive viewer for OpenSpiel games called 
+[SpielViz](https://github.com/michalsustr/spielviz).