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

Readme requires updating #48

Closed
glenn-jocher opened this issue Jan 2, 2025 · 2 comments · Fixed by #47
Closed

Readme requires updating #48

glenn-jocher opened this issue Jan 2, 2025 · 2 comments · Fixed by #47
Labels
documentation Improvements or additions to documentation fixed Bug has been resolved

Comments

@glenn-jocher
Copy link
Member

Mentions requirements.txt instead of pyproject.toml

@glenn-jocher glenn-jocher linked a pull request Jan 2, 2025 that will close this issue
@UltralyticsAssistant UltralyticsAssistant added the documentation Improvements or additions to documentation label Jan 2, 2025
@UltralyticsAssistant
Copy link
Member

👋 Hello @glenn-jocher, thank you for submitting a ultralytics/template 🚀 Issue. To help us address your concern efficiently, please provide additional details if applicable:

  1. For bug reports:

    • A clear and concise description of the bug
    • A minimum reproducible example (MRE)[https://docs.ultralytics.com/help/minimum_reproducible_example/] that demonstrates the issue
    • Your environment details (OS, Python version, package versions)
    • Expected behavior vs. actual behavior
    • Any error messages or logs related to the issue
  2. For feature requests:

    • A clear and concise description of the proposed feature
    • The problem this feature would solve
    • Any alternative solutions you've considered
  3. For documentation updates/errors:

    • Specify the section or file (e.g., README.md) requiring changes
    • Suggest the corrections or updates needed
    • Include any supporting details, such as links or code examples, to clarify your proposal
  4. For questions:

    • Provide as much context as possible about your question
    • Include any research you've already done on the topic
    • Specify which parts of the documentation, if any, you've already consulted

Please make sure you've searched existing issues to avoid duplicates. If you need to add or clarify any information, feel free to comment on this issue. An Ultralytics engineer will assist you soon too. Thank you for helping enhance our project! 🚀✨

@UltralyticsAssistant UltralyticsAssistant added the fixed Bug has been resolved label Jan 2, 2025
@UltralyticsAssistant
Copy link
Member

A potential fix for this issue has been merged in PR #47, authored by @fcakyon with contributions from @glenn-jocher. 🎉

🚀 Key Changes from the PR:

  1. Modernized Dependency Management:
    • Transitioned from using setup.py and requirements.txt to pyproject.toml, aligning with modern Python development best practices.
    • Simplified dependency and packaging management to streamline project workflows.
  2. Improved Documentation:
    • Updated customization instructions to better explain how to manage dependencies and modify the project as needed.
    • Added clarity to optional components for easier customization.
  3. General Refinement: Minor enhancements to make the template more robust and user-friendly for contributors and new projects.

These changes aim to address automation and compatibility challenges to make workflows significantly smoother.

🧪 How to Test:

To check if this resolves the issue:

  • Install the latest changes directly with:
    pip install git+https://github.com/ultralytics/ultralytics.git@main
  • Alternatively, await the next official PyPI release.

Feedback on whether this resolves the issue would be greatly appreciated! If any related issues persist, feel free to share details for further investigation. 🙌

Thank you for reporting this and improving the project—your input is invaluable. 🙏 Looking forward to hearing how it works for you!

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 fixed Bug has been resolved
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants