Initial commit

CONTRIBUTING.md

@@ -0,0 +1,37 @@
+# Contributing to DarkForest Go engine
+We want to make contributing to this project as easy and transparent as possible.  
+We also welcome any fork attempt from this project.  
+
+## Our Development Process
+DarkForest Go engine has been developed mainly by Yuandong Tian and Yan Zhu from Facebook AI Research since May 2015.  
+Since it opens to the public, its future development will be conducted in this open source branch.  
+
+## Bug reports
+Please follow the steps when you find a bug:
+
+1. use the Github issue search to check if the issue has been addressed before. 
+2. Make sure if the issue has been fixed by synchronizing the most recent branch in the repository. 
+3. Write a simple and easy-to-understand test case that reveals the issue. We use github issues to track public bugs. please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.
+
+## Pull Requests
+We actively welcome your pull requests.
+
+1. Fork the repo and create your branch from `master`.
+2. If you've added code that should be tested, add tests.
+3. If you've changed APIs, update the documentation.
+4. Ensure the test suite passes.
+5. Make sure your code lints.
+6. If you haven't already, complete the Contributor License Agreement ("CLA").
+
+## Contributor License Agreement ("CLA")
+In order to accept your pull request, we need you to submit a CLA. You only need
+to do this once to work on any of Facebook's open source projects.
+
+Complete your CLA here: <https://code.facebook.com/cla>
+
+## Coding Style  
+* 2 spaces for indentation rather than tabs
+* 80 character line length
+
+## License
+By contributing to DarkForest Go engine, you agree that your contributions will be licensed under its BSD license.

LICENSE

@@ -0,0 +1,30 @@
+BSD License
+
+For DarkForest Go software
+
+Copyright (c) 2016-present, Facebook, Inc. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+ * Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+ * Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+ * Neither the name Facebook nor the names of its contributors may be used to
+   endorse or promote products derived from this software without specific
+   prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

PATENTS

@@ -0,0 +1,33 @@
+Additional Grant of Patent Rights Version 2
+
+"Software" means the DarkForest Go software distributed by Facebook, Inc.
+
+Facebook, Inc. ("Facebook") hereby grants to each recipient of the Software
+("you") a perpetual, worldwide, royalty-free, non-exclusive, irrevocable
+(subject to the termination provision below) license under any Necessary
+Claims, to make, have made, use, sell, offer to sell, import, and otherwise
+transfer the Software. For avoidance of doubt, no license is granted under
+Facebook’s rights in any patent claims that are infringed by (i) modifications
+to the Software made by you or any third party or (ii) the Software in
+combination with any software or other technology.
+
+The license granted hereunder will terminate, automatically and without notice,
+if you (or any of your subsidiaries, corporate affiliates or agents) initiate
+directly or indirectly, or take a direct financial interest in, any Patent
+Assertion: (i) against Facebook or any of its subsidiaries or corporate
+affiliates, (ii) against any party if such Patent Assertion arises in whole or
+in part from any software, technology, product or service of Facebook or any of
+its subsidiaries or corporate affiliates, or (iii) against any party relating
+to the Software. Notwithstanding the foregoing, if Facebook or any of its
+subsidiaries or corporate affiliates files a lawsuit alleging patent
+infringement against you in the first instance, and you respond by filing a
+patent infringement counterclaim in that lawsuit against that party that is
+unrelated to the Software, the license granted hereunder will not terminate
+under section (i) of this paragraph due to such counterclaim.
+
+A "Necessary Claim" is a claim of a patent owned by Facebook that is
+necessarily infringed by the Software standing alone.
+
+A "Patent Assertion" is any lawsuit or other action alleging direct, indirect,
+or contributory infringement or inducement to infringe any patent, including a
+cross-claim or counterclaim.

README.md

@@ -0,0 +1,112 @@
+Facebook DarkForest Go Project
+========
+
+Build
+------------
+Dependency: 
+
+1. Install [torch7](http://torch.ch/docs/getting-started.html).
+2. Install luarocks: class, image, tds, cudnn
+
+For Cudnn, please install the driver from NVidia. This program supports 1-4 GPUs.
+
+Then just compile with the following command:
+
+```bash
+sh ./compile.sh
+```
+
+GCC 4.8+ is required. Tested in CentOS 6.5. 
+
+Usage
+------------
+Step 1: First run the GPU server 
+
+```bash
+cd ./local_evaluator     
+sh cnn_evaluator.sh [num_gpu] [pipe file path]
+```
+
+* `num_gpu`         the number of GPUs you have for the current machine. 
+* `pipe file path`  The location that the pipe file is settled. Default is /data/local/go/
+
+Step 2: Run the main program
+
+```bash
+cd ./CNNPlayerV2     
+th cnnPlayerMCTSV2.lua --num_gpu [num_gpu]
+```
+
+When you are in the interactive environment, type 
+
+* `clear_board` to clear the board
+* `genmove b`    to genmove the black move.
+* `play w Q4`    to play a move at Q4 for specific color.
+* `quit`         to quit.
+
+For more commands, please use command `list_commands`, check the details of [GTP protocol](http://senseis.xmp.net/?GTP) or take a look at the source code (in ./CNNPlayerV2/cnnPlayerV2Framework.lua). 
+
+Award
+--------------
+* Stable **KGS 5d**. [link](http://www.gokgs.com/graphPage.jsp?user=darkfmcts3)
+* 3rd place in KGS Go Tournament. [link](http://www.weddslist.com/kgs/past/119/index.html)
+* 2nd place in UEC Computer Go Cup. [link](http://jsb.cs.uec.ac.jp/~igo/eng/result2.html)
+
+Trouble Shooting 
+----------------
+**Q**: My program hanged on genmove/quit, what happened?  
+**A**: Make sure you run the GPU server under ./local\_evaluator, the server remains active and the pipe file path matches between the server and the client.
+
+If you have any questions, please open a github issue.
+
+Code Overview
+-------------
+
+The system consists of the following parts. 
+
+* `./CNNPlayerV2`  
+Lua (terminal) interface for Go.   
+
+1. `CNNPlayerV3.lua`              Run Pure-DCNN player
+2. `CNNPlayerMCTSV2.lua`          Run player with DCNN + MCTS
+
+* `./board`   
+Things about board and its evaluations. Board data structure and different playout policy.
+
+* `./mctsv2`  
+Implementation of Monte Carlo Tree Search
+
+* `./local_evaluator`  
+Simple GPU-based server. Communication with search threads via pipe. 
+
+* `./utils`  
+Simple utilities, e.g., read/write sgf files.
+
+* `./test`  
+Test utilities.
+
+* `./train`  
+Training code (to be released soon).
+
+* `./models`  
+All pre-trained models. Please download them elsewhere.
+
+* `./sgfs`
+Some exemplar sgf files.
+
+License
+----------
+Please check LICENSE file for the license of Facebook DarkForest Go engine. 
+
+Reference
+----------
+If you use the pre-trained models or any engine, please reference the following paper:
+
+```
+Better Computer Go Player with Neural Network and Long-term Prediction, ICLR 2016  
+Yuandong Tian, Yan Zhu
+```
+
+Here is the arxiv [link](http://arxiv.org/abs/1511.06410)
+
+

board/.gitignore

@@ -0,0 +1,3 @@
+*.txt
+ctags
+tags