HongChuang/ultralytics-ascend
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

Engine Model and Results Docs improvements (#14564)

Browse source 
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Felipe Parodi <fparodi@pennmedicine.upenn.edu>
This commit is contained in:
Glenn Jocher 2024-07-21 20:14:49 +02:00 • committed by GitHub
parent e59376b55f
commit 291883a23f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
123 changed files with 3789 additions and 1368 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/en/reference/data/annotator.md
View file

@ -9,7 +9,7 @@ keywords: Ultralytics, image annotation, YOLO, SAM, Python script, GitHub, objec
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/annotator.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/annotator.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/annotator.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.data.annotator.auto_annotate

38
docs/en/reference/data/augment.md
View file

@ -9,79 +9,79 @@ keywords: Ultralytics, image augmentation, MixUp, Mosaic, Random Perspective, de
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/augment.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/augment.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/augment.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.data.augment.BaseTransform
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.Compose
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.BaseMixTransform
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.Mosaic
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.MixUp
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.RandomPerspective
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.RandomHSV
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.RandomFlip
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.LetterBox
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.CopyPaste
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.Albumentations
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.Format
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.RandomLoadText
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.ClassifyLetterBox
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.CenterCrop
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.ToTensor
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.v8_transforms
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.classify_transforms
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.augment.classify_augmentations

2
docs/en/reference/data/base.md
View file

@ -9,7 +9,7 @@ keywords: Ultralytics, BaseDataset, image processing, data augmentation, YOLO, d
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/base.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/base.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/base.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.data.base.BaseDataset

16
docs/en/reference/data/build.md
View file

@ -9,35 +9,35 @@ keywords: Ultralytics, Data Builders, InfiniteDataLoader, YOLO dataset, build.py
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/build.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/build.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/build.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.data.build.InfiniteDataLoader
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.build._RepeatSampler
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.build.seed_worker
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.build.build_yolo_dataset
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.build.build_grounding
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.build.build_dataloader
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.build.check_source
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.build.load_inference_source

14
docs/en/reference/data/converter.md
View file

@ -9,31 +9,31 @@ keywords: Ultralytics, data conversion, YOLO models, COCO, DOTA, YOLO bbox2segme
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/converter.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/converter.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/converter.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.data.converter.coco91_to_coco80_class
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.converter.coco80_to_coco91_class
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.converter.convert_coco
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.converter.convert_dota_to_yolo_obb
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.converter.min_index
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.converter.merge_multi_segment
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.converter.yolo_bbox2segment

12
docs/en/reference/data/dataset.md
View file

@ -9,27 +9,27 @@ keywords: Ultralytics, YOLODataset, object detection, segmentation, dataset load
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/dataset.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/dataset.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/dataset.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.data.dataset.YOLODataset
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.dataset.YOLOMultiModalDataset
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.dataset.GroundingDataset
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.dataset.YOLOConcatDataset
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.dataset.SemanticDataset
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.dataset.ClassificationDataset

4
docs/en/reference/data/explorer/explorer.md
View file

@ -10,11 +10,11 @@ keywords: Ultralytics, YOLO, data explorer, image querying, embeddings, similari
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/explorer/explorer.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/explorer/explorer.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/explorer/explorer.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.data.explorer.explorer.ExplorerDataset
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.explorer.explorer.Explorer

22
docs/en/reference/data/explorer/gui/dash.md
View file

@ -10,47 +10,47 @@ keywords: Ultralytics, Explorer, GUI, dash, documentation, data explorer, AI que
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/explorer/gui/dash.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/explorer/gui/dash.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/explorer/gui/dash.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.data.explorer.gui.dash._get_explorer
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.explorer.gui.dash.init_explorer_form
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.explorer.gui.dash.query_form
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.explorer.gui.dash.ai_query_form
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.explorer.gui.dash.find_similar_imgs
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.explorer.gui.dash.similarity_form
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.explorer.gui.dash.run_sql_query
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.explorer.gui.dash.run_ai_query
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.explorer.gui.dash.reset_explorer
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.explorer.gui.dash.utralytics_explorer_docs_callback
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.explorer.gui.dash.layout

10
docs/en/reference/data/explorer/utils.md
View file

@ -10,23 +10,23 @@ keywords: Ultralytics, data explorer, utils, schema, sanitize batch, plot query
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/explorer/utils.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/explorer/utils.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/explorer/utils.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.data.explorer.utils.get_table_schema
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.explorer.utils.get_sim_index_schema
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.explorer.utils.sanitize_batch
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.explorer.utils.plot_query_result
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.explorer.utils.prompt_sql_query

16
docs/en/reference/data/loaders.md
View file

@ -9,35 +9,35 @@ keywords: Ultralytics, data loaders, SourceTypes, LoadStreams, LoadScreenshots,
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/loaders.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/loaders.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/loaders.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.data.loaders.SourceTypes
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.loaders.LoadStreams
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.loaders.LoadScreenshots
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.loaders.LoadImagesAndVideos
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.loaders.LoadPilAndNumpy
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.loaders.LoadTensor
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.loaders.autocast_list
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.loaders.get_best_youtube_url

16
docs/en/reference/data/split_dota.md
View file

@ -9,35 +9,35 @@ keywords: Ultralytics, DOTA dataset, data splitting, YOLO, Python, bbox_iof, loa
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/split_dota.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/split_dota.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/split_dota.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.data.split_dota.bbox_iof
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.split_dota.load_yolo_dota
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.split_dota.get_windows
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.split_dota.get_window_obj
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.split_dota.crop_and_save
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.split_dota.split_images_and_labels
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.split_dota.split_trainval
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.split_dota.split_test

32
docs/en/reference/data/utils.md
View file

@ -9,67 +9,67 @@ keywords: Ultralytics, dataset utils, data handling, image verification, Python,
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/utils.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/data/utils.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/data/utils.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.data.utils.HUBDatasetStats
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.utils.img2label_paths
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.utils.get_hash
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.utils.exif_size
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.utils.verify_image
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.utils.verify_image_label
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.utils.polygon2mask
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.utils.polygons2masks
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.utils.polygons2masks_overlap
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.utils.find_dataset_yaml
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.utils.check_det_dataset
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.utils.check_cls_dataset
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.utils.compress_one_image
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.utils.autosplit
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.utils.load_dataset_cache_file
<br><br>
<br><br><hr><br>
## ::: ultralytics.data.utils.save_dataset_cache_file