Example, Log and Doc refine#68
Merged
Merged
Conversation
MGAMZ
added
documentation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refines documentation, examples, and logging across the ITKIT project as part of the v4.0.0rc3 release. The changes primarily focus on simplifying documentation by removing verbose instructions and updating example configurations with improved parameters.
Changes:
- Version bumped from 4.0.0rc2 to 4.0.0rc3
- Removed notebooks folder and simplified extensive documentation sections
- Updated example configurations with refined hyperparameters (window levels, window widths, patch sizes, and sr_ratios)
- Changed verbose log message from INFO to DEBUG level for better log clarity
Reviewed changes
Copilot reviewed 24 out of 24 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| pyproject.toml | Version bump to 4.0.0rc3 |
| notebooks/filter_itk_patched_only_background.ipynb | Deleted notebook for filtering background patches |
| mkdocs.yml | Removed quickstart.md and preprocessing.md from navigation |
| itkit/dataset/base.py | Changed filter preview log level from INFO to DEBUG |
| examples/configs/*/mgam.py | Updated window parameters and patch sizes for better defaults |
| examples/configs/*/SegFormer3D.py | Simplified sr_ratios from tuples to integers |
| docs/slicer_integration.md | Removed extensive usage documentation, kept essential information |
| docs/quickstart.md | Deleted file with basic tutorial content |
| docs/preprocessing.md | Deleted file with preprocessing overview |
| docs/models.md | Changed type from string to type reference (consistent with codebase) |
| docs/installation.md | Removed troubleshooting section |
| docs/index.md | Removed quickstart and preprocessing references, simplified navigation |
| docs/datasets.md | Removed verbose categorical listings, kept essential conversion info |
| docs/contributing.md | Removed extensive development workflow documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #68 +/- ##
=======================================
Coverage ? 72.14%
=======================================
Files ? 108
Lines ? 12167
Branches ? 1085
=======================================
Hits ? 8778
Misses ? 3139
Partials ? 250 ☔ View full report in Codecov by Sentry. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
notebooksfolder.📚 Documentation preview 📚: https://ITKIT--68.org.readthedocs.build/en/68/