Skip to content

Improve README accuracy and links#44

Merged
glenn-jocher merged 3 commits into
mainfrom
docs/readme-cleanup
Jun 11, 2026
Merged

Improve README accuracy and links#44
glenn-jocher merged 3 commits into
mainfrom
docs/readme-cleanup

Conversation

@glenn-jocher

@glenn-jocher glenn-jocher commented Jun 11, 2026

Copy link
Copy Markdown
Member

Summary

  • fixes stale or broken README links
  • corrects outdated README claims or examples
  • polishes wording where it improves clarity and professionalism

Validation

  • git diff --check
  • README links/examples checked against repository source and current external sources

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Improves README accuracy by updating setup instructions, execution commands, image references, and licensing links to better match the current repository structure and usage. ✨

📊 Key Changes

  • Clarifies prerequisites by replacing the outdated Python version note with a broader environment requirement compatible with the included PyTorch and TensorFlow examples.
  • Updates dependency installation guidance to use python -m pip install -U -r requirements.txt and links directly to requirements.txt.
  • Removes outdated framework version requirements for torch and refines the TensorFlow note to clarify that train_tf.py uses TensorFlow 1.x APIs.
  • Replaces outdated script references (wave_pytorch.py, wave_tf.py) with current runnable commands using train.py and train_tf.py.
  • Adds a helpful note that train.py auto-downloads wavedata25ns.mat into data/ if missing.
  • Improves Google Cloud guidance by linking directly to gcp/wave_pytorch_gcp.py and the gcp/ helper scripts.
  • Switches README image links from raw GitHub URLs to local repository paths for data/waveforms.png and data/wave.png.
  • Fixes the AGPL license reference by updating the OSI link and changing the LICENSE reference to a relative repository path.

🎯 Purpose & Impact

  • Reduces user confusion by aligning README instructions with the repository’s actual scripts and file layout. ✅
  • Makes setup and execution easier for new users by providing clearer install and run commands. 🚀
  • Improves maintainability by using relative links for local assets and repository files. 🔗
  • Helps prevent environment mismatches, especially for users running the TensorFlow example. 🛠️

@UltralyticsAssistant UltralyticsAssistant added documentation Improvements or additions to documentation enhancement New feature or request priority: low Low urgency; can wait behind higher-priority work. labels Jun 11, 2026
@UltralyticsAssistant

Copy link
Copy Markdown
Member

👋 Hello @glenn-jocher, thank you for submitting a ultralytics/wave 🚀 PR! This is an automated message to help with review readiness—an engineer will assist you soon. Please review the checklist below for a smooth integration process 😊

  • Define a Purpose: Clearly explain the purpose of your fix or feature in your PR description, and link to any relevant issues. Ensure your commit messages are clear, concise, and adhere to the project's conventions.
  • Synchronize with Source: Confirm your PR is synchronized with the ultralytics/wave main branch. If it's behind, update it by clicking the 'Update branch' button or by running git pull and git merge main locally.
  • Ensure CI Checks Pass: Verify all Ultralytics Continuous Integration (CI) checks are passing. If any checks fail, please address the issues.
  • Update Documentation: Update the relevant documentation for any new or modified features.
  • Add Tests: If applicable, include or update tests to cover your changes, and confirm that all tests are passing.
  • Sign the CLA: Please ensure you have signed our Contributor License Agreement if this is your first Ultralytics PR by writing "I have read the CLA Document and I sign the CLA" in a new message.
  • Minimize Changes: Limit your changes to the minimum necessary 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

For more guidance, please refer to our Contributing Guide. Don't hesitate to leave a comment if you have any questions. Thank you for contributing to Ultralytics! 🚀

@UltralyticsAssistant UltralyticsAssistant left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

🔍 PR Review

Made with ❤️ by Ultralytics Actions

README-only change looks clean. The updates consistently improve accuracy and repository-local links without introducing any obvious documentation errors in the changed lines.

@glenn-jocher glenn-jocher merged commit 4c814a7 into main Jun 11, 2026
3 checks passed
@glenn-jocher glenn-jocher deleted the docs/readme-cleanup branch June 11, 2026 03:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request priority: low Low urgency; can wait behind higher-priority work.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants