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

Improve README #45

Merged
merged 2 commits into from
Dec 5, 2023
Merged

Improve README #45

merged 2 commits into from
Dec 5, 2023

Conversation

pderrenger
Copy link
Member

@pderrenger pderrenger commented Dec 5, 2023

This pull request attempts to improve the repo README file with additional context and content.

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Revamped README for better usability and clarity in the Ultralytics xView YOLOv3 repository.

πŸ“Š Key Changes

  • Improved introduction with more engaging repository description.
  • Streamlined installation process: simplified dependency instructions with a pip command.
  • Detailed preprocessing steps for clarity before training.
  • Described how to start and resume training, emphasizing the import of avoiding overtraining.
  • Presented a comprehensive table detailing image augmentations used during training.
  • Included instructions for citing the work if used in research.
  • Updated visual aesthetics for contributor section and clarified licensing options.

🎯 Purpose & Impact

  • πŸ“ The rewritten documentation aims to make it easier for users to get started with the project, reducing the time to jump from cloning the repo to actual training.
  • πŸ” Image augmentation details help users understand the data transformation processes and set expectations for model behavior.
  • πŸ› οΈ The explanation of how to manage training progress empowers users to efficiently manage their training sessions.
  • πŸ“ˆ Highlighting overtraining risks provides guidance for achieving optimal model performance.
  • πŸŽ“ Citing instructions ensure academic users credit the repository properly, fostering collaboration and recognition of Ultralytics work.
  • πŸ“± Refreshed contributor and license sections offer a cleaner presentation and help users choose the right license for their use case.

@glenn-jocher glenn-jocher merged commit cc7be70 into master Dec 5, 2023
1 check passed
@glenn-jocher glenn-jocher deleted the update-readme-20231205223012 branch December 5, 2023 21:31
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