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.

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

Update the documentation #28

Merged
merged 13 commits into from
Jul 3, 2024
Merged

Update the documentation #28

merged 13 commits into from
Jul 3, 2024

Conversation

Xmaster6y
Copy link
Owner

@Xmaster6y Xmaster6y commented Jul 3, 2024

closes #20

Summary by Sourcery

This pull request updates the documentation by adding new sections and Colab notebooks, refactors code for better modularity and readability, updates tests to reflect these changes, and removes an unused template file.

  • Enhancements:
    • Refactored play.py to use move_encodings for legal move handling, improving code modularity and readability.
    • Simplified concept class names in concepts module by removing 'Concept' suffix.
    • Updated conf.py to show table of contents at level 1 in the documentation.
  • Documentation:
    • Updated README.md to include new sections for Features and Tutorials, replacing detailed code examples with links to Colab notebooks.
    • Added new Colab notebook for 'Convert Official Weights' tutorial.
    • Updated switcher.json to include new documentation versions v0.2.0 and v0.1.2.
    • Updated titles and content of existing Colab notebooks for 'Piece Value Estimation Using LRP' and 'Evidence of Learned Look-Ahead'.
    • Added link to full documentation in README.md.
  • Tests:
    • Updated unit tests in test_concept.py to reflect changes in concept class names.
    • Updated import paths in test_play.py to reflect new module structure.
  • Chores:
    • Deleted unused template file ndif_status.html.

Copy link
Contributor

sourcery-ai bot commented Jul 3, 2024

Reviewer's Guide by Sourcery

This pull request updates the documentation by adding new tutorials and links to Colab notebooks, refactors the concepts and play modules for improved clarity, updates unit tests to reflect these changes, and removes obsolete documentation files.

File-Level Changes

Files Changes
src/lczerolens/concepts/__init__.py
src/lczerolens/concepts/material.py
src/lczerolens/concepts/move.py
src/lczerolens/concepts/threat.py
Refactored the concepts module to simplify class names by removing the 'Concept' suffix.
tests/unit/xai/test_concept.py
tests/unit/core/test_play.py
Updated unit tests to reflect the refactored class names in the concepts module and the refactored play module structure.
docs/source/notebooks/tutorials/wip.ipynb
docs/source/notebooks/features/wip.ipynb
Updated notebook titles to 'Evidence of Learned Look-Ahead' and 'Piece Value Estimation Using LRP'.

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.

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Here's what I looked at during the review
  • 🟡 General issues: 4 issues found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟡 Documentation: 7 issues found

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

src/lczerolens/play.py Show resolved Hide resolved
src/lczerolens/play.py Show resolved Hide resolved
src/lczerolens/encodings/move.py Show resolved Hide resolved
src/lczerolens/encodings/move.py Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
docs/source/start.rst Outdated Show resolved Hide resolved
docs/source/tutorials.rst Show resolved Hide resolved
docs/source/index.rst Outdated Show resolved Hide resolved
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@Xmaster6y
Copy link
Owner Author

@sourcery-ai review

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Here's what I looked at during the review
  • 🟡 General issues: 3 issues found
  • 🟢 Security: all looks good
  • 🟡 Testing: 2 issues found
  • 🟡 Complexity: 1 issue found
  • 🟡 Documentation: 4 issues found

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

src/lczerolens/play.py Show resolved Hide resolved
src/lczerolens/play.py Show resolved Hide resolved
src/lczerolens/play.py Show resolved Hide resolved
tests/unit/xai/test_concept.py Show resolved Hide resolved
tests/unit/xai/test_concept.py Show resolved Hide resolved
README.md Show resolved Hide resolved
docs/source/start.rst Show resolved Hide resolved
README.md Show resolved Hide resolved
docs/source/start.rst Outdated Show resolved Hide resolved
src/lczerolens/concepts/__init__.py Show resolved Hide resolved
@Xmaster6y Xmaster6y merged commit aeebee3 into main Jul 3, 2024
1 check passed
@Xmaster6y Xmaster6y deleted the docs branch July 3, 2024 21:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update the documentation
1 participant