Skip to content

Commit

Permalink
OpenSpiel cleanup: mark R-NaD, Go API, and Rust API as no longer main…
Browse files Browse the repository at this point in the history
…tained. Leave the code in case anybody wants to use/see it.

Resolves: #1075, #1109, #1178, #1301.
PiperOrigin-RevId: 712500468
Change-Id: I4901e919de6337f7f1aeb7acb186075f49f96d14
  • Loading branch information
lanctot committed Jan 6, 2025
1 parent aae2c1e commit d99705d
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 21 deletions.
7 changes: 3 additions & 4 deletions docs/developer_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,12 +183,11 @@ Leduc poker. We will use an example based on this

## Language APIs

There are currently four other language APIs that expose functionality from the
C++ core.
There are four other language APIs that expose functionality from the C++ core.

- [Python](https://github.com/deepmind/open_spiel/tree/master/open_spiel/python).
- [Julia](https://github.com/deepmind/open_spiel/tree/master/open_spiel/julia)
- [Go](https://github.com/deepmind/open_spiel/tree/master/open_spiel/go)
(experimental)
(unmaintained)
- [Rust](https://github.com/deepmind/open_spiel/tree/master/open_spiel/rust)
(experimental)
(unmaintained)
16 changes: 0 additions & 16 deletions open_spiel/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,6 @@ endmacro()
# List of all optional dependencies:
openspiel_optional_dependency(OPEN_SPIEL_BUILD_WITH_ACPC OFF
"Build against the Universal Poker library.")
openspiel_optional_dependency(OPEN_SPIEL_BUILD_WITH_GO OFF
"Build with support for Golang API.")
openspiel_optional_dependency(OPEN_SPIEL_BUILD_WITH_HANABI OFF
"Build against the Hanabi game.")
openspiel_optional_dependency(OPEN_SPIEL_BUILD_WITH_JULIA OFF
Expand All @@ -127,8 +125,6 @@ openspiel_optional_dependency(OPEN_SPIEL_BUILD_WITH_GAMUT OFF
"Build with GAMUT generator integration.")
openspiel_optional_dependency(OPEN_SPIEL_BUILD_WITH_ORTOOLS OFF
"Build with C++ optimization library OR-Tools.")
openspiel_optional_dependency(OPEN_SPIEL_BUILD_WITH_RUST OFF
"Build with support for Rust API.")

if (WIN32)
openspiel_optional_dependency(OPEN_SPIEL_ENABLE_JAX OFF
Expand Down Expand Up @@ -280,18 +276,6 @@ add_subdirectory (examples)
add_subdirectory (games)
add_subdirectory (game_transforms)

if (OPEN_SPIEL_BUILD_WITH_GO)
message(WARNING
"GO API is disabled for now due to failing tests.\n"
"See https://github.com/google-deepmind/open_spiel/issues/1301."
)
# add_subdirectory(go)
endif()

if (OPEN_SPIEL_BUILD_WITH_RUST)
add_subdirectory(rust)
endif()

if (OPEN_SPIEL_BUILD_WITH_PYTHON)
add_subdirectory (python)
endif()
Expand Down
4 changes: 4 additions & 0 deletions open_spiel/go/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# OpenSpiel Go API

*Note:* This API has issues and is no longer maintained. See
[issue 1301](https://github.com/google-deepmind/open_spiel/issues/1301) for
details.

This is a basic [Go](https://golang.org/) API for OpenSpiel. Please note that it
is currently experimental and may not work as expected. Please see the
[announcement thread](https://github.com/deepmind/open_spiel/issues/541) and
Expand Down
1 change: 0 additions & 1 deletion open_spiel/python/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,6 @@ if (OPEN_SPIEL_ENABLE_JAX)
jax/nfsp_jax_test.py
jax/opponent_shaping_jax_test.py
jax/policy_gradient_jax_test.py
algorithms/rnad/rnad_test.py
coalitional_games/least_core_lagrangian_test.py
mfg/algorithms/fictitious_play_test.py
)
Expand Down
2 changes: 2 additions & 0 deletions open_spiel/python/algorithms/rnad/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
*Note:* This implementation is no longer maintained.

This folder contains an single process implementation of [R-NaD]
(https://arxiv.org/pdf/2206.15378.pdf)

Expand Down
2 changes: 2 additions & 0 deletions open_spiel/rust/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# OpenSpiel Rust API

*Note:* This API is no longer maintained.

This is a basic [Rust](https://www.rust-lang.org/) API for OpenSpiel. Please
note that it is currently experimental and may not work as expected. If you use
it, please report any issues. Fixes and improvements are more than welcome!
Expand Down

0 comments on commit d99705d

Please sign in to comment.