feat: implement check-data subcommand for fast dataset validation#19
Open
revaarathore11 wants to merge 1 commit into
Open
feat: implement check-data subcommand for fast dataset validation#19revaarathore11 wants to merge 1 commit into
revaarathore11 wants to merge 1 commit into
Conversation
Author
|
@Marmotia1 please review |
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
1 participant
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.
Summary
This PR introduces a new check-data subcommand to both the main reconstruction pipeline and the batch processing tool. The command allows contributors to quickly verify that their dataset (directories and .ply files) is correctly structured and accessible before running expensive preprocessing or reconstruction steps.
Key Changes
🧩 Centralized Validation Logic
• Introduced cli_utils.py to host shared dataset validation and reporting logic
• Ensures consistent behavior across main_pipeline.py and batch_processor.py
• Eliminates duplicated validation code
🔒 Strictly Side-Effect Free
• Validation is fully read-only
• Uses path traversal and permission checks (os.access)
• Never creates directories, files, or temporary artifacts
✅ Improved UX
• Clear, standardized output with explicit PASS / FAIL status
• Actionable error messages to help users fix dataset issues quickly
⚡ Lightweight & Fast
• Avoids heavy dependencies (e.g. open3d, numpy)
• Near-instant execution, suitable for early dataset verification
📚 Documentation Updates
• Updated README_ONBOARDING.md with:
• Usage instructions
• Examples
• Guidance on when to use check-data vs the full validate workflow
🧹 Repository Hygiene
• Updated .gitignore to prevent tracking of:
• pycache/
• Compiled Python artifacts (*.pyc)
Usage Examples
python main_pipeline.py check-data <dataset_path>
python batch_processor.py check-data <dataset_path>