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 README.md and README.zh-CN.md #11434

Merged
merged 1 commit into from
Apr 25, 2023
Merged

Conversation

xhx787
Copy link
Contributor

@xhx787 xhx787 commented Apr 25, 2023

When predicts, the configure 'data' means the details obout dataset such as label and the 'source' means the picture chosen to detect.
When I run the code given by readme, the module predicts all the files in the default directory.
You should pay attention to this.

copilot:all

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Adjustment of command line examples in READMEs for consistency and clarity.

📊 Key Changes

  • Updated command line examples replacing --data flag with --source in both English and Chinese README files.

🎯 Purpose & Impact

  • Consistency: Ensures all command examples use the same flag for specifying input, which makes understanding and using the codebase easier.
  • Clarity: Clarifies the purpose of the flag to new users, indicating it's meant for the input source (e.g., an image file) rather than a dataset or data configuration.
  • User Experience: Improved documentation leads to a smoother onboarding process for new users, minimizes confusion, and decreases the potential for user errors.

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👋 Hello @xhx787, thank you for submitting a YOLOv5 🚀 PR! To allow your work to be integrated as seamlessly as possible, we advise you to:

  • ✅ Verify your PR is up-to-date with ultralytics/yolov5 master branch. If your PR is behind you can update your code by clicking the 'Update branch' button or by running git pull and git merge master locally.
  • ✅ Verify all YOLOv5 Continuous Integration (CI) checks are passing.
  • ✅ Reduce changes to the absolute minimum required for your bug fix or feature addition. "It is not daily increase but daily decrease, hack away the unessential. The closer to the source, the less wastage there is." — Bruce Lee

@xhx787 xhx787 changed the title readme.md and readme-zh.md have something wrong Update README.md and README.zh-CN.md Apr 25, 2023
@glenn-jocher
Copy link
Member

@xhx787 thank you yes you are right, these are good corrections!

@glenn-jocher glenn-jocher merged commit 8ecc727 into ultralytics:master Apr 25, 2023
bandakopi pushed a commit to irajcode/yolov5 that referenced this pull request Jul 20, 2023
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