Docs: Update HUB Teams page (#13215)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>
pull/13219/head
Sergiu Waxmann 10 months ago committed by GitHub
parent 7cd871dbd0
commit b14f9cdb10
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 2
      .github/workflows/ci.yaml
  2. 4
      docs/en/hub/app/android.md
  3. 4
      docs/en/hub/app/index.md
  4. 4
      docs/en/hub/app/ios.md
  5. 4
      docs/en/hub/cloud-training.md
  6. 6
      docs/en/hub/datasets.md
  7. 4
      docs/en/hub/index.md
  8. 4
      docs/en/hub/inference-api.md
  9. 6
      docs/en/hub/models.md
  10. 6
      docs/en/hub/pro.md
  11. 6
      docs/en/hub/projects.md
  12. 4
      docs/en/hub/quickstart.md
  13. 195
      docs/en/hub/teams.md
  14. 4
      docs/en/integrations/amazon-sagemaker.md
  15. 4
      docs/en/reference/models/yolo/model.md
  16. 2
      docs/en/reference/models/yolo/obb/train.md

@ -183,7 +183,7 @@ jobs:
Tests:
if: github.event_name != 'workflow_dispatch' || github.event.inputs.tests == 'true'
timeout-minutes: 120
timeout-minutes: 360
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false

@ -1,7 +1,7 @@
---
comments: true
description: Experience rapid object detection on your Android device with the Ultralytics YOLO model app. Click to learn more!.
keywords: Ultralytics, YOLO, Android App, real-time object detection, TensorFlow Lite, hardware acceleration, FP16, INT8, GPU
description: Discover real-time object detection on your Android with the Ultralytics App using optimized YOLO models.
keywords: Ultralytics, YOLO, Android app, real-time object detection, TensorFlow Lite, model optimization, AI mobile application
---
# Ultralytics Android App: Real-time Object Detection with YOLO Models

@ -1,7 +1,7 @@
---
comments: true
description: Unlock the power of YOLO models on iOS & Android with the Ultralytics HUB App. Experience optimized performance on-the-go!.
keywords: Ultralytics HUB App, YOLOv5, YOLOv8, mobile object detection, iOS, Android, real-time image recognition
description: Unlock real-time YOLO model detection directly on your mobile! Discover apps for iOS and Android with YOLOv5 and YOLOv8.
keywords: Ultralytics HUB App, YOLOv5, YOLOv8, real-time detection, mobile AI, iOS, Android, Apple Neural Engine, Android GPU, Ultralytics
---
# Ultralytics HUB App

@ -1,7 +1,7 @@
---
comments: true
description: Transform your iOS device into a powerful object detection tool with the Ultralytics iOS App, powered by YOLO models.
keywords: Ultralytics, iOS app, YOLO, object detection, real-time, iPhone, iPad, quantization, Apple Neural Engine, Core ML
description: Discover real-time object detection on iOS devices using powerful YOLO models, optimized via Apple Neural Engine.
keywords: Ultralytics, iOS app, YOLO models, real-time detection, object detection, iPhone, iPad, Apple Neural Engine, Core ML, quantization, FP16, INT8
---
# Ultralytics iOS App: Real-time Object Detection with YOLO Models

@ -1,7 +1,7 @@
---
comments: true
description: Unlock one-click cloud training for your models on Ultralytics HUB Pro. Streamline your AI workflow today!.
keywords: Ultralytics HUB, cloud training, AI model training, Pro users, easy model training, Ultralytics cloud, AI workflow
description: Transform model training with Ultralytics HUB Cloud. Efficient, simple cloud-based training for Pro users.
keywords: Ultralytics HUB, cloud training, model training, Pro users, cloud-based ML, machine learning, AI model training
---
# Ultralytics HUB Cloud Training

@ -1,7 +1,7 @@
---
comments: true
description: Learn how Ultralytics HUB datasets streamline your ML workflow. Upload, format, validate, access, share, edit or delete datasets for Ultralytics YOLO model training.
keywords: Ultralytics, HUB datasets, YOLO model training, upload datasets, dataset validation, ML workflow, share datasets
description: Discover how to seamlessly upload, manage, and leverage datasets for model training with Ultralytics HUB.
keywords: Ultralytics HUB datasets, upload datasets, manage datasets, dataset management, model training, YOLOv5 datasets, YOLOv8 datasets
---
# Ultralytics HUB Datasets
@ -164,4 +164,4 @@ Navigate to the Dataset page of the dataset you want to delete, open the dataset
If you change your mind, you can restore the dataset from the [Trash](https://hub.ultralytics.com/trash) page.
![Ultralytics HUB screenshot of the Trash page with an arrow pointing to Trash button in the sidebar and one to the Restore option of one of the datasets](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/datasets/hub_delete_dataset_3.jpg)
![Ultralytics HUB screenshot of the Trash page with an arrow pointing to Trash button in the sidebar and one to the Restore option of one of the datasets](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/datasets/hub_delete_dataset_3.jpg)

@ -1,7 +1,7 @@
---
comments: true
description: Discover Ultralytics HUB for seamless training and deploying of YOLOv5 and YOLOv8 models. Start your AI journey with ease!.
keywords: Ultralytics HUB, YOLO model training, YOLOv5, YOLOv8, model deployment, AI, machine learning
description: Launch into AI with Ultralytics HUB! Train, monitor, and deploy YOLO models easily. Start your journey in AI model training today.
keywords: Ultralytics HUB, YOLOv5, YOLOv8, model training, AI platform, object detection, deploy models, train YOLO models
---
# Ultralytics HUB

@ -1,7 +1,7 @@
---
comments: true
description: Effortlessly run AI model inferences with Ultralytics HUB Inference API. Perfect for developers!.
keywords: Ultralytics HUB, Inference API, YOLO, REST API, machine learning, AI model inference, remote inference
description: Effortlessly run YOLO model inferences with Ultralytics HUB Inference API. No local setup required!
keywords: Ultralytics HUB, Inference API, YOLO, model inference, REST API, machine learning, AI model deployment
---
# Ultralytics HUB Inference API

@ -1,7 +1,7 @@
---
comments: true
description: Streamline your AI model training on custom datasets with Ultralytics HUB. Efficient, user-friendly, and powerful.
keywords: Ultralytics HUB, AI model training, custom datasets, YOLOv8, real-time updates, model deployment, Ultralytics
description: Discover how to efficiently train vision AI models using the user-friendly Ultralytics HUB with YOLOv8.
keywords: train AI models, Ultralytics HUB, YOLOv8, custom datasets, vision AI, model training
---
# Ultralytics HUB Models
@ -294,4 +294,4 @@ Navigate to the Model page of the model you want to delete, open the model actio
If you change your mind, you can restore the model from the [Trash](https://hub.ultralytics.com/trash) page.
![Ultralytics HUB screenshot of the Trash page with an arrow pointing to the Restore option of one of the models](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/models/hub_delete_model_3.jpg)
![Ultralytics HUB screenshot of the Trash page with an arrow pointing to the Restore option of one of the models](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/models/hub_delete_model_3.jpg)

@ -1,7 +1,7 @@
---
comments: true
description: Unlock premium features with Ultralytics HUB Pro! Get 200GB storage, cloud training, enhanced API limits, and more.
keywords: Ultralytics HUB Pro, upgrade, premium features, cloud training, team collaboration, API limits
description: Unlock premium features with the Ultralytics HUB Pro Plan! Get 200GB storage, cloud training, and more.
keywords: Ultralytics HUB Pro, cloud training, inference API, collaboration, Pro Plan benefits, upgrade HUB subscription
---
# Ultralytics HUB Pro
@ -57,4 +57,4 @@ Next, set the amount you want to top-up.
That's it!
![Ultralytics HUB screenshot of the Payment Successful dialog](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/pro/hub_pro_account_balance_3.jpg)
![Ultralytics HUB screenshot of the Payment Successful dialog](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/pro/hub_pro_account_balance_3.jpg)

@ -1,7 +1,7 @@
---
comments: true
description: Effortlessly consolidate, manage, and enhance your AI models with Ultralytics HUB projects. Start now!.
keywords: Ultralytics HUB, manage AI models, project creation, model comparison, model management
description: Effortlessly consolidate, manage, and enhance your AI models with Ultralytics HUB projects. Start now!
keywords: Ultralytics HUB, model management, create project, share project, edit project, delete project, model comparison
---
# Ultralytics HUB Projects
@ -178,4 +178,4 @@ Navigate to the Project page of the project where the model you want to mode is
Select the project you want to transfer the model to and click **Save**.
![Ultralytics HUB screenshot of the Transfer Model dialog with an arrow pointing to the dropdown and one to the Save button](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/projects/hub_transfer_models_3.jpg)
![Ultralytics HUB screenshot of the Transfer Model dialog with an arrow pointing to the dropdown and one to the Save button](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/projects/hub_transfer_models_3.jpg)

@ -1,7 +1,7 @@
---
comments: true
description: Easily train YOLO models with the Ultralytics HUB. Quick sign-up, intuitive use, and ready-to-deploy models!.
keywords: Ultralytics HUB, YOLO Quickstart, train YOLO model, pre-trained models, deploy models, Ultralytics HUB App
keywords: Ultralytics HUB, YOLO models, quickstart, train YOLO, easy signup, deploy models, Ultralytics
---
# Ultralytics HUB Quickstart
@ -98,4 +98,4 @@ You can report a bug, request a feature, or ask a question on <a href="https://g
??? tip "Tip"
You can join our <a href="https://ultralytics.com/discord">Discord</a> community for questions and discussions!
You can join our <a href="https://ultralytics.com/discord">Discord</a> community for questions and discussions!

@ -1,36 +1,191 @@
---
description: Discover what's next for Ultralytics with our under-construction page, previewing new, groundbreaking AI and ML features coming soon.
keywords: Ultralytics, coming soon, under construction, new features, AI updates, ML advancements, YOLO, technology preview
comments: true
description: Explore the new Teams feature in Ultralytics HUB! Manage, share, and collaborate efficiently on projects.
keywords: Ultralytics HUB, Teams feature, collaboration, project management, team creation, invite members
---
# Ultralytics HUB Teams - Under Construction 🏗🌟
# Ultralytics HUB Teams
We are in the process of expanding this section to offer detailed guidance on how to effectively use the Teams features within [Ultralytics HUB](https://bit.ly/ultralytics_hub). This will include managing team members, sharing resources, and collaborating on projects.
We're excited to introduce you to the new Teams feature within [Ultralytics HUB](https://bit.ly/ultralytics_hub) for our [Pro](./pro.md) users!
We appreciate your patience as we work to make this section comprehensive and user-friendly. Stay tuned for updates!
Here, you'll learn how to manage team members, share resources seamlessly, and collaborate efficiently on various projects.
## Exciting New Features on the Way 🎉
!!! note "Note"
- Enhanced Team Management Features
- Guidance on Resource Sharing Among Team Members
- Best Practices for Collaborative Project Development
As this is a new feature, we're still in the process of developing and refining it to ensure it meets your needs.
## Stay Updated 🚧
## Create Team
This placeholder page is your first stop for upcoming developments. Keep an eye out for:
!!! note "Note"
- **Newsletter:** Subscribe [here](https://ultralytics.com/#newsletter) for the latest news.
- **Social Media:** Follow us [here](https://www.linkedin.com/company/ultralytics) for updates and teasers.
- **Blog:** Visit our [blog](https://ultralytics.com/blog) for detailed insights.
You need to [upgrade](./pro.md#upgrade) to the [Pro Plan](./pro.md) in order to create a team.
## We Value Your Input 🗣
![Ultralytics HUB screenshot of the Settings page Teams tab with an arrow pointing to the Upgrade button](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/teams/hub_create_team_1.jpg)
Your feedback shapes our future releases. Share your thoughts and suggestions [here](https://ultralytics.com/survey).
Navigate to the [Teams](https://hub.ultralytics.com/settings?tab=teams) page by clicking on the **Teams** tab in the [Settings](https://hub.ultralytics.com/settings) page and click on the **Create Team** button.
## Thank You, Community! 🌍
![Ultralytics HUB screenshot of the Teams page with an arrow pointing to the Create Team button](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/teams/hub_create_team_2.jpg)
Your [contributions](https://docs.ultralytics.com/help/contributing) inspire our continuous [innovation](https://github.com/ultralytics/ultralytics). Stay tuned for the big reveal of what's next in AI and ML at Ultralytics!
This action will trigger the **Create Team** dialog.
---
Type the name of your team in the _Team name_ field or keep the default name and finalize the team creation with a single click.
You have the additional option to enrich your team with a description and a unique image, enhancing its recognizability on the [Teams](https://hub.ultralytics.com/settings?tab=teams) page.
When you're happy with your team configuration, click **Create**.
![Ultralytics HUB screenshot of the Create Team dialog with an arrow pointing to the Create button](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/teams/hub_create_team_3.jpg)
After your team is created, you will be able to access it from the [Teams](https://hub.ultralytics.com/settings?tab=teams) page.
![Ultralytics HUB screenshot of the Teams page with an arrow pointing to one of the teams](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/teams/hub_create_team_4.jpg)
## Edit Team
Navigate to the [Teams](https://hub.ultralytics.com/settings?tab=teams) page, open the team actions dropdown of team you want to edit and click on the **Edit** option. This action will trigger the **Update Team** dialog.
![Ultralytics HUB screenshot of the Teams page with an arrow pointing to the Edit option of one of the teams](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/teams/hub_edit_team_1.jpg)
Apply the desired modifications to your team and then confirm the changes by clicking **Save**.
![Ultralytics HUB screenshot of the Update Team dialog with an arrow pointing to the Save button](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/teams/hub_edit_team_2.jpg)
## Delete Team
Navigate to the [Teams](https://hub.ultralytics.com/settings?tab=teams) page, open the team actions dropdown of team you want to delete and click on the **Delete** option.
![Ultralytics HUB screenshot of the Teams page with an arrow pointing to the Delete option of one of the teams](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/teams/hub_delete_team_1.jpg)
!!! Warning "Warning"
When deleting a team, the team can't be restored.
## Invite Member
Navigate to the Team page of the team to which you want to add a new member and click on the **Invite Member** button. This action will trigger the **Invite Member** dialog.
![Ultralytics HUB screenshot of the Team page with an arrow pointing to the Invite Member button](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/teams/hub_invite_member_1.jpg)
Type the email and select the role of the new member and click **Invite**.
![Ultralytics HUB screenshot of the Invite Member dialog with an arrow pointing to the Invite button](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/teams/hub_invite_member_2.jpg)
![Ultralytics HUB screenshot of the Team page with a new member invited](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/teams/hub_invite_member_3.jpg)
??? tip "Tip"
You can cancel the invite before the new member accepts it.
![Ultralytics HUB screenshot of the Team page with an arrow pointing to the Cancel Invite option of one of the members](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/teams/hub_invite_member_4.jpg)
The **Pending** status disappears after the new member accepts the invite.
![Ultralytics HUB screenshot of the Team page with two members](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/teams/hub_invite_member_5.jpg)
??? tip "Tip"
You can update a member's role at any time.
The **Admin** role allows inviting and removing members, as well as removing shared datasets or projects.
![Ultralytics HUB screenshot of the Team page with an arrow pointing to the Change Role option of one of the members](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/teams/hub_invite_member_6.jpg)
### Seats
The [Pro Plan](./pro.md) offers one free seat _(yours)_.
When a new unique member joins one of your teams, the number of seats increases, and you will be charged **$20 per month** for each seat, or **$200 per year** if you choose the annual plan.
Each unique member counts as one seat, regardless of how many teams they are in. For example, if John Doe is a member of 5 of your teams, he is using one seat.
When you remove a unique member from the last team they are a member of, the number of seats decreases. The charge is prorated and can be applied to adding other unique members, paying for the [Pro Plan](./pro.md), or topping up your [account balance](./pro.md#account-balance).
You can see the number of seats on the [Teams](https://hub.ultralytics.com/settings?tab=teams) page.
![Ultralytics HUB screenshot of the Teams page with an arrow pointing to the number of seats](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/teams/hub_invite_member_7.jpg)
## Remove Member
Navigate to the Team page of the team from which you want to remove a member, open the member actions dropdown, and click on the **Remove** option.
![Ultralytics HUB screenshot of the Team page with an arrow pointing to the Remove option of one of the members](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/teams/hub_remove_member_1.jpg)
## Join Team
When you are invited to a team, you receive an in-app notification.
You can view your notifications by clicking on the **View** button on the **Notifications** card on the [Home](https://hub.ultralytics.com/home) page.
![Ultralytics HUB screenshot of the Home page with an arrow pointing to the View button on the Notifications card](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/teams/hub_join_team_1.jpg)
Alternatively, you can view your notifications by accessing the [Notifications](https://hub.ultralytics.com/notifications) page directly.
![Ultralytics HUB screenshot of the Notifications page with an arrow pointing to one of the notifications](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/teams/hub_join_team_2.jpg)
You can decide whether to join the team on the Team page of the team to which you were invited.
If you want to join the team, click on the **Join Team** button.
![Ultralytics HUB screenshot of the Team page with an arrow pointing to the Join Team button](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/teams/hub_join_team_3.jpg)
If you don't want to join the team, click on the **Reject Invitation** button.
![Ultralytics HUB screenshot of the Team page with an arrow pointing to the Reject Invitation button](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/teams/hub_join_team_4.jpg)
??? tip "Tip"
You can join the team directly from the [Teams](https://hub.ultralytics.com/settings?tab=teams) page.
![Ultralytics HUB screenshot of the Teams page with an arrow pointing to the Join Team button of one of the teams](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/teams/hub_join_team_5.jpg)
## Leave Team
Navigate to the Team page of the team you want to leave and click on the **Leave Team** button.
![Ultralytics HUB screenshot of the Team page with an arrow pointing to the Leave Team button](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/teams/hub_leave_team_1.jpg)
## Share Dataset
Navigate to the Team page of the team you want to share your dataset with and click on the **Add Dataset** button.
![Ultralytics HUB screenshot of the Team page with an arrow pointing to the Add Dataset button](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/teams/hub_share_dataset_1.jpg)
Select the dataset you want to share with your team and click on the **Add** button.
![Ultralytics HUB screenshot of the Add Dataset to Team dialog with an arrow pointing to the Add button](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/teams/hub_share_dataset_2.jpg)
That's it! Your team now has access to your dataset.
![Ultralytics HUB screenshot of the Team page with a dataset shared](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/teams/hub_share_dataset_3.jpg)
??? tip "Tip"
As a team owner or team admin, you can remove a shared dataset.
![Ultralytics HUB screenshot of the Team page with an arrow pointing to the Remove option of one of the datasets shared](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/teams/hub_share_dataset_4.jpg)
## Share Project
Navigate to the Team page of the team you want to share your project with and click on the **Add Project** button.
![Ultralytics HUB screenshot of the Team page with an arrow pointing to the Add Project button](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/teams/hub_share_project_1.jpg)
Select the project you want to share with your team and click on the **Add** button.
![Ultralytics HUB screenshot of the Add Project to Team dialog with an arrow pointing to the Add button](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/teams/hub_share_project_2.jpg)
That's it! Your team now has access to your project.
![Ultralytics HUB screenshot of the Team page with a project shared](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/teams/hub_share_project_3.jpg)
??? tip "Tip"
As a team owner or team admin, you can remove a shared project.
![Ultralytics HUB screenshot of the Team page with an arrow pointing to the Remove option of one of the projects shared](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/teams/hub_share_project_4.jpg)
!!! note "Note"
When you share a project with your team, all models inside the project are shared as well.
Excited for what's coming? Bookmark this page and get ready for a transformative AI and ML journey with Ultralytics! 🛠🤖
![Ultralytics HUB screenshot of the Team page with a model shared](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/teams/hub_share_project_5.jpg)

@ -1,7 +1,7 @@
---
comments: true
Description: Learn how to deploy YOLOv8 models on Amazon SageMaker Endpoints. This guide covers the essentials of AWS environment setup, model preparation, and deployment using AWS CloudFormation and the AWS Cloud Development Kit (CDK).
keywords: YOLOv8, Ultralytics, Amazon SageMaker, AWS, CloudFormation, AWS CDK, PyTorch, Model Deployment, Machine Learning, Computer Vision
description: Learn how to deploy YOLOv8 models on Amazon SageMaker Endpoints. This guide covers the essentials of AWS environment setup, model preparation, and deployment using AWS CloudFormation and the AWS Cloud Development Kit (CDK).
keywords: YOLOv8, Amazon SageMaker, deploy YOLOv8, AWS deployment, machine learning, real-time inference, AWS CloudFormation, AWS CDK
---
# A Guide to Deploying YOLOv8 on Amazon SageMaker Endpoints

@ -1,6 +1,6 @@
---
description: Discover the Ultralytics YOLO model class. Learn advanced techniques, tips, and tricks for training.
keywords: Ultralytics YOLO, YOLO, YOLO model, Model Training, Machine Learning, Deep Learning, Computer Vision
description: Explore the powerful YOLO model for object detection, including YOLOWorld for enhanced capabilities. Learn about classification, detection, segmentation, and more.
keywords: Ultralytics YOLO, object detection, YOLOWorld, classification, detection, segmentation, pose estimation
---
# Reference for `ultralytics/models/yolo/model.py`

@ -1,5 +1,5 @@
---
description: Master the Ultralytics YOLO OBB Trainer: A specialized tool for training YOLO models using Oriented Bounding Boxes. Features detailed usage, model initialization, and training processes.
description: Master the Ultralytics YOLO OBB Trainer - A specialized tool for training YOLO models using Oriented Bounding Boxes. Features detailed usage, model initialization, and training processes.
keywords: Ultralytics, YOLO OBB Trainer, Oriented Bounding Box, OBB model training, YOLO model training, computer vision, deep learning, machine learning, YOLO object detection, model initialization, YOLO training process
---

Loading…
Cancel
Save