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 format.yml #12567

Closed

Conversation

UltralyticsAssistant
Copy link
Member

@UltralyticsAssistant UltralyticsAssistant commented Jan 1, 2024

This pull request adds an improved Ultralytics Actions workflow to automatically format code and documentation to the new Ultralytics official standards maintained at https://github.com/ultralytics/actions.

Four individual actions are run by default. To disable actions, set them to false, i.e. 'python: false'.

To customize an action use a pyproject.toml file in this repo, and see the individual action repo for details.

name: Ultralytics Actions

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  format:
    runs-on: ubuntu-latest
    steps:
      - name: Run Ultralytics Formatting
        uses: ultralytics/actions@main
        with:
          python: true
          docstrings: true
          markdown: true
          spelling: true

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

WARNING ⚠️ this PR is very large, summary may not cover all changes.

🌟 Summary

Streamlined GitHub Actions for automatic code and documentation formatting in Ultralytics repositories.

📊 Key Changes

  • Added a new GitHub Actions workflow .github/workflows/format.yml
  • Adjusted contributing guidelines in CONTRIBUTING.md
  • Modified existing documentation formatting within various .md files
  • Updated code formatting in file benchmarks.py to follow official practices
  • Enhanced the clarity of the codes in classify/predict.py and classify/train.py by refactoring and comments utilization
  • Applied proper code formatting to classify/tutorial.ipynb for better readability
  • Less repetitive code with the TFLite export feature in export.py
  • Minor formatting improvements in hubconf.py, models/common.py, models/experimental.py, models/tf.py, and models/yolo.py
  • Enhanced documentation for the results of model validation in segment/predict.py and segment/val.py
  • Cleaned up training script train.py for a better understanding of the training process

🎯 Purpose & Impact

The primary benefits of these changes include:

  • 📚 Improved code maintainability with consistent formatting
  • 👨‍💻 Developers can contribute more easily due to updated contributing guidelines
  • 🚀 Enhanced readability and clarity will potentially reduce bugs and make code alterations more efficient
  • 🧹 Clean and standardized documentation enhances the overall presentation for end users

@glenn-jocher glenn-jocher deleted the update-format-workflow-20240101224504 branch January 2, 2024 16:42
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

2 participants