Functions for static evaluation and resuming full strength. Also updated docs and added warnings for weaker settings.

py-stockfish / stockfish

Integrates the Stockfish chess engine with Python (Official fork)

https://py-stockfish.github.io/stockfish/

MIT License

29 stars 8 forks source link

Functions for static evaluation and resuming full strength. Also updated docs and added warnings for weaker settings. #38

Closed johndoknjas closed 1 year ago

johndoknjas commented 1 year ago

Resolves #35 by updating the documentation for get_top_moves, to note that full strength is used even if the user lowered elo or skill level. In addition, a warning is issued in get_top_moves, if the elo or skill level has been lowered.
Continuing in the vein of the previous point, warnings are also issued in get_evaluation and get_wdl_stats, if the engine is on a weaker setting.
Resolves #37 by adding a function to get the static evaluation. Also slightly updated the docs for get_evaluation to specify what is done in more detail.
Added a function that allows the user to reset stockfish back to full strength, if they had previously lowered the elo or skill level.

github-actions[bot] commented 1 year ago

Coverage report

The coverage rate went from 95.99% to 93.35% :arrow_down: The branch rate is 88%.

96.29% of new lines are covered.

Diff Coverage details (click to unfold)

### stockfish/models.py `96.29%` of new lines are covered (`93.35%` of the complete file). Missing lines: `760`

johndoknjas commented 1 year ago

@kieferro Great, thx! I've added one more commit, which issues warnings if stockfish is set on a lower strength in some functions. I'll merge the PR in a day or two if there's nothing in this commit you'd prefer changed, and if nothing else comes up in discussions related to this PR.

kieferro commented 1 year ago

@johndoknjas The last change with the warnings looks good.

I'll merge the PR in a day or two if nothing else comes up in discussions related to this PR.

:+1: