Update more/missing type qualifiers to lowercase MkDocs admonitions (#16215)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>
This commit is contained in:
Jan Knobloch 2024-09-11 18:30:13 +02:00 committed by GitHub
parent 6b95967e08
commit b9f0983e82
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
148 changed files with 223 additions and 223 deletions

View file

@ -26,7 +26,7 @@ Navigate to the [Models](https://hub.ultralytics.com/models) page by clicking on
![Ultralytics HUB screenshot of the Models page with an arrow pointing to the Models button in the sidebar and one to the Train Model button](https://github.com/ultralytics/docs/releases/download/0/ultralytics-hub-train-model-page.avif)
??? tip "Tip"
??? tip
You can train a model directly from the [Home](https://hub.ultralytics.com/home) page.
@ -40,7 +40,7 @@ In this step, you have to select the dataset you want to train your model on. Af
![Ultralytics HUB screenshot of the Train Model dialog with an arrow pointing to a dataset and one to the Continue button](https://github.com/ultralytics/docs/releases/download/0/hub-train-model-dialog-dataset-step.avif)
??? tip "Tip"
??? tip
You can skip this step if you train a model directly from the Dataset page.
@ -52,7 +52,7 @@ In this step, you have to choose the project in which you want to create your mo
![Ultralytics HUB screenshot of the Train Model dialog with arrows pointing to the project dropdown, model name and Continue button](https://github.com/ultralytics/docs/releases/download/0/hub-train-model-dialog.avif)
??? note "Note"
??? note
Ultralytics HUB will try to pre-select the project.
@ -64,7 +64,7 @@ In this step, you have to choose the project in which you want to create your mo
In case you don't have a project created yet, you can set the name of your project in this step and it will be created together with your model.
!!! info "Info"
!!! info
You can read more about the available [YOLOv8](https://docs.ultralytics.com/models/yolov8) (and [YOLOv5](https://docs.ultralytics.com/models/yolov5)) architectures in our documentation.
@ -72,7 +72,7 @@ By default, your model will use a pre-trained model (trained on the [COCO](https
![Ultralytics HUB screenshot of the Train Model dialog with an arrow pointing to the Advanced Model Configuration accordion](https://github.com/ultralytics/docs/releases/download/0/ultralytics-hub-train-model-dialog-2.avif)
!!! note "Note"
!!! note
You can easily change the most common model configuration options (such as the number of epochs) but you can also use the **Custom** option to access all [Train Settings](https://docs.ultralytics.com/modes/train/#train-settings) relevant to [Ultralytics HUB](https://www.ultralytics.com/hub).
@ -97,7 +97,7 @@ When you're happy with your model configuration, click **Continue**.
In this step, you will start training you model.
??? note "Note"
??? note
When you are on this step, you have the option to close the **Train Model** dialog and start training your model from the Model page later.
@ -133,7 +133,7 @@ When the training starts, you can click **Done** and monitor the training progre
![Ultralytics HUB screenshot of the Model page of a model that is currently training](https://github.com/ultralytics/docs/releases/download/0/hub-train-model-progress.avif)
!!! note "Note"
!!! note
In case the training stops and a checkpoint was saved, you can resume training your model from the Model page.
@ -169,7 +169,7 @@ When the training starts, you can click **Done** and monitor the training progre
![Ultralytics HUB screenshot of the Model page of a model that is currently training](https://github.com/ultralytics/docs/releases/download/0/model-training-progress.avif)
!!! note "Note"
!!! note
In case the training stops and a checkpoint was saved, you can resume training your model from the Model page.
@ -187,7 +187,7 @@ To access all model metrics, click on the **Charts** tab.
![Ultralytics HUB screenshot of the Preview tab inside the Model page with an arrow pointing to the Charts tab](https://github.com/ultralytics/docs/releases/download/0/hub-analyze-model-2.avif)
??? tip "Tip"
??? tip
Each chart can be enlarged for better visualization.
@ -207,7 +207,7 @@ In the **Test** card, you can select a preview image from the dataset used durin
![Ultralytics HUB screenshot of the Preview tab inside the Model page with an arrow pointing to Charts tab and one to the Test card](https://github.com/ultralytics/docs/releases/download/0/hub-preview-model-charts-test-card.avif)
!!! note "Note"
!!! note
You can also use your camera to take a picture and run inference on it directly.
@ -223,13 +223,13 @@ After you [train a model](#train-model), you can export it to 13 different forma
![Ultralytics HUB screenshot of the Deploy tab inside the Model page with an arrow pointing to the Export card and all formats exported](https://github.com/ultralytics/docs/releases/download/0/ultralytics-hub-deploy-export-formats.avif)
??? tip "Tip"
??? tip
You can customize the export options of each format if you open the export actions dropdown and click on the **Advanced** option.
![Ultralytics HUB screenshot of the Deploy tab inside the Model page with an arrow pointing to the Advanced option of one of the formats](https://github.com/ultralytics/docs/releases/download/0/hub-deploy-model-advanced-option.avif)
!!! note "Note"
!!! note
You can re-export each format if you open the export actions dropdown and click on the **Advanced** option.
@ -241,11 +241,11 @@ Read the [Ultralytics Inference API](./inference-api.md) documentation for more
## Share Model
!!! info "Info"
!!! info
[Ultralytics HUB](https://www.ultralytics.com/hub)'s sharing functionality provides a convenient way to share models with others. This feature is designed to accommodate both existing [Ultralytics HUB](https://www.ultralytics.com/hub) users and those who have yet to create an account.
??? note "Note"
??? note
You have control over the general access of your models.
@ -255,7 +255,7 @@ Navigate to the Model page of the model you want to share, open the model action
![Ultralytics HUB screenshot of the Model page with an arrow pointing to the Share option](https://github.com/ultralytics/docs/releases/download/0/ultralytics-hub-share-model.avif)
??? tip "Tip"
??? tip
You can also share a model directly from the [Models](https://hub.ultralytics.com/models) page or from the Project page of the project where your model is located.
@ -267,7 +267,7 @@ Set the general access to "Unlisted" and click **Save**.
Now, anyone who has the direct link to your model can view it.
??? tip "Tip"
??? tip
You can easily click on the model's link shown in the **Share Model** dialog to copy it.
@ -279,7 +279,7 @@ Navigate to the Model page of the model you want to edit, open the model actions
![Ultralytics HUB screenshot of the Model page with an arrow pointing to the Edit option](https://github.com/ultralytics/docs/releases/download/0/hub-edit-model-1.avif)
??? tip "Tip"
??? tip
You can also edit a model directly from the [Models](https://hub.ultralytics.com/models) page or from the Project page of the project where your model is located.
@ -295,13 +295,13 @@ Navigate to the Model page of the model you want to delete, open the model actio
![Ultralytics HUB screenshot of the Model page with an arrow pointing to the Delete option](https://github.com/ultralytics/docs/releases/download/0/hub-delete-model-1.avif)
??? tip "Tip"
??? tip
You can also delete a model directly from the [Models](https://hub.ultralytics.com/models) page or from the Project page of the project where your model is located.
![Ultralytics HUB screenshot of the Models page with an arrow pointing to the Delete option of one of the models](https://github.com/ultralytics/docs/releases/download/0/hub-delete-model-2.avif)
!!! note "Note"
!!! note
If you change your mind, you can restore the model from the [Trash](https://hub.ultralytics.com/trash) page.