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

Add missing Python function docstrings #13105

Merged
merged 3 commits into from
Jun 19, 2024
Merged

Add missing Python function docstrings #13105

merged 3 commits into from
Jun 19, 2024

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Jun 19, 2024

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Refactoring code for better readability and adding fallbacks to prevent errors.

πŸ“Š Key Changes

  • Added a blank line in the learning rate function definition to improve readability.
  • Renamed the forward function to _forward in the yolo.py file to clarify its purpose.
  • Included a fallback method in logger/__init__.py for SummaryWriter to prevent errors if TensorBoard is not installed.

🎯 Purpose & Impact

  • 🧹 Readability Improvement: Small tweaks make the code easier for developers to read and maintain.
  • πŸ› οΈ Function Clarification: Renaming the function helps in understanding its role in the code, making it more intuitive for developers.
  • 🌟 Error Prevention: The fallback for SummaryWriter ensures the system doesn't break if TensorBoard is absent, improving robustness and user experience.

@glenn-jocher glenn-jocher merged commit ec331cb into master Jun 19, 2024
7 checks passed
@glenn-jocher glenn-jocher deleted the docstrings branch June 19, 2024 00:29
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.

2 participants