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 docs #142

Merged
merged 2 commits into from
Jun 2, 2024
Merged

Update docs #142

merged 2 commits into from
Jun 2, 2024

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Jun 2, 2024

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Massive documentation overhaul to make Ultralytics HUB-SDK more accessible and comprehensive! πŸš€

πŸ“Š Key Changes

  • Updated documentation descriptions and keywords across various pages to reflect broader coverage and use cases, including dataset management, model operations, project management, and more. πŸ“š
  • Enhanced clarity in the Quickstart Guide, aiming to assist users of all skill levels in getting started with the HUB-SDK. ✨
  • Revised Model Management section to include a corrected code snippet, ensuring better utility and user experience. πŸ› οΈ
  • Encapsulated detailed descriptions and keywords for reference sections, including API Client, CRUDClient, and HUBClient, pointing towards their utility in handling HTTP requests, CRUD operations, and seamless authentication, respectively. πŸ”‘
  • Added comprehensive metadata for modules documentation, highlighting the ease of managing models, datasets, projects, teams, and users. πŸ‘©β€πŸ’»

🎯 Purpose & Impact

  • The refreshed documentation aims to make it simpler for developers and enthusiasts to integrate machine learning tools into their Python applications, enhancing ease of use and accessibility. 🐍
  • With clearer examples and updated keywords, users can more easily discover and leverage the HUB-SDK for their projects, potentially leading to greater adoption and community contributions. 🌐
  • The enhancements in reference sections and module descriptions provide a solid foundation for developers looking to understand the inner workings of the SDK, fostering better troubleshooting and customization. πŸ”

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
@glenn-jocher
Copy link
Member Author

@sergiuwaxmann @yogendrasinghx maintaining this separate repo is an absolute nightmare in terms of updating everything I do twice, first on ultralytics where the rest of the world is, and then here, where no one is but where I still need to spend time.

I'm not happy here, I believe this repo should be deleted and merged into ultralytics to avoid a waste of my time and all the other future maintainers who will have to duplicate every action they take in the future.

@glenn-jocher glenn-jocher merged commit 6640476 into main Jun 2, 2024
5 checks passed
@glenn-jocher glenn-jocher deleted the docs branch June 2, 2024 14:01
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

1 participant