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

Ultralytics HUB Docs #462

Closed
wants to merge 9 commits into from
Closed

Ultralytics HUB Docs #462

wants to merge 9 commits into from

Conversation

sergiuwaxmann
Copy link
Member

@sergiuwaxmann sergiuwaxmann commented Nov 9, 2023

This PR adds Ultralytics HUB Docs using MkDocs.

ultralytics_hub_docs_preview

  1. Create venv.
    python -m venv venv
  2. Activate venv.
    source venv/bin/activate
  3. Install requirements.
    pip install mkdocs
    pip install mkdocs-material
  4. Serve docs.
    mkdocs serve

copilot:all

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

📊 Key Changes

  • Added Ultralytics HUB Docs with detailed instructions for:
    • Android app usage 📱
    • Model management and deployment 🚀
    • Dataset upload and sharing 🔄
    • Getting started guide and integration options ⚙️
    • CSS styles for better presentation 🎨

🎯 Purpose & Impact

  • Improves user experience by providing comprehensive guidance 📖
  • Enables users to effectively use HUB features and mobile applications 🌐
  • Facilitates new users' ability to get started with the platform quickly 🏁

🌟 Summary

New Ultralytics HUB Docs provide all the necessary information, tutorials, and guidelines for users to kick-start their projects with YOLO models on Ultralytics HUB, including seamless model training, management, deployment, and real-time application on iOS and Android devices. 🌐📚🚀

Copy link

@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 @sergiuwaxmann, thank you for submitting a YOLO 🚀 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/hub 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 main locally.
  • ✅ Verify all Continuous Integration (CI) checks are passing.
  • ✅ Update Docs for any new or updated features.
  • ✅ 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

See our Contributing Guide for details and let us know if you have any questions!

@sergiuwaxmann sergiuwaxmann deleted the feat/docs branch March 19, 2024 09: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.

3 participants