Updating notebooks

[Xmaster6y]

closes #21

Summary by Sourcery

This pull request refactors the Sampler class and its subclasses to handle multiple boards, introduces new methods for evaluating multiple puzzles, and updates the documentation and tests accordingly. Additionally, a new notebook for running models on GPU has been added.

• New Features:
  • Added support for evaluating multiple puzzles simultaneously with the evaluate_multiple method in the Puzzle class.
  • Introduced a new board_move_generator method in the Puzzle class to yield board and move pairs.
  • Added a new notebook for running models on GPU with Colab integration.
• Enhancements:
  • Refactored Sampler class methods to handle multiple boards instead of a single board.
  • Updated RandomSampler, ModelSampler, and PolicySampler to work with iterable boards.
  • Improved the Puzzle class to handle cases where themes or opening tags are None.
  • Enhanced the Puzzle class with a __len__ method to return the number of moves.
  • Updated the README.md to include new feature links and Colab badges.
  • Modified Sphinx configuration to adjust navigation and table of contents levels.
• Documentation:
  • Updated documentation links in README.md to point to the latest ReadTheDocs pages.
  • Added a new notebook for evaluating models on puzzles with Colab integration.
• Tests:
  • Added new unit tests for the Puzzle class to verify puzzle creation and usage.
  • Updated existing tests to accommodate changes in Sampler class methods.
  • Removed BatchedPolicySampler and updated tests to use PolicySampler instead.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request updates the README.md to provide direct links to the rendered HTML versions of the notebooks on ReadTheDocs and modifies the Sphinx configuration to improve navigation and table of contents settings. Additionally, it includes significant changes to the Sampler classes in the sampling module, updates to the Puzzle class, and enhancements to the unit tests.

File-Level Changes

Files	Changes
src/lczerolens/play/sampling.py src/lczerolens/play/puzzle.py	Refactored Sampler and Puzzle classes to handle multiple boards and added methods for evaluating multiple puzzles and computing metrics.
tests/unit/core/test_puzzle.py tests/unit/core/test_sampling.py	Updated unit tests to handle iterable returns from methods and added new tests for evaluating multiple puzzles.
README.md docs/source/conf.py	Updated documentation links and Sphinx configuration for improved navigation and table of contents settings.

---

Tips

• Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
• Continue your discussion with Sourcery by replying directly to review comments.
• You can change your review settings at any time by accessing your dashboard:
  • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
  • Change the review language;
• You can always contact us if you have any questions or feedback.

[sourcery-ai]

Hey @Xmaster6y - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟡 General issues: 2 issues found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟡 Documentation: 5 issues found

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}

[Xmaster6y]

@sourcery-ai review

[sourcery-ai]

Hey @Xmaster6y - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟡 General issues: 12 issues found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟡 Complexity: 1 issue found
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}

[sourcery-ai]

suggestion: Consider consolidating widget state definitions.

There are multiple widget state definitions that appear to be very similar. Consider consolidating these definitions to reduce redundancy and improve maintainability.