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.

Sign up for GitHub

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

Jump to bottom

Option to return more info from Stockfish in .get_top_moves() #115

Closed
wants to merge 3 commits into from
Closed

Option to return more info from Stockfish in .get_top_moves() #115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8a5ebdc
Add include_info=True flag to .get_top_moves()
knutole Sep 29, 2022
c201434
Update stockfish/models.py
knutole Apr 4, 2023
0906d2e
Update readme with include_info flag
knutole Apr 5, 2023
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
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,8 +130,9 @@ True

### Get info on the top n moves
```python
stockfish.get_top_moves(3)
stockfish.get_top_moves(3, include_info=False)
```
Optional parameter `include_info` specifies whether to include the full info from the engine in the returned dictionary, including seldepth, multipv, time, nodes, nps, and wdl if available. Boolean. Default is `False`.
```text
[
{'Move': 'f5h7', 'Centipawn': None, 'Mate': 1},
Expand Down
64 changes: 49 additions & 15 deletions stockfish/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -514,18 +514,28 @@ def get_evaluation(self) -> dict:
elif splitted_text[0] == "bestmove":
return evaluation

def get_top_moves(self, num_top_moves: int = 5) -> List[dict]:
def get_top_moves(
self, num_top_moves: int = 5, include_info: bool = False
) -> List[dict]:
"""Returns info on the top moves in the position.

Args:
num_top_moves:
The number of moves to return info on, assuming there are at least
those many legal moves.

include_info:
Option to include the full info from the engine in the returned dictionary,
including seldepth, multipv, time, nodes, nps, and wdl if available.
Boolean. Default is False.

Returns:
A list of dictionaries. In each dictionary, there are keys for Move, Centipawn, and Mate;
the corresponding value for either the Centipawn or Mate key will be None.
If there are no moves in the position, an empty list is returned.

If include_info is True, the dictionary will also include the keys SelectiveDepth, Time,
Nodes, N/s, MultiPVLine, and WDL (if available). WDL is set from the White player's perspective.
"""

if num_top_moves <= 0:
Expand Down Expand Up @@ -562,20 +572,44 @@ def get_top_moves(self, num_top_moves: int = 5) -> List[dict]:
raise RuntimeError(
"Having a centipawn value and mate value should be mutually exclusive."
)
top_moves.insert(
0,
{
"Move": current_line[current_line.index("pv") + 1],
"Centipawn": int(current_line[current_line.index("cp") + 1])
* multiplier
if has_centipawn_value
else None,
"Mate": int(current_line[current_line.index("mate") + 1])
* multiplier
if has_mate_value
else None,
},
)
move_evaluation = {
"Move": current_line[current_line.index("pv") + 1],
"Centipawn": int(current_line[current_line.index("cp") + 1])
* multiplier
if has_centipawn_value
else None,
"Mate": int(current_line[current_line.index("mate") + 1])
* multiplier
if has_mate_value
else None,
}
if include_info:
move_evaluation.update(
{
"Nodes": current_line[current_line.index("nodes") + 1],
"N/s": current_line[current_line.index("nps") + 1],
"Time": current_line[current_line.index("time") + 1],
"SelectiveDepth": current_line[
current_line.index("seldepth") + 1
],
"MultiPVLine": current_line[
current_line.index("multipv") + 1
],
}
)
if self.does_current_engine_version_have_wdl_option():
move_evaluation.update(
{
"WDL": " ".join(
[
current_line[current_line.index("wdl") + 1],
current_line[current_line.index("wdl") + 2],
current_line[current_line.index("wdl") + 3],
][::multiplier]
)
}
)
top_moves.insert(0, move_evaluation)
else:
break
if old_MultiPV_value != self._parameters["MultiPV"]:
Expand Down
25 changes: 25 additions & 0 deletions tests/stockfish/test_models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -571,6 +571,31 @@ def test_get_top_moves_mate(self, stockfish):
assert stockfish.get_top_moves() == []
assert stockfish.get_parameters()["MultiPV"] == 3

def test_get_top_moves_with_info(self, stockfish):
stockfish.set_depth(15)
stockfish._set_option("MultiPV", 4)
stockfish.set_fen_position("1rQ1r1k1/5ppp/8/8/1R6/8/2r2PPP/4R1K1 w - - 0 1")
assert stockfish.get_top_moves(2, include_info=False) == [
{"Move": "e1e8", "Centipawn": None, "Mate": 1},
{"Move": "c8e8", "Centipawn": None, "Mate": 2},
]
moves = stockfish.get_top_moves(2, include_info=True)
assert all(
k in moves[0]
for k in (
"Move",
"Centipawn",
"Mate",
"MultiPVLine",
"N/s",
"Nodes",
"SelectiveDepth",
"Time",
)
)
if stockfish.does_current_engine_version_have_wdl_option():
assert "WDL" in moves[0]

def test_get_top_moves_raising_error(self, stockfish):
stockfish.set_fen_position(
"rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1"
Expand Down