From 797f2374618a231c82d82f3e572635ad776af3b1 Mon Sep 17 00:00:00 2001 From: Mohammed Yasin <32206511+Y-T-G@users.noreply.github.com> Date: Wed, 23 Oct 2024 23:09:21 +0800 Subject: [PATCH] Add `project` and `name` args to docs for predict and val task (#17114) Co-authored-by: UltralyticsAssistant --- docs/en/macros/predict-args.md | 2 ++ docs/en/macros/validation-args.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/docs/en/macros/predict-args.md b/docs/en/macros/predict-args.md index 35c285af..091e692a 100644 --- a/docs/en/macros/predict-args.md +++ b/docs/en/macros/predict-args.md @@ -15,3 +15,5 @@ | `classes` | `list[int]` | `None` | Filters predictions to a set of class IDs. Only detections belonging to the specified classes will be returned. Useful for focusing on relevant objects in multi-class detection tasks. | | `retina_masks` | `bool` | `False` | Uses high-resolution segmentation masks if available in the model. This can enhance mask quality for segmentation tasks, providing finer detail. | | `embed` | `list[int]` | `None` | Specifies the layers from which to extract feature vectors or [embeddings](https://www.ultralytics.com/glossary/embeddings). Useful for downstream tasks like clustering or similarity search. | +| `project` | `str` | `None` | Name of the project directory where prediction outputs are saved if `save` is enabled. | +| `name` | `str` | `None` | Name of the prediction run. Used for creating a subdirectory within the project folder, where prediction outputs are stored if `save` is enabled. | diff --git a/docs/en/macros/validation-args.md b/docs/en/macros/validation-args.md index 5c709f7b..5eeea81f 100644 --- a/docs/en/macros/validation-args.md +++ b/docs/en/macros/validation-args.md @@ -14,3 +14,5 @@ | `plots` | `bool` | `False` | When set to `True`, generates and saves plots of predictions versus ground truth for visual evaluation of the model's performance. | | `rect` | `bool` | `False` | If `True`, uses rectangular inference for batching, reducing padding and potentially increasing speed and efficiency. | | `split` | `str` | `val` | Determines the dataset split to use for validation (`val`, `test`, or `train`). Allows flexibility in choosing the data segment for performance evaluation. | +| `project` | `str` | `None` | Name of the project directory where validation outputs are saved. | +| `name` | `str` | `None` | Name of the validation run. Used for creating a subdirectory within the project folder, where valdiation logs and outputs are stored. |