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 action.yml to ignore model files #48

Merged
merged 1 commit into from
Jan 9, 2024
Merged

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Jan 9, 2024

@sersiossm ignores model files now!

Thank you πŸ™ for your contribution to Ultralytics πŸš€! Your effort in enhancing our repositories is greatly appreciated. To streamline the process and assist us in integrating your Pull Request (PR) effectively, please follow these steps:

  1. Check for Existing Contributions: Before submitting, kindly explore existing PRs to ensure your contribution is unique and complementary.

  2. Link Related Issues: If your PR addresses an open issue, please link it in your submission. This helps us better understand the context and impact of your contribution.

  3. Elaborate Your Changes: Clearly articulate the purpose of your PR. Whether it's a bug fix or a new feature, a detailed description aids in a smoother integration process.

  4. Ultralytics Contributor License Agreement (CLA): To uphold the quality and integrity of our project, we require all contributors to sign the CLA. Please confirm your agreement by commenting below:

    I have read the CLA Document and I hereby sign the CLA

For more detailed guidance and best practices on contributing, refer to our βœ… Contributing Guide. Your adherence to these guidelines ensures a faster and more effective review process.

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Enhanced spelling checks in CI pipeline by refining ignored file patterns.

πŸ“Š Key Changes

  • Expanded the --skip list in codespell to include additional machine learning model file extensions.
  • Previously skipping *.csv, *.onnx, and *.pt files, the new pattern now excludes:
    • *.pth
    • *.torchscript
    • *.tflite
    • *.pb
    • *.bin
    • *.param
    • *.mlmodel
    • *.engine

🎯 Purpose & Impact

  • Purpose: To prevent codespell from unnecessarily scanning binary or model-specific files, as these typically won't contain human-generated spelling errors that the tool is designed to catch.
  • Impact: Users should see a cleaner and more relevant output from the spelling check step in the CI (Continuous Integration) process, reducing distractions from false positives and focusing attention on actual text-based code or documentation issues. This leads to more efficient code reviews and maintenance.

@sersiossm ignores model files now!
@glenn-jocher glenn-jocher merged commit c656ea7 into main Jan 9, 2024
1 check passed
@glenn-jocher glenn-jocher deleted the ignore_models branch January 9, 2024 11:23
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.

None yet

1 participant