tomrb commited on
Commit
ab854b9
·
1 Parent(s): df26f80

initial yolov8to

Browse files
This view is limited to 50 files because it contains too many changes.   See raw diff
Files changed (50) hide show
  1. yolov8-to/CITATION.cff +20 -0
  2. yolov8-to/CONTRIBUTING.md +115 -0
  3. yolov8-to/LICENSE +661 -0
  4. yolov8-to/MANIFEST.in +8 -0
  5. yolov8-to/README.md +271 -0
  6. yolov8-to/README.zh-CN.md +269 -0
  7. yolov8-to/docker/Dockerfile +83 -0
  8. yolov8-to/docker/Dockerfile-arm64 +39 -0
  9. yolov8-to/docker/Dockerfile-cpu +49 -0
  10. yolov8-to/docker/Dockerfile-jetson +46 -0
  11. yolov8-to/docker/Dockerfile-python +49 -0
  12. yolov8-to/docker/Dockerfile-runner +37 -0
  13. yolov8-to/docs/CNAME +1 -0
  14. yolov8-to/docs/README.md +90 -0
  15. yolov8-to/docs/SECURITY.md +26 -0
  16. yolov8-to/docs/assets/favicon.ico +0 -0
  17. yolov8-to/docs/build_reference.py +126 -0
  18. yolov8-to/docs/datasets/classify/caltech101.md +81 -0
  19. yolov8-to/docs/datasets/classify/caltech256.md +78 -0
  20. yolov8-to/docs/datasets/classify/cifar10.md +80 -0
  21. yolov8-to/docs/datasets/classify/cifar100.md +80 -0
  22. yolov8-to/docs/datasets/classify/fashion-mnist.md +79 -0
  23. yolov8-to/docs/datasets/classify/imagenet.md +83 -0
  24. yolov8-to/docs/datasets/classify/imagenet10.md +78 -0
  25. yolov8-to/docs/datasets/classify/imagenette.md +113 -0
  26. yolov8-to/docs/datasets/classify/imagewoof.md +84 -0
  27. yolov8-to/docs/datasets/classify/index.md +120 -0
  28. yolov8-to/docs/datasets/classify/mnist.md +86 -0
  29. yolov8-to/docs/datasets/detect/argoverse.md +97 -0
  30. yolov8-to/docs/datasets/detect/coco.md +94 -0
  31. yolov8-to/docs/datasets/detect/coco8.md +84 -0
  32. yolov8-to/docs/datasets/detect/globalwheat2020.md +91 -0
  33. yolov8-to/docs/datasets/detect/index.md +108 -0
  34. yolov8-to/docs/datasets/detect/objects365.md +92 -0
  35. yolov8-to/docs/datasets/detect/open-images-v7.md +110 -0
  36. yolov8-to/docs/datasets/detect/sku-110k.md +93 -0
  37. yolov8-to/docs/datasets/detect/visdrone.md +92 -0
  38. yolov8-to/docs/datasets/detect/voc.md +95 -0
  39. yolov8-to/docs/datasets/detect/xview.md +97 -0
  40. yolov8-to/docs/datasets/index.md +66 -0
  41. yolov8-to/docs/datasets/obb/dota-v2.md +129 -0
  42. yolov8-to/docs/datasets/obb/index.md +84 -0
  43. yolov8-to/docs/datasets/pose/coco.md +95 -0
  44. yolov8-to/docs/datasets/pose/coco8-pose.md +84 -0
  45. yolov8-to/docs/datasets/pose/index.md +130 -0
  46. yolov8-to/docs/datasets/segment/coco.md +94 -0
  47. yolov8-to/docs/datasets/segment/coco8-seg.md +84 -0
  48. yolov8-to/docs/datasets/segment/index.md +148 -0
  49. yolov8-to/docs/datasets/track/index.md +30 -0
  50. yolov8-to/docs/guides/hyperparameter-tuning.md +96 -0
yolov8-to/CITATION.cff ADDED
@@ -0,0 +1,20 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ cff-version: 1.2.0
2
+ preferred-citation:
3
+ type: software
4
+ message: If you use this software, please cite it as below.
5
+ authors:
6
+ - family-names: Jocher
7
+ given-names: Glenn
8
+ orcid: "https://orcid.org/0000-0001-5950-6979"
9
+ - family-names: Chaurasia
10
+ given-names: Ayush
11
+ orcid: "https://orcid.org/0000-0002-7603-6750"
12
+ - family-names: Qiu
13
+ given-names: Jing
14
+ orcid: "https://orcid.org/0000-0003-3783-7069"
15
+ title: "YOLO by Ultralytics"
16
+ version: 8.0.0
17
+ # doi: 10.5281/zenodo.3908559 # TODO
18
+ date-released: 2023-1-10
19
+ license: AGPL-3.0
20
+ url: "https://github.com/ultralytics/ultralytics"
yolov8-to/CONTRIBUTING.md ADDED
@@ -0,0 +1,115 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ## Contributing to YOLOv8 🚀
2
+
3
+ We love your input! We want to make contributing to YOLOv8 as easy and transparent as possible, whether it's:
4
+
5
+ - Reporting a bug
6
+ - Discussing the current state of the code
7
+ - Submitting a fix
8
+ - Proposing a new feature
9
+ - Becoming a maintainer
10
+
11
+ YOLOv8 works so well due to our combined community effort, and for every small improvement you contribute you will be
12
+ helping push the frontiers of what's possible in AI 😃!
13
+
14
+ ## Submitting a Pull Request (PR) 🛠️
15
+
16
+ Submitting a PR is easy! This example shows how to submit a PR for updating `requirements.txt` in 4 steps:
17
+
18
+ ### 1. Select File to Update
19
+
20
+ Select `requirements.txt` to update by clicking on it in GitHub.
21
+
22
+ <p align="center"><img width="800" alt="PR_step1" src="https://user-images.githubusercontent.com/26833433/122260847-08be2600-ced4-11eb-828b-8287ace4136c.png"></p>
23
+
24
+ ### 2. Click 'Edit this file'
25
+
26
+ Button is in top-right corner.
27
+
28
+ <p align="center"><img width="800" alt="PR_step2" src="https://user-images.githubusercontent.com/26833433/122260844-06f46280-ced4-11eb-9eec-b8a24be519ca.png"></p>
29
+
30
+ ### 3. Make Changes
31
+
32
+ Change `matplotlib` version from `3.2.2` to `3.3`.
33
+
34
+ <p align="center"><img width="800" alt="PR_step3" src="https://user-images.githubusercontent.com/26833433/122260853-0a87e980-ced4-11eb-9fd2-3650fb6e0842.png"></p>
35
+
36
+ ### 4. Preview Changes and Submit PR
37
+
38
+ Click on the **Preview changes** tab to verify your updates. At the bottom of the screen select 'Create a **new branch**
39
+ for this commit', assign your branch a descriptive name such as `fix/matplotlib_version` and click the green **Propose
40
+ changes** button. All done, your PR is now submitted to YOLOv8 for review and approval 😃!
41
+
42
+ <p align="center"><img width="800" alt="PR_step4" src="https://user-images.githubusercontent.com/26833433/122260856-0b208000-ced4-11eb-8e8e-77b6151cbcc3.png"></p>
43
+
44
+ ### PR recommendations
45
+
46
+ To allow your work to be integrated as seamlessly as possible, we advise you to:
47
+
48
+ - ✅ Verify your PR is **up-to-date** with `ultralytics/ultralytics` `main` branch. If your PR is behind you can update
49
+ your code by clicking the 'Update branch' button or by running `git pull` and `git merge main` locally.
50
+
51
+ <p align="center"><img width="751" alt="Screenshot 2022-08-29 at 22 47 15" src="https://user-images.githubusercontent.com/26833433/187295893-50ed9f44-b2c9-4138-a614-de69bd1753d7.png"></p>
52
+
53
+ - ✅ Verify all YOLOv8 Continuous Integration (CI) **checks are passing**.
54
+
55
+ <p align="center"><img width="751" alt="Screenshot 2022-08-29 at 22 47 03" src="https://user-images.githubusercontent.com/26833433/187296922-545c5498-f64a-4d8c-8300-5fa764360da6.png"></p>
56
+
57
+ - ✅ Reduce changes to the absolute **minimum** required for your bug fix or feature addition. _"It is not daily increase
58
+ but daily decrease, hack away the unessential. The closer to the source, the less wastage there is."_ — Bruce Lee
59
+
60
+ ### Docstrings
61
+
62
+ Not all functions or classes require docstrings but when they do, we
63
+ follow [google-style docstrings format](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings).
64
+ Here is an example:
65
+
66
+ ```python
67
+ """
68
+ What the function does. Performs NMS on given detection predictions.
69
+
70
+ Args:
71
+ arg1: The description of the 1st argument
72
+ arg2: The description of the 2nd argument
73
+
74
+ Returns:
75
+ What the function returns. Empty if nothing is returned.
76
+
77
+ Raises:
78
+ Exception Class: When and why this exception can be raised by the function.
79
+ """
80
+ ```
81
+
82
+ ## Submitting a Bug Report 🐛
83
+
84
+ If you spot a problem with YOLOv8 please submit a Bug Report!
85
+
86
+ For us to start investigating a possible problem we need to be able to reproduce it ourselves first. We've created a few
87
+ short guidelines below to help users provide what we need in order to get started.
88
+
89
+ When asking a question, people will be better able to provide help if you provide **code** that they can easily
90
+ understand and use to **reproduce** the problem. This is referred to by community members as creating
91
+ a [minimum reproducible example](https://docs.ultralytics.com/help/minimum_reproducible_example/). Your code that reproduces
92
+ the problem should be:
93
+
94
+ - ✅ **Minimal** – Use as little code as possible that still produces the same problem
95
+ - ✅ **Complete** – Provide **all** parts someone else needs to reproduce your problem in the question itself
96
+ - ✅ **Reproducible** – Test the code you're about to provide to make sure it reproduces the problem
97
+
98
+ In addition to the above requirements, for [Ultralytics](https://ultralytics.com/) to provide assistance your code
99
+ should be:
100
+
101
+ - ✅ **Current** – Verify that your code is up-to-date with current
102
+ GitHub [main](https://github.com/ultralytics/ultralytics/tree/main) branch, and if necessary `git pull` or `git clone`
103
+ a new copy to ensure your problem has not already been resolved by previous commits.
104
+ - ✅ **Unmodified** – Your problem must be reproducible without any modifications to the codebase in this
105
+ repository. [Ultralytics](https://ultralytics.com/) does not provide support for custom code ⚠️.
106
+
107
+ If you believe your problem meets all of the above criteria, please close this issue and raise a new one using the 🐛
108
+ **Bug Report** [template](https://github.com/ultralytics/ultralytics/issues/new/choose) and providing
109
+ a [minimum reproducible example](https://docs.ultralytics.com/help/minimum_reproducible_example/) to help us better
110
+ understand and diagnose your problem.
111
+
112
+ ## License
113
+
114
+ By contributing, you agree that your contributions will be licensed under
115
+ the [AGPL-3.0 license](https://choosealicense.com/licenses/agpl-3.0/)
yolov8-to/LICENSE ADDED
@@ -0,0 +1,661 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ GNU AFFERO GENERAL PUBLIC LICENSE
2
+ Version 3, 19 November 2007
3
+
4
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
5
+ Everyone is permitted to copy and distribute verbatim copies
6
+ of this license document, but changing it is not allowed.
7
+
8
+ Preamble
9
+
10
+ The GNU Affero General Public License is a free, copyleft license for
11
+ software and other kinds of works, specifically designed to ensure
12
+ cooperation with the community in the case of network server software.
13
+
14
+ The licenses for most software and other practical works are designed
15
+ to take away your freedom to share and change the works. By contrast,
16
+ our General Public Licenses are intended to guarantee your freedom to
17
+ share and change all versions of a program--to make sure it remains free
18
+ software for all its users.
19
+
20
+ When we speak of free software, we are referring to freedom, not
21
+ price. Our General Public Licenses are designed to make sure that you
22
+ have the freedom to distribute copies of free software (and charge for
23
+ them if you wish), that you receive source code or can get it if you
24
+ want it, that you can change the software or use pieces of it in new
25
+ free programs, and that you know you can do these things.
26
+
27
+ Developers that use our General Public Licenses protect your rights
28
+ with two steps: (1) assert copyright on the software, and (2) offer
29
+ you this License which gives you legal permission to copy, distribute
30
+ and/or modify the software.
31
+
32
+ A secondary benefit of defending all users' freedom is that
33
+ improvements made in alternate versions of the program, if they
34
+ receive widespread use, become available for other developers to
35
+ incorporate. Many developers of free software are heartened and
36
+ encouraged by the resulting cooperation. However, in the case of
37
+ software used on network servers, this result may fail to come about.
38
+ The GNU General Public License permits making a modified version and
39
+ letting the public access it on a server without ever releasing its
40
+ source code to the public.
41
+
42
+ The GNU Affero General Public License is designed specifically to
43
+ ensure that, in such cases, the modified source code becomes available
44
+ to the community. It requires the operator of a network server to
45
+ provide the source code of the modified version running there to the
46
+ users of that server. Therefore, public use of a modified version, on
47
+ a publicly accessible server, gives the public access to the source
48
+ code of the modified version.
49
+
50
+ An older license, called the Affero General Public License and
51
+ published by Affero, was designed to accomplish similar goals. This is
52
+ a different license, not a version of the Affero GPL, but Affero has
53
+ released a new version of the Affero GPL which permits relicensing under
54
+ this license.
55
+
56
+ The precise terms and conditions for copying, distribution and
57
+ modification follow.
58
+
59
+ TERMS AND CONDITIONS
60
+
61
+ 0. Definitions.
62
+
63
+ "This License" refers to version 3 of the GNU Affero General Public License.
64
+
65
+ "Copyright" also means copyright-like laws that apply to other kinds of
66
+ works, such as semiconductor masks.
67
+
68
+ "The Program" refers to any copyrightable work licensed under this
69
+ License. Each licensee is addressed as "you". "Licensees" and
70
+ "recipients" may be individuals or organizations.
71
+
72
+ To "modify" a work means to copy from or adapt all or part of the work
73
+ in a fashion requiring copyright permission, other than the making of an
74
+ exact copy. The resulting work is called a "modified version" of the
75
+ earlier work or a work "based on" the earlier work.
76
+
77
+ A "covered work" means either the unmodified Program or a work based
78
+ on the Program.
79
+
80
+ To "propagate" a work means to do anything with it that, without
81
+ permission, would make you directly or secondarily liable for
82
+ infringement under applicable copyright law, except executing it on a
83
+ computer or modifying a private copy. Propagation includes copying,
84
+ distribution (with or without modification), making available to the
85
+ public, and in some countries other activities as well.
86
+
87
+ To "convey" a work means any kind of propagation that enables other
88
+ parties to make or receive copies. Mere interaction with a user through
89
+ a computer network, with no transfer of a copy, is not conveying.
90
+
91
+ An interactive user interface displays "Appropriate Legal Notices"
92
+ to the extent that it includes a convenient and prominently visible
93
+ feature that (1) displays an appropriate copyright notice, and (2)
94
+ tells the user that there is no warranty for the work (except to the
95
+ extent that warranties are provided), that licensees may convey the
96
+ work under this License, and how to view a copy of this License. If
97
+ the interface presents a list of user commands or options, such as a
98
+ menu, a prominent item in the list meets this criterion.
99
+
100
+ 1. Source Code.
101
+
102
+ The "source code" for a work means the preferred form of the work
103
+ for making modifications to it. "Object code" means any non-source
104
+ form of a work.
105
+
106
+ A "Standard Interface" means an interface that either is an official
107
+ standard defined by a recognized standards body, or, in the case of
108
+ interfaces specified for a particular programming language, one that
109
+ is widely used among developers working in that language.
110
+
111
+ The "System Libraries" of an executable work include anything, other
112
+ than the work as a whole, that (a) is included in the normal form of
113
+ packaging a Major Component, but which is not part of that Major
114
+ Component, and (b) serves only to enable use of the work with that
115
+ Major Component, or to implement a Standard Interface for which an
116
+ implementation is available to the public in source code form. A
117
+ "Major Component", in this context, means a major essential component
118
+ (kernel, window system, and so on) of the specific operating system
119
+ (if any) on which the executable work runs, or a compiler used to
120
+ produce the work, or an object code interpreter used to run it.
121
+
122
+ The "Corresponding Source" for a work in object code form means all
123
+ the source code needed to generate, install, and (for an executable
124
+ work) run the object code and to modify the work, including scripts to
125
+ control those activities. However, it does not include the work's
126
+ System Libraries, or general-purpose tools or generally available free
127
+ programs which are used unmodified in performing those activities but
128
+ which are not part of the work. For example, Corresponding Source
129
+ includes interface definition files associated with source files for
130
+ the work, and the source code for shared libraries and dynamically
131
+ linked subprograms that the work is specifically designed to require,
132
+ such as by intimate data communication or control flow between those
133
+ subprograms and other parts of the work.
134
+
135
+ The Corresponding Source need not include anything that users
136
+ can regenerate automatically from other parts of the Corresponding
137
+ Source.
138
+
139
+ The Corresponding Source for a work in source code form is that
140
+ same work.
141
+
142
+ 2. Basic Permissions.
143
+
144
+ All rights granted under this License are granted for the term of
145
+ copyright on the Program, and are irrevocable provided the stated
146
+ conditions are met. This License explicitly affirms your unlimited
147
+ permission to run the unmodified Program. The output from running a
148
+ covered work is covered by this License only if the output, given its
149
+ content, constitutes a covered work. This License acknowledges your
150
+ rights of fair use or other equivalent, as provided by copyright law.
151
+
152
+ You may make, run and propagate covered works that you do not
153
+ convey, without conditions so long as your license otherwise remains
154
+ in force. You may convey covered works to others for the sole purpose
155
+ of having them make modifications exclusively for you, or provide you
156
+ with facilities for running those works, provided that you comply with
157
+ the terms of this License in conveying all material for which you do
158
+ not control copyright. Those thus making or running the covered works
159
+ for you must do so exclusively on your behalf, under your direction
160
+ and control, on terms that prohibit them from making any copies of
161
+ your copyrighted material outside their relationship with you.
162
+
163
+ Conveying under any other circumstances is permitted solely under
164
+ the conditions stated below. Sublicensing is not allowed; section 10
165
+ makes it unnecessary.
166
+
167
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
168
+
169
+ No covered work shall be deemed part of an effective technological
170
+ measure under any applicable law fulfilling obligations under article
171
+ 11 of the WIPO copyright treaty adopted on 20 December 1996, or
172
+ similar laws prohibiting or restricting circumvention of such
173
+ measures.
174
+
175
+ When you convey a covered work, you waive any legal power to forbid
176
+ circumvention of technological measures to the extent such circumvention
177
+ is effected by exercising rights under this License with respect to
178
+ the covered work, and you disclaim any intention to limit operation or
179
+ modification of the work as a means of enforcing, against the work's
180
+ users, your or third parties' legal rights to forbid circumvention of
181
+ technological measures.
182
+
183
+ 4. Conveying Verbatim Copies.
184
+
185
+ You may convey verbatim copies of the Program's source code as you
186
+ receive it, in any medium, provided that you conspicuously and
187
+ appropriately publish on each copy an appropriate copyright notice;
188
+ keep intact all notices stating that this License and any
189
+ non-permissive terms added in accord with section 7 apply to the code;
190
+ keep intact all notices of the absence of any warranty; and give all
191
+ recipients a copy of this License along with the Program.
192
+
193
+ You may charge any price or no price for each copy that you convey,
194
+ and you may offer support or warranty protection for a fee.
195
+
196
+ 5. Conveying Modified Source Versions.
197
+
198
+ You may convey a work based on the Program, or the modifications to
199
+ produce it from the Program, in the form of source code under the
200
+ terms of section 4, provided that you also meet all of these conditions:
201
+
202
+ a) The work must carry prominent notices stating that you modified
203
+ it, and giving a relevant date.
204
+
205
+ b) The work must carry prominent notices stating that it is
206
+ released under this License and any conditions added under section
207
+ 7. This requirement modifies the requirement in section 4 to
208
+ "keep intact all notices".
209
+
210
+ c) You must license the entire work, as a whole, under this
211
+ License to anyone who comes into possession of a copy. This
212
+ License will therefore apply, along with any applicable section 7
213
+ additional terms, to the whole of the work, and all its parts,
214
+ regardless of how they are packaged. This License gives no
215
+ permission to license the work in any other way, but it does not
216
+ invalidate such permission if you have separately received it.
217
+
218
+ d) If the work has interactive user interfaces, each must display
219
+ Appropriate Legal Notices; however, if the Program has interactive
220
+ interfaces that do not display Appropriate Legal Notices, your
221
+ work need not make them do so.
222
+
223
+ A compilation of a covered work with other separate and independent
224
+ works, which are not by their nature extensions of the covered work,
225
+ and which are not combined with it such as to form a larger program,
226
+ in or on a volume of a storage or distribution medium, is called an
227
+ "aggregate" if the compilation and its resulting copyright are not
228
+ used to limit the access or legal rights of the compilation's users
229
+ beyond what the individual works permit. Inclusion of a covered work
230
+ in an aggregate does not cause this License to apply to the other
231
+ parts of the aggregate.
232
+
233
+ 6. Conveying Non-Source Forms.
234
+
235
+ You may convey a covered work in object code form under the terms
236
+ of sections 4 and 5, provided that you also convey the
237
+ machine-readable Corresponding Source under the terms of this License,
238
+ in one of these ways:
239
+
240
+ a) Convey the object code in, or embodied in, a physical product
241
+ (including a physical distribution medium), accompanied by the
242
+ Corresponding Source fixed on a durable physical medium
243
+ customarily used for software interchange.
244
+
245
+ b) Convey the object code in, or embodied in, a physical product
246
+ (including a physical distribution medium), accompanied by a
247
+ written offer, valid for at least three years and valid for as
248
+ long as you offer spare parts or customer support for that product
249
+ model, to give anyone who possesses the object code either (1) a
250
+ copy of the Corresponding Source for all the software in the
251
+ product that is covered by this License, on a durable physical
252
+ medium customarily used for software interchange, for a price no
253
+ more than your reasonable cost of physically performing this
254
+ conveying of source, or (2) access to copy the
255
+ Corresponding Source from a network server at no charge.
256
+
257
+ c) Convey individual copies of the object code with a copy of the
258
+ written offer to provide the Corresponding Source. This
259
+ alternative is allowed only occasionally and noncommercially, and
260
+ only if you received the object code with such an offer, in accord
261
+ with subsection 6b.
262
+
263
+ d) Convey the object code by offering access from a designated
264
+ place (gratis or for a charge), and offer equivalent access to the
265
+ Corresponding Source in the same way through the same place at no
266
+ further charge. You need not require recipients to copy the
267
+ Corresponding Source along with the object code. If the place to
268
+ copy the object code is a network server, the Corresponding Source
269
+ may be on a different server (operated by you or a third party)
270
+ that supports equivalent copying facilities, provided you maintain
271
+ clear directions next to the object code saying where to find the
272
+ Corresponding Source. Regardless of what server hosts the
273
+ Corresponding Source, you remain obligated to ensure that it is
274
+ available for as long as needed to satisfy these requirements.
275
+
276
+ e) Convey the object code using peer-to-peer transmission, provided
277
+ you inform other peers where the object code and Corresponding
278
+ Source of the work are being offered to the general public at no
279
+ charge under subsection 6d.
280
+
281
+ A separable portion of the object code, whose source code is excluded
282
+ from the Corresponding Source as a System Library, need not be
283
+ included in conveying the object code work.
284
+
285
+ A "User Product" is either (1) a "consumer product", which means any
286
+ tangible personal property which is normally used for personal, family,
287
+ or household purposes, or (2) anything designed or sold for incorporation
288
+ into a dwelling. In determining whether a product is a consumer product,
289
+ doubtful cases shall be resolved in favor of coverage. For a particular
290
+ product received by a particular user, "normally used" refers to a
291
+ typical or common use of that class of product, regardless of the status
292
+ of the particular user or of the way in which the particular user
293
+ actually uses, or expects or is expected to use, the product. A product
294
+ is a consumer product regardless of whether the product has substantial
295
+ commercial, industrial or non-consumer uses, unless such uses represent
296
+ the only significant mode of use of the product.
297
+
298
+ "Installation Information" for a User Product means any methods,
299
+ procedures, authorization keys, or other information required to install
300
+ and execute modified versions of a covered work in that User Product from
301
+ a modified version of its Corresponding Source. The information must
302
+ suffice to ensure that the continued functioning of the modified object
303
+ code is in no case prevented or interfered with solely because
304
+ modification has been made.
305
+
306
+ If you convey an object code work under this section in, or with, or
307
+ specifically for use in, a User Product, and the conveying occurs as
308
+ part of a transaction in which the right of possession and use of the
309
+ User Product is transferred to the recipient in perpetuity or for a
310
+ fixed term (regardless of how the transaction is characterized), the
311
+ Corresponding Source conveyed under this section must be accompanied
312
+ by the Installation Information. But this requirement does not apply
313
+ if neither you nor any third party retains the ability to install
314
+ modified object code on the User Product (for example, the work has
315
+ been installed in ROM).
316
+
317
+ The requirement to provide Installation Information does not include a
318
+ requirement to continue to provide support service, warranty, or updates
319
+ for a work that has been modified or installed by the recipient, or for
320
+ the User Product in which it has been modified or installed. Access to a
321
+ network may be denied when the modification itself materially and
322
+ adversely affects the operation of the network or violates the rules and
323
+ protocols for communication across the network.
324
+
325
+ Corresponding Source conveyed, and Installation Information provided,
326
+ in accord with this section must be in a format that is publicly
327
+ documented (and with an implementation available to the public in
328
+ source code form), and must require no special password or key for
329
+ unpacking, reading or copying.
330
+
331
+ 7. Additional Terms.
332
+
333
+ "Additional permissions" are terms that supplement the terms of this
334
+ License by making exceptions from one or more of its conditions.
335
+ Additional permissions that are applicable to the entire Program shall
336
+ be treated as though they were included in this License, to the extent
337
+ that they are valid under applicable law. If additional permissions
338
+ apply only to part of the Program, that part may be used separately
339
+ under those permissions, but the entire Program remains governed by
340
+ this License without regard to the additional permissions.
341
+
342
+ When you convey a copy of a covered work, you may at your option
343
+ remove any additional permissions from that copy, or from any part of
344
+ it. (Additional permissions may be written to require their own
345
+ removal in certain cases when you modify the work.) You may place
346
+ additional permissions on material, added by you to a covered work,
347
+ for which you have or can give appropriate copyright permission.
348
+
349
+ Notwithstanding any other provision of this License, for material you
350
+ add to a covered work, you may (if authorized by the copyright holders of
351
+ that material) supplement the terms of this License with terms:
352
+
353
+ a) Disclaiming warranty or limiting liability differently from the
354
+ terms of sections 15 and 16 of this License; or
355
+
356
+ b) Requiring preservation of specified reasonable legal notices or
357
+ author attributions in that material or in the Appropriate Legal
358
+ Notices displayed by works containing it; or
359
+
360
+ c) Prohibiting misrepresentation of the origin of that material, or
361
+ requiring that modified versions of such material be marked in
362
+ reasonable ways as different from the original version; or
363
+
364
+ d) Limiting the use for publicity purposes of names of licensors or
365
+ authors of the material; or
366
+
367
+ e) Declining to grant rights under trademark law for use of some
368
+ trade names, trademarks, or service marks; or
369
+
370
+ f) Requiring indemnification of licensors and authors of that
371
+ material by anyone who conveys the material (or modified versions of
372
+ it) with contractual assumptions of liability to the recipient, for
373
+ any liability that these contractual assumptions directly impose on
374
+ those licensors and authors.
375
+
376
+ All other non-permissive additional terms are considered "further
377
+ restrictions" within the meaning of section 10. If the Program as you
378
+ received it, or any part of it, contains a notice stating that it is
379
+ governed by this License along with a term that is a further
380
+ restriction, you may remove that term. If a license document contains
381
+ a further restriction but permits relicensing or conveying under this
382
+ License, you may add to a covered work material governed by the terms
383
+ of that license document, provided that the further restriction does
384
+ not survive such relicensing or conveying.
385
+
386
+ If you add terms to a covered work in accord with this section, you
387
+ must place, in the relevant source files, a statement of the
388
+ additional terms that apply to those files, or a notice indicating
389
+ where to find the applicable terms.
390
+
391
+ Additional terms, permissive or non-permissive, may be stated in the
392
+ form of a separately written license, or stated as exceptions;
393
+ the above requirements apply either way.
394
+
395
+ 8. Termination.
396
+
397
+ You may not propagate or modify a covered work except as expressly
398
+ provided under this License. Any attempt otherwise to propagate or
399
+ modify it is void, and will automatically terminate your rights under
400
+ this License (including any patent licenses granted under the third
401
+ paragraph of section 11).
402
+
403
+ However, if you cease all violation of this License, then your
404
+ license from a particular copyright holder is reinstated (a)
405
+ provisionally, unless and until the copyright holder explicitly and
406
+ finally terminates your license, and (b) permanently, if the copyright
407
+ holder fails to notify you of the violation by some reasonable means
408
+ prior to 60 days after the cessation.
409
+
410
+ Moreover, your license from a particular copyright holder is
411
+ reinstated permanently if the copyright holder notifies you of the
412
+ violation by some reasonable means, this is the first time you have
413
+ received notice of violation of this License (for any work) from that
414
+ copyright holder, and you cure the violation prior to 30 days after
415
+ your receipt of the notice.
416
+
417
+ Termination of your rights under this section does not terminate the
418
+ licenses of parties who have received copies or rights from you under
419
+ this License. If your rights have been terminated and not permanently
420
+ reinstated, you do not qualify to receive new licenses for the same
421
+ material under section 10.
422
+
423
+ 9. Acceptance Not Required for Having Copies.
424
+
425
+ You are not required to accept this License in order to receive or
426
+ run a copy of the Program. Ancillary propagation of a covered work
427
+ occurring solely as a consequence of using peer-to-peer transmission
428
+ to receive a copy likewise does not require acceptance. However,
429
+ nothing other than this License grants you permission to propagate or
430
+ modify any covered work. These actions infringe copyright if you do
431
+ not accept this License. Therefore, by modifying or propagating a
432
+ covered work, you indicate your acceptance of this License to do so.
433
+
434
+ 10. Automatic Licensing of Downstream Recipients.
435
+
436
+ Each time you convey a covered work, the recipient automatically
437
+ receives a license from the original licensors, to run, modify and
438
+ propagate that work, subject to this License. You are not responsible
439
+ for enforcing compliance by third parties with this License.
440
+
441
+ An "entity transaction" is a transaction transferring control of an
442
+ organization, or substantially all assets of one, or subdividing an
443
+ organization, or merging organizations. If propagation of a covered
444
+ work results from an entity transaction, each party to that
445
+ transaction who receives a copy of the work also receives whatever
446
+ licenses to the work the party's predecessor in interest had or could
447
+ give under the previous paragraph, plus a right to possession of the
448
+ Corresponding Source of the work from the predecessor in interest, if
449
+ the predecessor has it or can get it with reasonable efforts.
450
+
451
+ You may not impose any further restrictions on the exercise of the
452
+ rights granted or affirmed under this License. For example, you may
453
+ not impose a license fee, royalty, or other charge for exercise of
454
+ rights granted under this License, and you may not initiate litigation
455
+ (including a cross-claim or counterclaim in a lawsuit) alleging that
456
+ any patent claim is infringed by making, using, selling, offering for
457
+ sale, or importing the Program or any portion of it.
458
+
459
+ 11. Patents.
460
+
461
+ A "contributor" is a copyright holder who authorizes use under this
462
+ License of the Program or a work on which the Program is based. The
463
+ work thus licensed is called the contributor's "contributor version".
464
+
465
+ A contributor's "essential patent claims" are all patent claims
466
+ owned or controlled by the contributor, whether already acquired or
467
+ hereafter acquired, that would be infringed by some manner, permitted
468
+ by this License, of making, using, or selling its contributor version,
469
+ but do not include claims that would be infringed only as a
470
+ consequence of further modification of the contributor version. For
471
+ purposes of this definition, "control" includes the right to grant
472
+ patent sublicenses in a manner consistent with the requirements of
473
+ this License.
474
+
475
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
476
+ patent license under the contributor's essential patent claims, to
477
+ make, use, sell, offer for sale, import and otherwise run, modify and
478
+ propagate the contents of its contributor version.
479
+
480
+ In the following three paragraphs, a "patent license" is any express
481
+ agreement or commitment, however denominated, not to enforce a patent
482
+ (such as an express permission to practice a patent or covenant not to
483
+ sue for patent infringement). To "grant" such a patent license to a
484
+ party means to make such an agreement or commitment not to enforce a
485
+ patent against the party.
486
+
487
+ If you convey a covered work, knowingly relying on a patent license,
488
+ and the Corresponding Source of the work is not available for anyone
489
+ to copy, free of charge and under the terms of this License, through a
490
+ publicly available network server or other readily accessible means,
491
+ then you must either (1) cause the Corresponding Source to be so
492
+ available, or (2) arrange to deprive yourself of the benefit of the
493
+ patent license for this particular work, or (3) arrange, in a manner
494
+ consistent with the requirements of this License, to extend the patent
495
+ license to downstream recipients. "Knowingly relying" means you have
496
+ actual knowledge that, but for the patent license, your conveying the
497
+ covered work in a country, or your recipient's use of the covered work
498
+ in a country, would infringe one or more identifiable patents in that
499
+ country that you have reason to believe are valid.
500
+
501
+ If, pursuant to or in connection with a single transaction or
502
+ arrangement, you convey, or propagate by procuring conveyance of, a
503
+ covered work, and grant a patent license to some of the parties
504
+ receiving the covered work authorizing them to use, propagate, modify
505
+ or convey a specific copy of the covered work, then the patent license
506
+ you grant is automatically extended to all recipients of the covered
507
+ work and works based on it.
508
+
509
+ A patent license is "discriminatory" if it does not include within
510
+ the scope of its coverage, prohibits the exercise of, or is
511
+ conditioned on the non-exercise of one or more of the rights that are
512
+ specifically granted under this License. You may not convey a covered
513
+ work if you are a party to an arrangement with a third party that is
514
+ in the business of distributing software, under which you make payment
515
+ to the third party based on the extent of your activity of conveying
516
+ the work, and under which the third party grants, to any of the
517
+ parties who would receive the covered work from you, a discriminatory
518
+ patent license (a) in connection with copies of the covered work
519
+ conveyed by you (or copies made from those copies), or (b) primarily
520
+ for and in connection with specific products or compilations that
521
+ contain the covered work, unless you entered into that arrangement,
522
+ or that patent license was granted, prior to 28 March 2007.
523
+
524
+ Nothing in this License shall be construed as excluding or limiting
525
+ any implied license or other defenses to infringement that may
526
+ otherwise be available to you under applicable patent law.
527
+
528
+ 12. No Surrender of Others' Freedom.
529
+
530
+ If conditions are imposed on you (whether by court order, agreement or
531
+ otherwise) that contradict the conditions of this License, they do not
532
+ excuse you from the conditions of this License. If you cannot convey a
533
+ covered work so as to satisfy simultaneously your obligations under this
534
+ License and any other pertinent obligations, then as a consequence you may
535
+ not convey it at all. For example, if you agree to terms that obligate you
536
+ to collect a royalty for further conveying from those to whom you convey
537
+ the Program, the only way you could satisfy both those terms and this
538
+ License would be to refrain entirely from conveying the Program.
539
+
540
+ 13. Remote Network Interaction; Use with the GNU General Public License.
541
+
542
+ Notwithstanding any other provision of this License, if you modify the
543
+ Program, your modified version must prominently offer all users
544
+ interacting with it remotely through a computer network (if your version
545
+ supports such interaction) an opportunity to receive the Corresponding
546
+ Source of your version by providing access to the Corresponding Source
547
+ from a network server at no charge, through some standard or customary
548
+ means of facilitating copying of software. This Corresponding Source
549
+ shall include the Corresponding Source for any work covered by version 3
550
+ of the GNU General Public License that is incorporated pursuant to the
551
+ following paragraph.
552
+
553
+ Notwithstanding any other provision of this License, you have
554
+ permission to link or combine any covered work with a work licensed
555
+ under version 3 of the GNU General Public License into a single
556
+ combined work, and to convey the resulting work. The terms of this
557
+ License will continue to apply to the part which is the covered work,
558
+ but the work with which it is combined will remain governed by version
559
+ 3 of the GNU General Public License.
560
+
561
+ 14. Revised Versions of this License.
562
+
563
+ The Free Software Foundation may publish revised and/or new versions of
564
+ the GNU Affero General Public License from time to time. Such new versions
565
+ will be similar in spirit to the present version, but may differ in detail to
566
+ address new problems or concerns.
567
+
568
+ Each version is given a distinguishing version number. If the
569
+ Program specifies that a certain numbered version of the GNU Affero General
570
+ Public License "or any later version" applies to it, you have the
571
+ option of following the terms and conditions either of that numbered
572
+ version or of any later version published by the Free Software
573
+ Foundation. If the Program does not specify a version number of the
574
+ GNU Affero General Public License, you may choose any version ever published
575
+ by the Free Software Foundation.
576
+
577
+ If the Program specifies that a proxy can decide which future
578
+ versions of the GNU Affero General Public License can be used, that proxy's
579
+ public statement of acceptance of a version permanently authorizes you
580
+ to choose that version for the Program.
581
+
582
+ Later license versions may give you additional or different
583
+ permissions. However, no additional obligations are imposed on any
584
+ author or copyright holder as a result of your choosing to follow a
585
+ later version.
586
+
587
+ 15. Disclaimer of Warranty.
588
+
589
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
590
+ APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
591
+ HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
592
+ OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
593
+ THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
594
+ PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
595
+ IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
596
+ ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
597
+
598
+ 16. Limitation of Liability.
599
+
600
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
601
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
602
+ THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
603
+ GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
604
+ USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
605
+ DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
606
+ PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
607
+ EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
608
+ SUCH DAMAGES.
609
+
610
+ 17. Interpretation of Sections 15 and 16.
611
+
612
+ If the disclaimer of warranty and limitation of liability provided
613
+ above cannot be given local legal effect according to their terms,
614
+ reviewing courts shall apply local law that most closely approximates
615
+ an absolute waiver of all civil liability in connection with the
616
+ Program, unless a warranty or assumption of liability accompanies a
617
+ copy of the Program in return for a fee.
618
+
619
+ END OF TERMS AND CONDITIONS
620
+
621
+ How to Apply These Terms to Your New Programs
622
+
623
+ If you develop a new program, and you want it to be of the greatest
624
+ possible use to the public, the best way to achieve this is to make it
625
+ free software which everyone can redistribute and change under these terms.
626
+
627
+ To do so, attach the following notices to the program. It is safest
628
+ to attach them to the start of each source file to most effectively
629
+ state the exclusion of warranty; and each file should have at least
630
+ the "copyright" line and a pointer to where the full notice is found.
631
+
632
+ <one line to give the program's name and a brief idea of what it does.>
633
+ Copyright (C) <year> <name of author>
634
+
635
+ This program is free software: you can redistribute it and/or modify
636
+ it under the terms of the GNU Affero General Public License as published by
637
+ the Free Software Foundation, either version 3 of the License, or
638
+ (at your option) any later version.
639
+
640
+ This program is distributed in the hope that it will be useful,
641
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
642
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
643
+ GNU Affero General Public License for more details.
644
+
645
+ You should have received a copy of the GNU Affero General Public License
646
+ along with this program. If not, see <https://www.gnu.org/licenses/>.
647
+
648
+ Also add information on how to contact you by electronic and paper mail.
649
+
650
+ If your software can interact with users remotely through a computer
651
+ network, you should also make sure that it provides a way for users to
652
+ get its source. For example, if your program is a web application, its
653
+ interface could display a "Source" link that leads users to an archive
654
+ of the code. There are many ways you could offer source, and different
655
+ solutions will be better for different programs; see section 13 for the
656
+ specific requirements.
657
+
658
+ You should also get your employer (if you work as a programmer) or school,
659
+ if any, to sign a "copyright disclaimer" for the program, if necessary.
660
+ For more information on this, and how to apply and follow the GNU AGPL, see
661
+ <https://www.gnu.org/licenses/>.
yolov8-to/MANIFEST.in ADDED
@@ -0,0 +1,8 @@
 
 
 
 
 
 
 
 
 
1
+ include *.md
2
+ include requirements.txt
3
+ include LICENSE
4
+ include setup.py
5
+ include ultralytics/assets/bus.jpg
6
+ include ultralytics/assets/zidane.jpg
7
+ recursive-include ultralytics *.yaml
8
+ recursive-exclude __pycache__ *
yolov8-to/README.md ADDED
@@ -0,0 +1,271 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <div align="center">
2
+ <p>
3
+ <a href="https://ultralytics.com/yolov8" target="_blank">
4
+ <img width="100%" src="https://raw.githubusercontent.com/ultralytics/assets/main/yolov8/banner-yolov8.png"></a>
5
+ </p>
6
+
7
+ [English](README.md) | [简体中文](README.zh-CN.md)
8
+ <br>
9
+
10
+ <div>
11
+ <a href="https://github.com/ultralytics/ultralytics/actions/workflows/ci.yaml"><img src="https://github.com/ultralytics/ultralytics/actions/workflows/ci.yaml/badge.svg" alt="Ultralytics CI"></a>
12
+ <a href="https://codecov.io/github/ultralytics/ultralytics"><img src="https://codecov.io/github/ultralytics/ultralytics/branch/main/graph/badge.svg?token=HHW7IIVFVY" alt="Ultralytics Code Coverage"></a>
13
+ <a href="https://zenodo.org/badge/latestdoi/264818686"><img src="https://zenodo.org/badge/264818686.svg" alt="YOLOv8 Citation"></a>
14
+ <a href="https://hub.docker.com/r/ultralytics/ultralytics"><img src="https://img.shields.io/docker/pulls/ultralytics/ultralytics?logo=docker" alt="Docker Pulls"></a>
15
+ <br>
16
+ <a href="https://console.paperspace.com/github/ultralytics/ultralytics"><img src="https://assets.paperspace.io/img/gradient-badge.svg" alt="Run on Gradient"/></a>
17
+ <a href="https://colab.research.google.com/github/ultralytics/ultralytics/blob/main/examples/tutorial.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"></a>
18
+ <a href="https://www.kaggle.com/ultralytics/yolov8"><img src="https://kaggle.com/static/images/open-in-kaggle.svg" alt="Open In Kaggle"></a>
19
+ </div>
20
+ <br>
21
+
22
+ [Ultralytics](https://ultralytics.com) [YOLOv8](https://github.com/ultralytics/ultralytics) is a cutting-edge, state-of-the-art (SOTA) model that builds upon the success of previous YOLO versions and introduces new features and improvements to further boost performance and flexibility. YOLOv8 is designed to be fast, accurate, and easy to use, making it an excellent choice for a wide range of object detection and tracking, instance segmentation, image classification and pose estimation tasks.
23
+
24
+ We hope that the resources here will help you get the most out of YOLOv8. Please browse the YOLOv8 <a href="https://docs.ultralytics.com/">Docs</a> for details, raise an issue on <a href="https://github.com/ultralytics/ultralytics/issues/new/choose">GitHub</a> for support, and join our <a href="https://ultralytics.com/discord">Discord</a> community for questions and discussions!
25
+
26
+ To request an Enterprise License please complete the form at [Ultralytics Licensing](https://ultralytics.com/license).
27
+
28
+ <img width="100%" src="https://raw.githubusercontent.com/ultralytics/assets/main/yolov8/yolo-comparison-plots.png"></a>
29
+
30
+ <div align="center">
31
+ <a href="https://github.com/ultralytics" style="text-decoration:none;">
32
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-github.png" width="2%" alt="" /></a>
33
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="2%" alt="" />
34
+ <a href="https://www.linkedin.com/company/ultralytics/" style="text-decoration:none;">
35
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-linkedin.png" width="2%" alt="" /></a>
36
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="2%" alt="" />
37
+ <a href="https://twitter.com/ultralytics" style="text-decoration:none;">
38
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-twitter.png" width="2%" alt="" /></a>
39
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="2%" alt="" />
40
+ <a href="https://youtube.com/ultralytics" style="text-decoration:none;">
41
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-youtube.png" width="2%" alt="" /></a>
42
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="2%" alt="" />
43
+ <a href="https://www.tiktok.com/@ultralytics" style="text-decoration:none;">
44
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-tiktok.png" width="2%" alt="" /></a>
45
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="2%" alt="" />
46
+ <a href="https://www.instagram.com/ultralytics/" style="text-decoration:none;">
47
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-instagram.png" width="2%" alt="" /></a>
48
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="2%" alt="" />
49
+ <a href="https://ultralytics.com/discord" style="text-decoration:none;">
50
+ <img src="https://github.com/ultralytics/assets/blob/main/social/logo-social-discord.png" width="2%" alt="" /></a>
51
+ </div>
52
+ </div>
53
+
54
+ ## <div align="center">Documentation</div>
55
+
56
+ See below for a quickstart installation and usage example, and see the [YOLOv8 Docs](https://docs.ultralytics.com) for full documentation on training, validation, prediction and deployment.
57
+
58
+ <details open>
59
+ <summary>Install</summary>
60
+
61
+ Pip install the ultralytics package including all [requirements](https://github.com/ultralytics/ultralytics/blob/main/requirements.txt) in a [**Python>=3.8**](https://www.python.org/) environment with [**PyTorch>=1.8**](https://pytorch.org/get-started/locally/).
62
+
63
+ [![PyPI version](https://badge.fury.io/py/ultralytics.svg)](https://badge.fury.io/py/ultralytics) [![Downloads](https://static.pepy.tech/badge/ultralytics)](https://pepy.tech/project/ultralytics)
64
+
65
+ ```bash
66
+ pip install ultralytics
67
+ ```
68
+
69
+ For alternative installation methods including [Conda](https://anaconda.org/conda-forge/ultralytics), [Docker](https://hub.docker.com/r/ultralytics/ultralytics), and Git, please refer to the [Quickstart Guide](https://docs.ultralytics.com/quickstart).
70
+
71
+ </details>
72
+
73
+ <details open>
74
+ <summary>Usage</summary>
75
+
76
+ #### CLI
77
+
78
+ YOLOv8 may be used directly in the Command Line Interface (CLI) with a `yolo` command:
79
+
80
+ ```bash
81
+ yolo predict model=yolov8n.pt source='https://ultralytics.com/images/bus.jpg'
82
+ ```
83
+
84
+ `yolo` can be used for a variety of tasks and modes and accepts additional arguments, i.e. `imgsz=640`. See the YOLOv8 [CLI Docs](https://docs.ultralytics.com/usage/cli) for examples.
85
+
86
+ #### Python
87
+
88
+ YOLOv8 may also be used directly in a Python environment, and accepts the same [arguments](https://docs.ultralytics.com/usage/cfg/) as in the CLI example above:
89
+
90
+ ```python
91
+ from ultralytics import YOLO
92
+
93
+ # Load a model
94
+ model = YOLO("yolov8n.yaml") # build a new model from scratch
95
+ model = YOLO("yolov8n.pt") # load a pretrained model (recommended for training)
96
+
97
+ # Use the model
98
+ model.train(data="coco128.yaml", epochs=3) # train the model
99
+ metrics = model.val() # evaluate model performance on the validation set
100
+ results = model("https://ultralytics.com/images/bus.jpg") # predict on an image
101
+ path = model.export(format="onnx") # export the model to ONNX format
102
+ ```
103
+
104
+ [Models](https://github.com/ultralytics/ultralytics/tree/main/ultralytics/cfg/models) download automatically from the latest Ultralytics [release](https://github.com/ultralytics/assets/releases). See YOLOv8 [Python Docs](https://docs.ultralytics.com/usage/python) for more examples.
105
+
106
+ </details>
107
+
108
+ ## <div align="center">Models</div>
109
+
110
+ YOLOv8 [Detect](https://docs.ultralytics.com/tasks/detect), [Segment](https://docs.ultralytics.com/tasks/segment) and [Pose](https://docs.ultralytics.com/tasks/pose) models pretrained on the [COCO](https://docs.ultralytics.com/datasets/detect/coco) dataset are available here, as well as YOLOv8 [Classify](https://docs.ultralytics.com/tasks/classify) models pretrained on the [ImageNet](https://docs.ultralytics.com/datasets/classify/imagenet) dataset. [Track](https://docs.ultralytics.com/modes/track) mode is available for all Detect, Segment and Pose models.
111
+
112
+ <img width="1024" src="https://raw.githubusercontent.com/ultralytics/assets/main/im/banner-tasks.png">
113
+
114
+ All [Models](https://github.com/ultralytics/ultralytics/tree/main/ultralytics/cfg/models) download automatically from the latest Ultralytics [release](https://github.com/ultralytics/assets/releases) on first use.
115
+
116
+ <details open><summary>Detection</summary>
117
+
118
+ See [Detection Docs](https://docs.ultralytics.com/tasks/detect/) for usage examples with these models.
119
+
120
+ | Model | size<br><sup>(pixels) | mAP<sup>val<br>50-95 | Speed<br><sup>CPU ONNX<br>(ms) | Speed<br><sup>A100 TensorRT<br>(ms) | params<br><sup>(M) | FLOPs<br><sup>(B) |
121
+ | ------------------------------------------------------------------------------------ | --------------------- | -------------------- | ------------------------------ | ----------------------------------- | ------------------ | ----------------- |
122
+ | [YOLOv8n](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8n.pt) | 640 | 37.3 | 80.4 | 0.99 | 3.2 | 8.7 |
123
+ | [YOLOv8s](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8s.pt) | 640 | 44.9 | 128.4 | 1.20 | 11.2 | 28.6 |
124
+ | [YOLOv8m](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8m.pt) | 640 | 50.2 | 234.7 | 1.83 | 25.9 | 78.9 |
125
+ | [YOLOv8l](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8l.pt) | 640 | 52.9 | 375.2 | 2.39 | 43.7 | 165.2 |
126
+ | [YOLOv8x](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8x.pt) | 640 | 53.9 | 479.1 | 3.53 | 68.2 | 257.8 |
127
+
128
+ - **mAP<sup>val</sup>** values are for single-model single-scale on [COCO val2017](http://cocodataset.org) dataset.
129
+ <br>Reproduce by `yolo val detect data=coco.yaml device=0`
130
+ - **Speed** averaged over COCO val images using an [Amazon EC2 P4d](https://aws.amazon.com/ec2/instance-types/p4/) instance.
131
+ <br>Reproduce by `yolo val detect data=coco128.yaml batch=1 device=0|cpu`
132
+
133
+ </details>
134
+
135
+ <details><summary>Segmentation</summary>
136
+
137
+ See [Segmentation Docs](https://docs.ultralytics.com/tasks/segment/) for usage examples with these models.
138
+
139
+ | Model | size<br><sup>(pixels) | mAP<sup>box<br>50-95 | mAP<sup>mask<br>50-95 | Speed<br><sup>CPU ONNX<br>(ms) | Speed<br><sup>A100 TensorRT<br>(ms) | params<br><sup>(M) | FLOPs<br><sup>(B) |
140
+ | -------------------------------------------------------------------------------------------- | --------------------- | -------------------- | --------------------- | ------------------------------ | ----------------------------------- | ------------------ | ----------------- |
141
+ | [YOLOv8n-seg](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8n-seg.pt) | 640 | 36.7 | 30.5 | 96.1 | 1.21 | 3.4 | 12.6 |
142
+ | [YOLOv8s-seg](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8s-seg.pt) | 640 | 44.6 | 36.8 | 155.7 | 1.47 | 11.8 | 42.6 |
143
+ | [YOLOv8m-seg](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8m-seg.pt) | 640 | 49.9 | 40.8 | 317.0 | 2.18 | 27.3 | 110.2 |
144
+ | [YOLOv8l-seg](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8l-seg.pt) | 640 | 52.3 | 42.6 | 572.4 | 2.79 | 46.0 | 220.5 |
145
+ | [YOLOv8x-seg](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8x-seg.pt) | 640 | 53.4 | 43.4 | 712.1 | 4.02 | 71.8 | 344.1 |
146
+
147
+ - **mAP<sup>val</sup>** values are for single-model single-scale on [COCO val2017](http://cocodataset.org) dataset.
148
+ <br>Reproduce by `yolo val segment data=coco.yaml device=0`
149
+ - **Speed** averaged over COCO val images using an [Amazon EC2 P4d](https://aws.amazon.com/ec2/instance-types/p4/) instance.
150
+ <br>Reproduce by `yolo val segment data=coco128-seg.yaml batch=1 device=0|cpu`
151
+
152
+ </details>
153
+
154
+ <details><summary>Classification</summary>
155
+
156
+ See [Classification Docs](https://docs.ultralytics.com/tasks/classify/) for usage examples with these models.
157
+
158
+ | Model | size<br><sup>(pixels) | acc<br><sup>top1 | acc<br><sup>top5 | Speed<br><sup>CPU ONNX<br>(ms) | Speed<br><sup>A100 TensorRT<br>(ms) | params<br><sup>(M) | FLOPs<br><sup>(B) at 640 |
159
+ | -------------------------------------------------------------------------------------------- | --------------------- | ---------------- | ---------------- | ------------------------------ | ----------------------------------- | ------------------ | ------------------------ |
160
+ | [YOLOv8n-cls](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8n-cls.pt) | 224 | 66.6 | 87.0 | 12.9 | 0.31 | 2.7 | 4.3 |
161
+ | [YOLOv8s-cls](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8s-cls.pt) | 224 | 72.3 | 91.1 | 23.4 | 0.35 | 6.4 | 13.5 |
162
+ | [YOLOv8m-cls](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8m-cls.pt) | 224 | 76.4 | 93.2 | 85.4 | 0.62 | 17.0 | 42.7 |
163
+ | [YOLOv8l-cls](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8l-cls.pt) | 224 | 78.0 | 94.1 | 163.0 | 0.87 | 37.5 | 99.7 |
164
+ | [YOLOv8x-cls](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8x-cls.pt) | 224 | 78.4 | 94.3 | 232.0 | 1.01 | 57.4 | 154.8 |
165
+
166
+ - **acc** values are model accuracies on the [ImageNet](https://www.image-net.org/) dataset validation set.
167
+ <br>Reproduce by `yolo val classify data=path/to/ImageNet device=0`
168
+ - **Speed** averaged over ImageNet val images using an [Amazon EC2 P4d](https://aws.amazon.com/ec2/instance-types/p4/) instance.
169
+ <br>Reproduce by `yolo val classify data=path/to/ImageNet batch=1 device=0|cpu`
170
+
171
+ </details>
172
+
173
+ <details><summary>Pose</summary>
174
+
175
+ See [Pose Docs](https://docs.ultralytics.com/tasks/pose) for usage examples with these models.
176
+
177
+ | Model | size<br><sup>(pixels) | mAP<sup>pose<br>50-95 | mAP<sup>pose<br>50 | Speed<br><sup>CPU ONNX<br>(ms) | Speed<br><sup>A100 TensorRT<br>(ms) | params<br><sup>(M) | FLOPs<br><sup>(B) |
178
+ | ---------------------------------------------------------------------------------------------------- | --------------------- | --------------------- | ------------------ | ------------------------------ | ----------------------------------- | ------------------ | ----------------- |
179
+ | [YOLOv8n-pose](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8n-pose.pt) | 640 | 50.4 | 80.1 | 131.8 | 1.18 | 3.3 | 9.2 |
180
+ | [YOLOv8s-pose](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8s-pose.pt) | 640 | 60.0 | 86.2 | 233.2 | 1.42 | 11.6 | 30.2 |
181
+ | [YOLOv8m-pose](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8m-pose.pt) | 640 | 65.0 | 88.8 | 456.3 | 2.00 | 26.4 | 81.0 |
182
+ | [YOLOv8l-pose](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8l-pose.pt) | 640 | 67.6 | 90.0 | 784.5 | 2.59 | 44.4 | 168.6 |
183
+ | [YOLOv8x-pose](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8x-pose.pt) | 640 | 69.2 | 90.2 | 1607.1 | 3.73 | 69.4 | 263.2 |
184
+ | [YOLOv8x-pose-p6](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8x-pose-p6.pt) | 1280 | 71.6 | 91.2 | 4088.7 | 10.04 | 99.1 | 1066.4 |
185
+
186
+ - **mAP<sup>val</sup>** values are for single-model single-scale on [COCO Keypoints val2017](http://cocodataset.org)
187
+ dataset.
188
+ <br>Reproduce by `yolo val pose data=coco-pose.yaml device=0`
189
+ - **Speed** averaged over COCO val images using an [Amazon EC2 P4d](https://aws.amazon.com/ec2/instance-types/p4/) instance.
190
+ <br>Reproduce by `yolo val pose data=coco8-pose.yaml batch=1 device=0|cpu`
191
+
192
+ </details>
193
+
194
+ ## <div align="center">Integrations</div>
195
+
196
+ Our key integrations with leading AI platforms extend the functionality of Ultralytics' offerings, enhancing tasks like dataset labeling, training, visualization, and model management. Discover how Ultralytics, in collaboration with [Roboflow](https://roboflow.com/?ref=ultralytics), ClearML, [Comet](https://bit.ly/yolov8-readme-comet), Neural Magic and [OpenVINO](https://docs.ultralytics.com/integrations/openvino), can optimize your AI workflow.
197
+
198
+ <br>
199
+ <a href="https://bit.ly/ultralytics_hub" target="_blank">
200
+ <img width="100%" src="https://github.com/ultralytics/assets/raw/main/yolov8/banner-integrations.png"></a>
201
+ <br>
202
+ <br>
203
+
204
+ <div align="center">
205
+ <a href="https://roboflow.com/?ref=ultralytics">
206
+ <img src="https://github.com/ultralytics/assets/raw/main/partners/logo-roboflow.png" width="10%" /></a>
207
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="15%" height="0" alt="" />
208
+ <a href="https://cutt.ly/yolov5-readme-clearml">
209
+ <img src="https://github.com/ultralytics/assets/raw/main/partners/logo-clearml.png" width="10%" /></a>
210
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="15%" height="0" alt="" />
211
+ <a href="https://bit.ly/yolov8-readme-comet">
212
+ <img src="https://github.com/ultralytics/assets/raw/main/partners/logo-comet.png" width="10%" /></a>
213
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="15%" height="0" alt="" />
214
+ <a href="https://bit.ly/yolov5-neuralmagic">
215
+ <img src="https://github.com/ultralytics/assets/raw/main/partners/logo-neuralmagic.png" width="10%" /></a>
216
+ </div>
217
+
218
+ | Roboflow | ClearML ⭐ NEW | Comet ⭐ NEW | Neural Magic ⭐ NEW |
219
+ | :--------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------: |
220
+ | Label and export your custom datasets directly to YOLOv8 for training with [Roboflow](https://roboflow.com/?ref=ultralytics) | Automatically track, visualize and even remotely train YOLOv8 using [ClearML](https://cutt.ly/yolov5-readme-clearml) (open-source!) | Free forever, [Comet](https://bit.ly/yolov8-readme-comet) lets you save YOLOv8 models, resume training, and interactively visualize and debug predictions | Run YOLOv8 inference up to 6x faster with [Neural Magic DeepSparse](https://bit.ly/yolov5-neuralmagic) |
221
+
222
+ ## <div align="center">Ultralytics HUB</div>
223
+
224
+ Experience seamless AI with [Ultralytics HUB](https://bit.ly/ultralytics_hub) ⭐, the all-in-one solution for data visualization, YOLOv5 and YOLOv8 🚀 model training and deployment, without any coding. Transform images into actionable insights and bring your AI visions to life with ease using our cutting-edge platform and user-friendly [Ultralytics App](https://ultralytics.com/app_install). Start your journey for **Free** now!
225
+
226
+ <a href="https://bit.ly/ultralytics_hub" target="_blank">
227
+ <img width="100%" src="https://github.com/ultralytics/assets/raw/main/im/ultralytics-hub.png"></a>
228
+
229
+ ## <div align="center">Contribute</div>
230
+
231
+ We love your input! YOLOv5 and YOLOv8 would not be possible without help from our community. Please see our [Contributing Guide](https://docs.ultralytics.com/help/contributing) to get started, and fill out our [Survey](https://ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey) to send us feedback on your experience. Thank you 🙏 to all our contributors!
232
+
233
+ <!-- SVG image from https://opencollective.com/ultralytics/contributors.svg?width=990 -->
234
+
235
+ <a href="https://github.com/ultralytics/yolov5/graphs/contributors">
236
+ <img width="100%" src="https://github.com/ultralytics/assets/raw/main/im/image-contributors.png"></a>
237
+
238
+ ## <div align="center">License</div>
239
+
240
+ Ultralytics offers two licensing options to accommodate diverse use cases:
241
+
242
+ - **AGPL-3.0 License**: This [OSI-approved](https://opensource.org/licenses/) open-source license is ideal for students and enthusiasts, promoting open collaboration and knowledge sharing. See the [LICENSE](https://github.com/ultralytics/ultralytics/blob/main/LICENSE) file for more details.
243
+ - **Enterprise License**: Designed for commercial use, this license permits seamless integration of Ultralytics software and AI models into commercial goods and services, bypassing the open-source requirements of AGPL-3.0. If your scenario involves embedding our solutions into a commercial offering, reach out through [Ultralytics Licensing](https://ultralytics.com/license).
244
+
245
+ ## <div align="center">Contact</div>
246
+
247
+ For Ultralytics bug reports and feature requests please visit [GitHub Issues](https://github.com/ultralytics/ultralytics/issues), and join our [Discord](https://ultralytics.com/discord) community for questions and discussions!
248
+
249
+ <br>
250
+ <div align="center">
251
+ <a href="https://github.com/ultralytics" style="text-decoration:none;">
252
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-github.png" width="3%" alt="" /></a>
253
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="" />
254
+ <a href="https://www.linkedin.com/company/ultralytics/" style="text-decoration:none;">
255
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-linkedin.png" width="3%" alt="" /></a>
256
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="" />
257
+ <a href="https://twitter.com/ultralytics" style="text-decoration:none;">
258
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-twitter.png" width="3%" alt="" /></a>
259
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="" />
260
+ <a href="https://youtube.com/ultralytics" style="text-decoration:none;">
261
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-youtube.png" width="3%" alt="" /></a>
262
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="" />
263
+ <a href="https://www.tiktok.com/@ultralytics" style="text-decoration:none;">
264
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-tiktok.png" width="3%" alt="" /></a>
265
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="" />
266
+ <a href="https://www.instagram.com/ultralytics/" style="text-decoration:none;">
267
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-instagram.png" width="3%" alt="" /></a>
268
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="" />
269
+ <a href="https://ultralytics.com/discord" style="text-decoration:none;">
270
+ <img src="https://github.com/ultralytics/assets/blob/main/social/logo-social-discord.png" width="3%" alt="" /></a>
271
+ </div>
yolov8-to/README.zh-CN.md ADDED
@@ -0,0 +1,269 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <div align="center">
2
+ <p>
3
+ <a href="https://ultralytics.com/yolov8" target="_blank">
4
+ <img width="100%" src="https://raw.githubusercontent.com/ultralytics/assets/main/yolov8/banner-yolov8.png"></a>
5
+ </p>
6
+
7
+ [English](README.md) | [简体中文](README.zh-CN.md)
8
+ <br>
9
+
10
+ <div>
11
+ <a href="https://github.com/ultralytics/ultralytics/actions/workflows/ci.yaml"><img src="https://github.com/ultralytics/ultralytics/actions/workflows/ci.yaml/badge.svg" alt="Ultralytics CI"></a>
12
+ <a href="https://codecov.io/github/ultralytics/ultralytics"><img src="https://codecov.io/github/ultralytics/ultralytics/branch/main/graph/badge.svg?token=HHW7IIVFVY" alt="Ultralytics Code Coverage"></a>
13
+ <a href="https://zenodo.org/badge/latestdoi/264818686"><img src="https://zenodo.org/badge/264818686.svg" alt="YOLOv8 Citation"></a>
14
+ <a href="https://hub.docker.com/r/ultralytics/ultralytics"><img src="https://img.shields.io/docker/pulls/ultralytics/ultralytics?logo=docker" alt="Docker Pulls"></a>
15
+ <br>
16
+ <a href="https://console.paperspace.com/github/ultralytics/ultralytics"><img src="https://assets.paperspace.io/img/gradient-badge.svg" alt="Run on Gradient"/></a>
17
+ <a href="https://colab.research.google.com/github/ultralytics/ultralytics/blob/main/examples/tutorial.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"></a>
18
+ <a href="https://www.kaggle.com/ultralytics/yolov8"><img src="https://kaggle.com/static/images/open-in-kaggle.svg" alt="Open In Kaggle"></a>
19
+ </div>
20
+ <br>
21
+
22
+ [Ultralytics](https://ultralytics.com) [YOLOv8](https://github.com/ultralytics/ultralytics) 是一款前沿、最先进(SOTA)的模型,基于先前 YOLO 版本的成功,引入了新功能和改进,进一步提升性能和灵活性。YOLOv8 设计快速、准确且易于使用,使其成为各种物体检测与跟踪、实例分割、图像分类和姿态估计任务的绝佳选择。
23
+
24
+ 我们希望这里的资源能帮助您充分利用 YOLOv8。请浏览 YOLOv8 <a href="https://docs.ultralytics.com/">文档</a> 了解详细信息,在 <a href="https://github.com/ultralytics/ultralytics/issues/new/choose">GitHub</a> 上提交问题以获得支持,并加入我们的 <a href="https://ultralytics.com/discord">Discord</a> 社区进行问题和讨论!
25
+
26
+ 如需申请企业许可,请在 [Ultralytics Licensing](https://ultralytics.com/license) 处填写表格
27
+
28
+ <img width="100%" src="https://raw.githubusercontent.com/ultralytics/assets/main/yolov8/yolo-comparison-plots.png"></a>
29
+
30
+ <div align="center">
31
+ <a href="https://github.com/ultralytics" style="text-decoration:none;">
32
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-github.png" width="2%" alt="" /></a>
33
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="2%" alt="" />
34
+ <a href="https://www.linkedin.com/company/ultralytics/" style="text-decoration:none;">
35
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-linkedin.png" width="2%" alt="" /></a>
36
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="2%" alt="" />
37
+ <a href="https://twitter.com/ultralytics" style="text-decoration:none;">
38
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-twitter.png" width="2%" alt="" /></a>
39
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="2%" alt="" />
40
+ <a href="https://youtube.com/ultralytics" style="text-decoration:none;">
41
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-youtube.png" width="2%" alt="" /></a>
42
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="2%" alt="" />
43
+ <a href="https://www.tiktok.com/@ultralytics" style="text-decoration:none;">
44
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-tiktok.png" width="2%" alt="" /></a>
45
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="2%" alt="" />
46
+ <a href="https://www.instagram.com/ultralytics/" style="text-decoration:none;">
47
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-instagram.png" width="2%" alt="" /></a>
48
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="2%" alt="" />
49
+ <a href="https://ultralytics.com/discord" style="text-decoration:none;">
50
+ <img src="https://github.com/ultralytics/assets/blob/main/social/logo-social-discord.png" width="2%" alt="" /></a>
51
+ </div>
52
+ </div>
53
+
54
+ ## <div align="center">文档</div>
55
+
56
+ 请参阅下面的快速安装和使用示例,以及 [YOLOv8 文档](https://docs.ultralytics.com) 上有关培训、验证、预测和部署的完整文档。
57
+
58
+ <details open>
59
+ <summary>安装</summary>
60
+
61
+ 使用Pip在一个[**Python>=3.8**](https://www.python.org/)环境中安装`ultralytics`包,此环境还需包含[**PyTorch>=1.8**](https://pytorch.org/get-started/locally/)。这也会安��所有必要的[依赖项](https://github.com/ultralytics/ultralytics/blob/main/requirements.txt)。
62
+
63
+ [![PyPI version](https://badge.fury.io/py/ultralytics.svg)](https://badge.fury.io/py/ultralytics) [![Downloads](https://static.pepy.tech/badge/ultralytics)](https://pepy.tech/project/ultralytics)
64
+
65
+ ```bash
66
+ pip install ultralytics
67
+ ```
68
+
69
+ 如需使用包括[Conda](https://anaconda.org/conda-forge/ultralytics)、[Docker](https://hub.docker.com/r/ultralytics/ultralytics)和Git在内的其他安装方法,请参考[快速入门指南](https://docs.ultralytics.com/quickstart)。
70
+
71
+ </details>
72
+
73
+ <details open>
74
+ <summary>Usage</summary>
75
+
76
+ #### CLI
77
+
78
+ YOLOv8 可以在命令行界面(CLI)中直接使用,只需输入 `yolo` 命令:
79
+
80
+ ```bash
81
+ yolo predict model=yolov8n.pt source='https://ultralytics.com/images/bus.jpg'
82
+ ```
83
+
84
+ `yolo` 可用于各种任务和模式,并接受其他参数,例如 `imgsz=640`。查看 YOLOv8 [CLI 文档](https://docs.ultralytics.com/usage/cli)以获取示例。
85
+
86
+ #### Python
87
+
88
+ YOLOv8 也可以在 Python 环境中直接使用,并接受与上述 CLI 示例中相同的[参数](https://docs.ultralytics.com/usage/cfg/):
89
+
90
+ ```python
91
+ from ultralytics import YOLO
92
+
93
+ # 加载模型
94
+ model = YOLO("yolov8n.yaml") # 从头开始构建新模型
95
+ model = YOLO("yolov8n.pt") # 加载预训练模型(建议用于训练)
96
+
97
+ # 使用模型
98
+ model.train(data="coco128.yaml", epochs=3) # 训练模型
99
+ metrics = model.val() # 在验证集上评估模型性能
100
+ results = model("https://ultralytics.com/images/bus.jpg") # 对图像进行预测
101
+ success = model.export(format="onnx") # 将模型导出为 ONNX 格式
102
+ ```
103
+
104
+ [模型](https://github.com/ultralytics/ultralytics/tree/main/ultralytics/cfg/models) 会自动从最新的 Ultralytics [发布版本](https://github.com/ultralytics/assets/releases)中下载。查看 YOLOv8 [Python 文档](https://docs.ultralytics.com/usage/python)以获取更多示例。
105
+
106
+ </details>
107
+
108
+ ## <div align="center">模型</div>
109
+
110
+ 在[COCO](https://docs.ultralytics.com/datasets/detect/coco)数据集上预训练的YOLOv8 [检测](https://docs.ultralytics.com/tasks/detect),[分割](https://docs.ultralytics.com/tasks/segment)和[姿态](https://docs.ultralytics.com/tasks/pose)模型可以在这里找到,以及在[ImageNet](https://docs.ultralytics.com/datasets/classify/imagenet)数据集上预训练的YOLOv8 [分类](https://docs.ultralytics.com/tasks/classify)模型。所有的检测,分割和姿态模型都支持[追踪](https://docs.ultralytics.com/modes/track)模式。
111
+
112
+ <img width="1024" src="https://raw.githubusercontent.com/ultralytics/assets/main/im/banner-tasks.png">
113
+
114
+ 所有[模型](https://github.com/ultralytics/ultralytics/tree/main/ultralytics/cfg/models)在首次使用时会自动从最新的Ultralytics [发布版本](https://github.com/ultralytics/assets/releases)下载。
115
+
116
+ <details open><summary>检测</summary>
117
+
118
+ 查看 [检测文档](https://docs.ultralytics.com/tasks/detect/) 以获取使用这些模型的示例。
119
+
120
+ | 模型 | 尺寸<br><sup>(像素) | mAP<sup>val<br>50-95 | 速度<br><sup>CPU ONNX<br>(ms) | 速度<br><sup>A100 TensorRT<br>(ms) | 参数<br><sup>(M) | FLOPs<br><sup>(B) |
121
+ | ------------------------------------------------------------------------------------ | --------------- | -------------------- | --------------------------- | -------------------------------- | -------------- | ----------------- |
122
+ | [YOLOv8n](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8n.pt) | 640 | 37.3 | 80.4 | 0.99 | 3.2 | 8.7 |
123
+ | [YOLOv8s](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8s.pt) | 640 | 44.9 | 128.4 | 1.20 | 11.2 | 28.6 |
124
+ | [YOLOv8m](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8m.pt) | 640 | 50.2 | 234.7 | 1.83 | 25.9 | 78.9 |
125
+ | [YOLOv8l](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8l.pt) | 640 | 52.9 | 375.2 | 2.39 | 43.7 | 165.2 |
126
+ | [YOLOv8x](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8x.pt) | 640 | 53.9 | 479.1 | 3.53 | 68.2 | 257.8 |
127
+
128
+ - **mAP<sup>val</sup>** 值是基于单模型单尺度在 [COCO val2017](http://cocodataset.org) 数据集上的结果。
129
+ <br>通过 `yolo val detect data=coco.yaml device=0` 复现
130
+ - **速度** 是使用 [Amazon EC2 P4d](https://aws.amazon.com/ec2/instance-types/p4/) 实例对 COCO val 图像进行平均计算的。
131
+ <br>通过 `yolo val detect data=coco128.yaml batch=1 device=0|cpu` 复现
132
+
133
+ </details>
134
+
135
+ <details><summary>分割</summary>
136
+
137
+ 查看 [分割文档](https://docs.ultralytics.com/tasks/segment/) 以获取使用这些模型的示例。
138
+
139
+ | 模型 | 尺寸<br><sup>(像素) | mAP<sup>box<br>50-95 | mAP<sup>mask<br>50-95 | 速度<br><sup>CPU ONNX<br>(ms) | 速度<br><sup>A100 TensorRT<br>(ms) | 参数<br><sup>(M) | FLOPs<br><sup>(B) |
140
+ | -------------------------------------------------------------------------------------------- | --------------- | -------------------- | --------------------- | --------------------------- | -------------------------------- | -------------- | ----------------- |
141
+ | [YOLOv8n-seg](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8n-seg.pt) | 640 | 36.7 | 30.5 | 96.1 | 1.21 | 3.4 | 12.6 |
142
+ | [YOLOv8s-seg](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8s-seg.pt) | 640 | 44.6 | 36.8 | 155.7 | 1.47 | 11.8 | 42.6 |
143
+ | [YOLOv8m-seg](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8m-seg.pt) | 640 | 49.9 | 40.8 | 317.0 | 2.18 | 27.3 | 110.2 |
144
+ | [YOLOv8l-seg](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8l-seg.pt) | 640 | 52.3 | 42.6 | 572.4 | 2.79 | 46.0 | 220.5 |
145
+ | [YOLOv8x-seg](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8x-seg.pt) | 640 | 53.4 | 43.4 | 712.1 | 4.02 | 71.8 | 344.1 |
146
+
147
+ - **mAP<sup>val</sup>** 值是基于单模型单尺度在 [COCO val2017](http://cocodataset.org) 数据集上的结果。
148
+ <br>通过 `yolo val segment data=coco.yaml device=0` 复现
149
+ - **速度** 是使用 [Amazon EC2 P4d](https://aws.amazon.com/ec2/instance-types/p4/) 实例对 COCO val 图像进行平均计算的。
150
+ <br>通过 `yolo val segment data=coco128-seg.yaml batch=1 device=0|cpu` 复现
151
+
152
+ </details>
153
+
154
+ <details><summary>分类</summary>
155
+
156
+ 查看 [分类文档](https://docs.ultralytics.com/tasks/classify/) 以获取使用这些模型的示例。
157
+
158
+ | 模型 | 尺寸<br><sup>(像素) | acc<br><sup>top1 | acc<br><sup>top5 | 速度<br><sup>CPU ONNX<br>(ms) | 速度<br><sup>A100 TensorRT<br>(ms) | 参数<br><sup>(M) | FLOPs<br><sup>(B) at 640 |
159
+ | -------------------------------------------------------------------------------------------- | --------------- | ---------------- | ---------------- | --------------------------- | -------------------------------- | -------------- | ------------------------ |
160
+ | [YOLOv8n-cls](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8n-cls.pt) | 224 | 66.6 | 87.0 | 12.9 | 0.31 | 2.7 | 4.3 |
161
+ | [YOLOv8s-cls](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8s-cls.pt) | 224 | 72.3 | 91.1 | 23.4 | 0.35 | 6.4 | 13.5 |
162
+ | [YOLOv8m-cls](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8m-cls.pt) | 224 | 76.4 | 93.2 | 85.4 | 0.62 | 17.0 | 42.7 |
163
+ | [YOLOv8l-cls](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8l-cls.pt) | 224 | 78.0 | 94.1 | 163.0 | 0.87 | 37.5 | 99.7 |
164
+ | [YOLOv8x-cls](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8x-cls.pt) | 224 | 78.4 | 94.3 | 232.0 | 1.01 | 57.4 | 154.8 |
165
+
166
+ - **acc** 值是模型在 [ImageNet](https://www.image-net.org/) 数据集验证集上的准确率。
167
+ <br>通过 `yolo val classify data=path/to/ImageNet device=0` 复现
168
+ - **速度** 是使用 [Amazon EC2 P4d](https://aws.amazon.com/ec2/instance-types/p4/) 实例对 ImageNet val 图像进行平均计算的。
169
+ <br>通过 `yolo val classify data=path/to/ImageNet batch=1 device=0|cpu` 复现
170
+
171
+ </details>
172
+
173
+ <details><summary>姿态</summary>
174
+
175
+ 查看 [姿态文档](https://docs.ultralytics.com/tasks/) 以获取使用这些模型的示例。
176
+
177
+ | 模型 | 尺寸<br><sup>(像素) | mAP<sup>pose<br>50-95 | mAP<sup>pose<br>50 | 速度<br><sup>CPU ONNX<br>(ms) | 速度<br><sup>A100 TensorRT<br>(ms) | 参数<br><sup>(M) | FLOPs<br><sup>(B) |
178
+ | ---------------------------------------------------------------------------------------------------- | --------------- | --------------------- | ------------------ | --------------------------- | -------------------------------- | -------------- | ----------------- |
179
+ | [YOLOv8n-pose](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8n-pose.pt) | 640 | 50.4 | 80.1 | 131.8 | 1.18 | 3.3 | 9.2 |
180
+ | [YOLOv8s-pose](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8s-pose.pt) | 640 | 60.0 | 86.2 | 233.2 | 1.42 | 11.6 | 30.2 |
181
+ | [YOLOv8m-pose](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8m-pose.pt) | 640 | 65.0 | 88.8 | 456.3 | 2.00 | 26.4 | 81.0 |
182
+ | [YOLOv8l-pose](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8l-pose.pt) | 640 | 67.6 | 90.0 | 784.5 | 2.59 | 44.4 | 168.6 |
183
+ | [YOLOv8x-pose](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8x-pose.pt) | 640 | 69.2 | 90.2 | 1607.1 | 3.73 | 69.4 | 263.2 |
184
+ | [YOLOv8x-pose-p6](https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8x-pose-p6.pt) | 1280 | 71.6 | 91.2 | 4088.7 | 10.04 | 99.1 | 1066.4 |
185
+
186
+ - **mAP<sup>val</sup>** 值是基于单模型单尺度在 [COCO Keypoints val2017](http://cocodataset.org) 数据集上的结果。
187
+ <br>通过 `yolo val pose data=coco-pose.yaml device=0` 复现
188
+ - **速度** 是使用 [Amazon EC2 P4d](https://aws.amazon.com/ec2/instance-types/p4/) 实例对 COCO val 图像进行平均计算的。
189
+ <br>通过 `yolo val pose data=coco8-pose.yaml batch=1 device=0|cpu` 复现
190
+
191
+ </details>
192
+
193
+ ## <div align="center">集成</div>
194
+
195
+ 我们与领先的AI平台的关键整合扩展了Ultralytics产品的功能,增强了数据集标签化、训练、可视化和模型管理等任务。探索Ultralytics如何与[Roboflow](https://roboflow.com/?ref=ultralytics)、ClearML、[Comet](https://bit.ly/yolov8-readme-comet)、Neural Magic以及[OpenVINO](https://docs.ultralytics.com/integrations/openvino)合作,优化您的AI工作流程。
196
+
197
+ <br>
198
+ <a href="https://bit.ly/ultralytics_hub" target="_blank">
199
+ <img width="100%" src="https://github.com/ultralytics/assets/raw/main/yolov8/banner-integrations.png"></a>
200
+ <br>
201
+ <br>
202
+
203
+ <div align="center">
204
+ <a href="https://roboflow.com/?ref=ultralytics">
205
+ <img src="https://github.com/ultralytics/assets/raw/main/partners/logo-roboflow.png" width="10%" /></a>
206
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="15%" height="0" alt="" />
207
+ <a href="https://cutt.ly/yolov5-readme-clearml">
208
+ <img src="https://github.com/ultralytics/assets/raw/main/partners/logo-clearml.png" width="10%" /></a>
209
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="15%" height="0" alt="" />
210
+ <a href="https://bit.ly/yolov8-readme-comet">
211
+ <img src="https://github.com/ultralytics/assets/raw/main/partners/logo-comet.png" width="10%" /></a>
212
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="15%" height="0" alt="" />
213
+ <a href="https://bit.ly/yolov5-neuralmagic">
214
+ <img src="https://github.com/ultralytics/assets/raw/main/partners/logo-neuralmagic.png" width="10%" /></a>
215
+ </div>
216
+
217
+ | Roboflow | ClearML ⭐ NEW | Comet ⭐ NEW | Neural Magic ⭐ NEW |
218
+ | :--------------------------------------------------------------------------------: | :----------------------------------------------------------------------------: | :----------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------: |
219
+ | 使用 [Roboflow](https://roboflow.com/?ref=ultralytics) 将您的自定义数据集直接标记并导出至 YOLOv8 进行训练 | 使用 [ClearML](https://cutt.ly/yolov5-readme-clearml)(开源!)自���跟踪、可视化,甚至远程训练 YOLOv8 | 免费且永久,[Comet](https://bit.ly/yolov8-readme-comet) 让您保存 YOLOv8 模型、恢复训练,并以交互式方式查看和调试预测 | 使用 [Neural Magic DeepSparse](https://bit.ly/yolov5-neuralmagic) 使 YOLOv8 推理速度提高多达 6 倍 |
220
+
221
+ ## <div align="center">Ultralytics HUB</div>
222
+
223
+ 体验 [Ultralytics HUB](https://bit.ly/ultralytics_hub) ⭐ 带来的无缝 AI,这是一个一体化解决方案,用于数据可视化、YOLOv5 和即将推出的 YOLOv8 🚀 模型训练和部署,无需任何编码。通过我们先进的平台和用户友好的 [Ultralytics 应用程序](https://ultralytics.com/app_install),轻松将图像转化为可操作的见解,并实现您的 AI 愿景。现在就开始您的**免费**之旅!
224
+
225
+ <a href="https://bit.ly/ultralytics_hub" target="_blank">
226
+ <img width="100%" src="https://github.com/ultralytics/assets/raw/main/im/ultralytics-hub.png"></a>
227
+
228
+ ## <div align="center">贡献</div>
229
+
230
+ 我们喜欢您的参与!没有社区的帮助,YOLOv5 和 YOLOv8 将无法实现。请参阅我们的[贡献指南](https://docs.ultralytics.com/help/contributing)以开始使用,并填写我们的[调查问卷](https://ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey)向我们提供您的使用体验反馈。感谢所有贡献者的支持!🙏
231
+
232
+ <!-- SVG image from https://opencollective.com/ultralytics/contributors.svg?width=990 -->
233
+
234
+ <a href="https://github.com/ultralytics/yolov5/graphs/contributors">
235
+ <img width="100%" src="https://github.com/ultralytics/assets/raw/main/im/image-contributors.png"></a>
236
+
237
+ ## <div align="center">许可证</div>
238
+
239
+ Ultralytics 提供两种许可证选项以适应各种使用场景:
240
+
241
+ - **AGPL-3.0 许可证**:这个[OSI 批准](https://opensource.org/licenses/)的开源许可证非常适合学生和爱好者,可以推动开放的协作和知识分享。请查看[LICENSE](https://github.com/ultralytics/ultralytics/blob/main/LICENSE) 文件以了解更多细节。
242
+ - **企业许可证**:专为商业用途设计,该许可证允许将 Ultralytics 的软件和 AI 模型无缝集成到商业产品和服务中,从而绕过 AGPL-3.0 的开源要求。如果您的场景涉及将我们的解决方案嵌入到商业产品中,请通过 [Ultralytics Licensing](https://ultralytics.com/license)与我们联系。
243
+
244
+ ## <div align="center">联系方式</div>
245
+
246
+ 对于 Ultralytics 的错误报告和功能请求,请访问 [GitHub Issues](https://github.com/ultralytics/ultralytics/issues),并加入我们的 [Discord](https://ultralytics.com/discord) 社区进行问题和讨论!
247
+
248
+ <br>
249
+ <div align="center">
250
+ <a href="https://github.com/ultralytics" style="text-decoration:none;">
251
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-github.png" width="3%" alt="" /></a>
252
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="" />
253
+ <a href="https://www.linkedin.com/company/ultralytics/" style="text-decoration:none;">
254
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-linkedin.png" width="3%" alt="" /></a>
255
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="" />
256
+ <a href="https://twitter.com/ultralytics" style="text-decoration:none;">
257
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-twitter.png" width="3%" alt="" /></a>
258
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="" />
259
+ <a href="https://youtube.com/ultralytics" style="text-decoration:none;">
260
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-youtube.png" width="3%" alt="" /></a>
261
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="" />
262
+ <a href="https://www.tiktok.com/@ultralytics" style="text-decoration:none;">
263
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-tiktok.png" width="3%" alt="" /></a>
264
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="" />
265
+ <a href="https://www.instagram.com/ultralytics/" style="text-decoration:none;">
266
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-instagram.png" width="3%" alt="" /></a>
267
+ <a href="https://ultralytics.com/discord" style="text-decoration:none;">
268
+ <img src="https://github.com/ultralytics/assets/blob/main/social/logo-social-discord.png" width="3%" alt="" /></a>
269
+ </div>
yolov8-to/docker/Dockerfile ADDED
@@ -0,0 +1,83 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Ultralytics YOLO 🚀, AGPL-3.0 license
2
+ # Builds ultralytics/ultralytics:latest image on DockerHub https://hub.docker.com/r/ultralytics/ultralytics
3
+ # Image is CUDA-optimized for YOLOv8 single/multi-GPU training and inference
4
+
5
+ # Start FROM PyTorch image https://hub.docker.com/r/pytorch/pytorch or nvcr.io/nvidia/pytorch:23.03-py3
6
+ FROM pytorch/pytorch:2.0.1-cuda11.7-cudnn8-runtime
7
+ RUN pip install --no-cache nvidia-tensorrt --index-url https://pypi.ngc.nvidia.com
8
+
9
+ # Downloads to user config dir
10
+ ADD https://ultralytics.com/assets/Arial.ttf https://ultralytics.com/assets/Arial.Unicode.ttf /root/.config/Ultralytics/
11
+
12
+ # Install linux packages
13
+ # g++ required to build 'tflite_support' and 'lap' packages, libusb-1.0-0 required for 'tflite_support' package
14
+ RUN apt update \
15
+ && apt install --no-install-recommends -y gcc git zip curl htop libgl1-mesa-glx libglib2.0-0 libpython3-dev gnupg g++ libusb-1.0-0
16
+ # RUN alias python=python3
17
+
18
+ # Security updates
19
+ # https://security.snyk.io/vuln/SNYK-UBUNTU1804-OPENSSL-3314796
20
+ RUN apt upgrade --no-install-recommends -y openssl tar
21
+
22
+ # Create working directory
23
+ WORKDIR /usr/src/ultralytics
24
+
25
+ # Copy contents
26
+ # COPY . /usr/src/app (issues as not a .git directory)
27
+ RUN git clone https://github.com/ultralytics/ultralytics /usr/src/ultralytics
28
+ ADD https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8n.pt /usr/src/ultralytics/
29
+
30
+ # Install pip packages
31
+ RUN python3 -m pip install --upgrade pip wheel
32
+ RUN pip install --no-cache -e ".[export]" thop albumentations comet pycocotools pytest-cov
33
+
34
+ # Run exports to AutoInstall packages
35
+ RUN yolo export model=tmp/yolov8n.pt format=edgetpu imgsz=32
36
+ RUN yolo export model=tmp/yolov8n.pt format=ncnn imgsz=32
37
+ # Requires <= Python 3.10, bug with paddlepaddle==2.5.0
38
+ RUN pip install --no-cache paddlepaddle==2.4.2 x2paddle
39
+ # Fix error: `np.bool` was a deprecated alias for the builtin `bool`
40
+ RUN pip install --no-cache numpy==1.23.5
41
+ # Remove exported models
42
+ RUN rm -rf tmp
43
+
44
+ # Set environment variables
45
+ ENV OMP_NUM_THREADS=1
46
+ # Avoid DDP error "MKL_THREADING_LAYER=INTEL is incompatible with libgomp.so.1 library" https://github.com/pytorch/pytorch/issues/37377
47
+ ENV MKL_THREADING_LAYER=GNU
48
+
49
+
50
+ # Usage Examples -------------------------------------------------------------------------------------------------------
51
+
52
+ # Build and Push
53
+ # t=ultralytics/ultralytics:latest && sudo docker build -f docker/Dockerfile -t $t . && sudo docker push $t
54
+
55
+ # Pull and Run with access to all GPUs
56
+ # t=ultralytics/ultralytics:latest && sudo docker pull $t && sudo docker run -it --ipc=host --gpus all $t
57
+
58
+ # Pull and Run with access to GPUs 2 and 3 (inside container CUDA devices will appear as 0 and 1)
59
+ # t=ultralytics/ultralytics:latest && sudo docker pull $t && sudo docker run -it --ipc=host --gpus '"device=2,3"' $t
60
+
61
+ # Pull and Run with local directory access
62
+ # t=ultralytics/ultralytics:latest && sudo docker pull $t && sudo docker run -it --ipc=host --gpus all -v "$(pwd)"/datasets:/usr/src/datasets $t
63
+
64
+ # Kill all
65
+ # sudo docker kill $(sudo docker ps -q)
66
+
67
+ # Kill all image-based
68
+ # sudo docker kill $(sudo docker ps -qa --filter ancestor=ultralytics/ultralytics:latest)
69
+
70
+ # DockerHub tag update
71
+ # t=ultralytics/ultralytics:latest tnew=ultralytics/ultralytics:v6.2 && sudo docker pull $t && sudo docker tag $t $tnew && sudo docker push $tnew
72
+
73
+ # Clean up
74
+ # sudo docker system prune -a --volumes
75
+
76
+ # Update Ubuntu drivers
77
+ # https://www.maketecheasier.com/install-nvidia-drivers-ubuntu/
78
+
79
+ # DDP test
80
+ # python -m torch.distributed.run --nproc_per_node 2 --master_port 1 train.py --epochs 3
81
+
82
+ # GCP VM from Image
83
+ # docker.io/ultralytics/ultralytics:latest
yolov8-to/docker/Dockerfile-arm64 ADDED
@@ -0,0 +1,39 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Ultralytics YOLO 🚀, AGPL-3.0 license
2
+ # Builds ultralytics/ultralytics:latest-arm64 image on DockerHub https://hub.docker.com/r/ultralytics/ultralytics
3
+ # Image is aarch64-compatible for Apple M1 and other ARM architectures i.e. Jetson Nano and Raspberry Pi
4
+
5
+ # Start FROM Ubuntu image https://hub.docker.com/_/ubuntu
6
+ FROM arm64v8/ubuntu:22.10
7
+
8
+ # Downloads to user config dir
9
+ ADD https://ultralytics.com/assets/Arial.ttf https://ultralytics.com/assets/Arial.Unicode.ttf /root/.config/Ultralytics/
10
+
11
+ # Install linux packages
12
+ # g++ required to build 'tflite_support' and 'lap' packages, libusb-1.0-0 required for 'tflite_support' package
13
+ RUN apt update \
14
+ && apt install --no-install-recommends -y python3-pip git zip curl htop gcc libgl1-mesa-glx libglib2.0-0 libpython3-dev gnupg g++ libusb-1.0-0
15
+ # RUN alias python=python3
16
+
17
+ # Create working directory
18
+ WORKDIR /usr/src/ultralytics
19
+
20
+ # Copy contents
21
+ # COPY . /usr/src/app (issues as not a .git directory)
22
+ RUN git clone https://github.com/ultralytics/ultralytics /usr/src/ultralytics
23
+ ADD https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8n.pt /usr/src/ultralytics/
24
+
25
+ # Install pip packages
26
+ RUN python3 -m pip install --upgrade pip wheel
27
+ RUN pip install --no-cache -e . thop
28
+
29
+
30
+ # Usage Examples -------------------------------------------------------------------------------------------------------
31
+
32
+ # Build and Push
33
+ # t=ultralytics/ultralytics:latest-arm64 && sudo docker build --platform linux/arm64 -f docker/Dockerfile-arm64 -t $t . && sudo docker push $t
34
+
35
+ # Run
36
+ # t=ultralytics/ultralytics:latest-arm64 && sudo docker run -it --ipc=host $t
37
+
38
+ # Pull and Run with local volume mounted
39
+ # t=ultralytics/ultralytics:latest-arm64 && sudo docker pull $t && sudo docker run -it --ipc=host -v "$(pwd)"/datasets:/usr/src/datasets $t
yolov8-to/docker/Dockerfile-cpu ADDED
@@ -0,0 +1,49 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Ultralytics YOLO 🚀, AGPL-3.0 license
2
+ # Builds ultralytics/ultralytics:latest-cpu image on DockerHub https://hub.docker.com/r/ultralytics/ultralytics
3
+ # Image is CPU-optimized for ONNX, OpenVINO and PyTorch YOLOv8 deployments
4
+
5
+ # Start FROM Ubuntu image https://hub.docker.com/_/ubuntu
6
+ FROM ubuntu:lunar-20230615
7
+
8
+ # Downloads to user config dir
9
+ ADD https://ultralytics.com/assets/Arial.ttf https://ultralytics.com/assets/Arial.Unicode.ttf /root/.config/Ultralytics/
10
+
11
+ # Install linux packages
12
+ # g++ required to build 'tflite_support' and 'lap' packages, libusb-1.0-0 required for 'tflite_support' package
13
+ RUN apt update \
14
+ && apt install --no-install-recommends -y python3-pip git zip curl htop libgl1-mesa-glx libglib2.0-0 libpython3-dev gnupg g++ libusb-1.0-0
15
+ # RUN alias python=python3
16
+
17
+ # Create working directory
18
+ WORKDIR /usr/src/ultralytics
19
+
20
+ # Copy contents
21
+ # COPY . /usr/src/app (issues as not a .git directory)
22
+ RUN git clone https://github.com/ultralytics/ultralytics /usr/src/ultralytics
23
+ ADD https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8n.pt /usr/src/ultralytics/
24
+
25
+ # Remove python3.11/EXTERNALLY-MANAGED or use 'pip install --break-system-packages' avoid 'externally-managed-environment' Ubuntu nightly error
26
+ RUN rm -rf /usr/lib/python3.11/EXTERNALLY-MANAGED
27
+
28
+ # Install pip packages
29
+ RUN python3 -m pip install --upgrade pip wheel
30
+ RUN pip install --no-cache -e ".[export]" thop --extra-index-url https://download.pytorch.org/whl/cpu
31
+
32
+ # Run exports to AutoInstall packages
33
+ RUN yolo export model=tmp/yolov8n.pt format=edgetpu imgsz=32
34
+ RUN yolo export model=tmp/yolov8n.pt format=ncnn imgsz=32
35
+ # Requires <= Python 3.10, bug with paddlepaddle==2.5.0
36
+ # RUN pip install --no-cache paddlepaddle==2.4.2 x2paddle
37
+ # Remove exported models
38
+ RUN rm -rf tmp
39
+
40
+ # Usage Examples -------------------------------------------------------------------------------------------------------
41
+
42
+ # Build and Push
43
+ # t=ultralytics/ultralytics:latest-cpu && sudo docker build -f docker/Dockerfile-cpu -t $t . && sudo docker push $t
44
+
45
+ # Run
46
+ # t=ultralytics/ultralytics:latest-cpu && sudo docker run -it --ipc=host $t
47
+
48
+ # Pull and Run with local volume mounted
49
+ # t=ultralytics/ultralytics:latest-cpu && sudo docker pull $t && sudo docker run -it --ipc=host -v "$(pwd)"/datasets:/usr/src/datasets $t
yolov8-to/docker/Dockerfile-jetson ADDED
@@ -0,0 +1,46 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Ultralytics YOLO 🚀, AGPL-3.0 license
2
+ # Builds ultralytics/ultralytics:jetson image on DockerHub https://hub.docker.com/r/ultralytics/ultralytics
3
+ # Supports JetPack for YOLOv8 on Jetson Nano, TX1/TX2, Xavier NX, AGX Xavier, AGX Orin, and Orin NX
4
+
5
+ # Start FROM https://catalog.ngc.nvidia.com/orgs/nvidia/containers/l4t-pytorch
6
+ FROM nvcr.io/nvidia/l4t-pytorch:r35.2.1-pth2.0-py3
7
+
8
+ # Downloads to user config dir
9
+ ADD https://ultralytics.com/assets/Arial.ttf https://ultralytics.com/assets/Arial.Unicode.ttf /root/.config/Ultralytics/
10
+
11
+ # Install linux packages
12
+ # g++ required to build 'tflite_support' and 'lap' packages, libusb-1.0-0 required for 'tflite_support' package
13
+ RUN apt update \
14
+ && apt install --no-install-recommends -y gcc git zip curl htop libgl1-mesa-glx libglib2.0-0 libpython3-dev gnupg g++ libusb-1.0-0
15
+ # RUN alias python=python3
16
+
17
+ # Create working directory
18
+ WORKDIR /usr/src/ultralytics
19
+
20
+ # Copy contents
21
+ # COPY . /usr/src/app (issues as not a .git directory)
22
+ RUN git clone https://github.com/ultralytics/ultralytics /usr/src/ultralytics
23
+ ADD https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8n.pt /usr/src/ultralytics/
24
+
25
+ # Remove opencv-python from requirements.txt as it conflicts with opencv-python installed in base image
26
+ RUN grep -v '^opencv-python' requirements.txt > tmp.txt && mv tmp.txt requirements.txt
27
+
28
+ # Install pip packages manually for TensorRT compatibility https://github.com/NVIDIA/TensorRT/issues/2567
29
+ RUN python3 -m pip install --upgrade pip wheel
30
+ RUN pip install --no-cache tqdm matplotlib pyyaml psutil pandas onnx thop "numpy==1.23"
31
+ RUN pip install --no-cache -e .
32
+
33
+ # Set environment variables
34
+ ENV OMP_NUM_THREADS=1
35
+
36
+
37
+ # Usage Examples -------------------------------------------------------------------------------------------------------
38
+
39
+ # Build and Push
40
+ # t=ultralytics/ultralytics:latest-jetson && sudo docker build --platform linux/arm64 -f docker/Dockerfile-jetson -t $t . && sudo docker push $t
41
+
42
+ # Run
43
+ # t=ultralytics/ultralytics:latest-jetson && sudo docker run -it --ipc=host $t
44
+
45
+ # Pull and Run with NVIDIA runtime
46
+ # t=ultralytics/ultralytics:latest-jetson && sudo docker pull $t && sudo docker run -it --ipc=host --runtime=nvidia $t
yolov8-to/docker/Dockerfile-python ADDED
@@ -0,0 +1,49 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Ultralytics YOLO 🚀, AGPL-3.0 license
2
+ # Builds ultralytics/ultralytics:latest-cpu image on DockerHub https://hub.docker.com/r/ultralytics/ultralytics
3
+ # Image is CPU-optimized for ONNX, OpenVINO and PyTorch YOLOv8 deployments
4
+
5
+ # Use the official Python 3.10 slim-bookworm as base image
6
+ FROM python:3.10-slim-bookworm
7
+
8
+ # Downloads to user config dir
9
+ ADD https://ultralytics.com/assets/Arial.ttf https://ultralytics.com/assets/Arial.Unicode.ttf /root/.config/Ultralytics/
10
+
11
+ # Install linux packages
12
+ # g++ required to build 'tflite_support' and 'lap' packages, libusb-1.0-0 required for 'tflite_support' package
13
+ RUN apt update \
14
+ && apt install --no-install-recommends -y python3-pip git zip curl htop libgl1-mesa-glx libglib2.0-0 libpython3-dev gnupg g++ libusb-1.0-0
15
+ # RUN alias python=python3
16
+
17
+ # Create working directory
18
+ WORKDIR /usr/src/ultralytics
19
+
20
+ # Copy contents
21
+ # COPY . /usr/src/app (issues as not a .git directory)
22
+ RUN git clone https://github.com/ultralytics/ultralytics /usr/src/ultralytics
23
+ ADD https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8n.pt /usr/src/ultralytics/
24
+
25
+ # Remove python3.11/EXTERNALLY-MANAGED or use 'pip install --break-system-packages' avoid 'externally-managed-environment' Ubuntu nightly error
26
+ # RUN rm -rf /usr/lib/python3.11/EXTERNALLY-MANAGED
27
+
28
+ # Install pip packages
29
+ RUN python3 -m pip install --upgrade pip wheel
30
+ RUN pip install --no-cache -e ".[export]" thop --extra-index-url https://download.pytorch.org/whl/cpu
31
+
32
+ # Run exports to AutoInstall packages
33
+ RUN yolo export model=tmp/yolov8n.pt format=edgetpu imgsz=32
34
+ RUN yolo export model=tmp/yolov8n.pt format=ncnn imgsz=32
35
+ # Requires <= Python 3.10, bug with paddlepaddle==2.5.0
36
+ RUN pip install --no-cache paddlepaddle==2.4.2 x2paddle
37
+ # Remove exported models
38
+ RUN rm -rf tmp
39
+
40
+ # Usage Examples -------------------------------------------------------------------------------------------------------
41
+
42
+ # Build and Push
43
+ # t=ultralytics/ultralytics:latest-python && sudo docker build -f docker/Dockerfile-python -t $t . && sudo docker push $t
44
+
45
+ # Run
46
+ # t=ultralytics/ultralytics:latest-python && sudo docker run -it --ipc=host $t
47
+
48
+ # Pull and Run with local volume mounted
49
+ # t=ultralytics/ultralytics:latest-python && sudo docker pull $t && sudo docker run -it --ipc=host -v "$(pwd)"/datasets:/usr/src/datasets $t
yolov8-to/docker/Dockerfile-runner ADDED
@@ -0,0 +1,37 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Ultralytics YOLO 🚀, AGPL-3.0 license
2
+ # Builds GitHub actions CI runner image for deployment to DockerHub https://hub.docker.com/r/ultralytics/ultralytics
3
+ # Image is CUDA-optimized for YOLOv8 single/multi-GPU training and inference tests
4
+
5
+ # Start FROM Ultralytics GPU image
6
+ FROM ultralytics/ultralytics:latest
7
+
8
+ # Set the working directory
9
+ WORKDIR /actions-runner
10
+
11
+ # Download and unpack the latest runner
12
+ RUN curl -o actions-runner-linux-x64-2.308.0.tar.gz -L https://github.com/actions/runner/releases/download/v2.308.0/actions-runner-linux-x64-2.308.0.tar.gz && \
13
+ tar xzf actions-runner-linux-x64-2.308.0.tar.gz && \
14
+ rm actions-runner-linux-x64-2.308.0.tar.gz
15
+
16
+ # Install runner dependencies
17
+ ENV RUNNER_ALLOW_RUNASROOT=1
18
+ ENV DEBIAN_FRONTEND=noninteractive
19
+ RUN ./bin/installdependencies.sh && \
20
+ apt-get -y install libicu-dev
21
+
22
+ # Inline ENTRYPOINT command to configure and start runner with default TOKEN and NAME
23
+ ENTRYPOINT sh -c './config.sh --url https://github.com/ultralytics/ultralytics \
24
+ --token ${GITHUB_RUNNER_TOKEN:-TOKEN} \
25
+ --name ${GITHUB_RUNNER_NAME:-NAME} \
26
+ --labels gpu-latest \
27
+ --replace && \
28
+ ./run.sh'
29
+
30
+
31
+ # Usage Examples -------------------------------------------------------------------------------------------------------
32
+
33
+ # Build and Push
34
+ # t=ultralytics/ultralytics:latest-runner && sudo docker build -f docker/Dockerfile-runner -t $t . && sudo docker push $t
35
+
36
+ # Pull and Run in detached mode with access to GPUs 0 and 1
37
+ # t=ultralytics/ultralytics:latest-runner && sudo docker run -d -e GITHUB_RUNNER_TOKEN=TOKEN -e GITHUB_RUNNER_NAME=NAME --ipc=host --gpus '"device=0,1"' $t
yolov8-to/docs/CNAME ADDED
@@ -0,0 +1 @@
 
 
1
+ docs.ultralytics.com
yolov8-to/docs/README.md ADDED
@@ -0,0 +1,90 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ description: Learn how to install Ultralytics in developer mode, build and serve it locally for testing, and deploy your documentation site on platforms like GitHub Pages, GitLab Pages, and Amazon S3.
3
+ keywords: Ultralytics, documentation, mkdocs, installation, developer mode, building, deployment, local server, GitHub Pages, GitLab Pages, Amazon S3
4
+ ---
5
+
6
+ # Ultralytics Docs
7
+
8
+ Ultralytics Docs are deployed to [https://docs.ultralytics.com](https://docs.ultralytics.com).
9
+
10
+ ### Install Ultralytics package
11
+
12
+ To install the ultralytics package in developer mode, you will need to have Git and Python 3 installed on your system.
13
+ Then, follow these steps:
14
+
15
+ 1. Clone the ultralytics repository to your local machine using Git:
16
+
17
+ ```bash
18
+ git clone https://github.com/ultralytics/ultralytics.git
19
+ ```
20
+
21
+ 2. Navigate to the root directory of the repository:
22
+
23
+ ```bash
24
+ cd ultralytics
25
+ ```
26
+
27
+ 3. Install the package in developer mode using pip:
28
+
29
+ ```bash
30
+ pip install -e ".[dev]"
31
+ ```
32
+
33
+ This will install the ultralytics package and its dependencies in developer mode, allowing you to make changes to the
34
+ package code and have them reflected immediately in your Python environment.
35
+
36
+ Note that you may need to use the pip3 command instead of pip if you have multiple versions of Python installed on your
37
+ system.
38
+
39
+ ### Building and Serving Locally
40
+
41
+ The `mkdocs serve` command is used to build and serve a local version of the MkDocs documentation site. It is typically
42
+ used during the development and testing phase of a documentation project.
43
+
44
+ ```bash
45
+ mkdocs serve
46
+ ```
47
+
48
+ Here is a breakdown of what this command does:
49
+
50
+ - `mkdocs`: This is the command-line interface (CLI) for the MkDocs static site generator. It is used to build and serve
51
+ MkDocs sites.
52
+ - `serve`: This is a subcommand of the `mkdocs` CLI that tells it to build and serve the documentation site locally.
53
+ - `-a`: This flag specifies the hostname and port number to bind the server to. The default value is `localhost:8000`.
54
+ - `-t`: This flag specifies the theme to use for the documentation site. The default value is `mkdocs`.
55
+ - `-s`: This flag tells the `serve` command to serve the site in silent mode, which means it will not display any log
56
+ messages or progress updates.
57
+ When you run the `mkdocs serve` command, it will build the documentation site using the files in the `docs/` directory
58
+ and serve it at the specified hostname and port number. You can then view the site by going to the URL in your web
59
+ browser.
60
+
61
+ While the site is being served, you can make changes to the documentation files and see them reflected in the live site
62
+ immediately. This is useful for testing and debugging your documentation before deploying it to a live server.
63
+
64
+ To stop the serve command and terminate the local server, you can use the `CTRL+C` keyboard shortcut.
65
+
66
+ ### Deploying Your Documentation Site
67
+
68
+ To deploy your MkDocs documentation site, you will need to choose a hosting provider and a deployment method. Some
69
+ popular options include GitHub Pages, GitLab Pages, and Amazon S3.
70
+
71
+ Before you can deploy your site, you will need to configure your `mkdocs.yml` file to specify the remote host and any
72
+ other necessary deployment settings.
73
+
74
+ Once you have configured your `mkdocs.yml` file, you can use the `mkdocs deploy` command to build and deploy your site.
75
+ This command will build the documentation site using the files in the `docs/` directory and the specified configuration
76
+ file and theme, and then deploy the site to the specified remote host.
77
+
78
+ For example, to deploy your site to GitHub Pages using the gh-deploy plugin, you can use the following command:
79
+
80
+ ```bash
81
+ mkdocs gh-deploy
82
+ ```
83
+
84
+ If you are using GitHub Pages, you can set a custom domain for your documentation site by going to the "Settings" page
85
+ for your repository and updating the "Custom domain" field in the "GitHub Pages" section.
86
+
87
+ ![196814117-fc16e711-d2be-4722-9536-b7c6d78fd167](https://user-images.githubusercontent.com/26833433/210150206-9e86dcd7-10af-43e4-9eb2-9518b3799eac.png)
88
+
89
+ For more information on deploying your MkDocs documentation site, see
90
+ the [MkDocs documentation](https://www.mkdocs.org/user-guide/deploying-your-docs/).
yolov8-to/docs/SECURITY.md ADDED
@@ -0,0 +1,26 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ description: Discover how Ultralytics ensures the safety of user data and systems. Check out the measures we have implemented, including Snyk and GitHub CodeQL Scanning.
3
+ keywords: Ultralytics, Security Policy, data security, open-source projects, Snyk scanning, CodeQL scanning, vulnerability detection, threat prevention
4
+ ---
5
+
6
+ # Security Policy
7
+
8
+ At [Ultralytics](https://ultralytics.com), the security of our users' data and systems is of utmost importance. To ensure the safety and security of our [open-source projects](https://github.com/ultralytics), we have implemented several measures to detect and prevent security vulnerabilities.
9
+
10
+ ## Snyk Scanning
11
+
12
+ We use [Snyk](https://snyk.io/advisor/python/ultralytics) to regularly scan all Ultralytics repositories for vulnerabilities and security issues. Our goal is to identify and remediate any potential threats as soon as possible, to minimize any risks to our users.
13
+
14
+ [![ultralytics](https://snyk.io/advisor/python/ultralytics/badge.svg)](https://snyk.io/advisor/python/ultralytics)
15
+
16
+ ## GitHub CodeQL Scanning
17
+
18
+ In addition to our Snyk scans, we also use GitHub's [CodeQL](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql) scans to proactively identify and address security vulnerabilities across all Ultralytics repositories.
19
+
20
+ [![CodeQL](https://github.com/ultralytics/ultralytics/actions/workflows/codeql.yaml/badge.svg)](https://github.com/ultralytics/ultralytics/actions/workflows/codeql.yaml)
21
+
22
+ ## Reporting Security Issues
23
+
24
+ If you suspect or discover a security vulnerability in any of our repositories, please let us know immediately. You can reach out to us directly via our [contact form](https://ultralytics.com/contact) or via [security@ultralytics.com](mailto:security@ultralytics.com). Our security team will investigate and respond as soon as possible.
25
+
26
+ We appreciate your help in keeping all Ultralytics open-source projects secure and safe for everyone.
yolov8-to/docs/assets/favicon.ico ADDED
yolov8-to/docs/build_reference.py ADDED
@@ -0,0 +1,126 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Ultralytics YOLO 🚀, AGPL-3.0 license
2
+ """
3
+ Helper file to build Ultralytics Docs reference section. Recursively walks through ultralytics dir and builds an MkDocs
4
+ reference section of *.md files composed of classes and functions, and also creates a nav menu for use in mkdocs.yaml.
5
+
6
+ Note: Must be run from repository root directory. Do not run from docs directory.
7
+ """
8
+
9
+ import os
10
+ import re
11
+ from collections import defaultdict
12
+ from pathlib import Path
13
+
14
+ from ultralytics.utils import ROOT
15
+
16
+ NEW_YAML_DIR = ROOT.parent
17
+ CODE_DIR = ROOT
18
+ REFERENCE_DIR = ROOT.parent / 'docs/reference'
19
+
20
+
21
+ def extract_classes_and_functions(filepath):
22
+ with open(filepath, 'r') as file:
23
+ content = file.read()
24
+
25
+ class_pattern = r'(?:^|\n)class\s(\w+)(?:\(|:)'
26
+ func_pattern = r'(?:^|\n)def\s(\w+)\('
27
+
28
+ classes = re.findall(class_pattern, content)
29
+ functions = re.findall(func_pattern, content)
30
+
31
+ return classes, functions
32
+
33
+
34
+ def create_markdown(py_filepath, module_path, classes, functions):
35
+ md_filepath = py_filepath.with_suffix('.md')
36
+
37
+ # Read existing content and keep header content between first two ---
38
+ header_content = ''
39
+ if md_filepath.exists():
40
+ with open(md_filepath, 'r') as file:
41
+ existing_content = file.read()
42
+ header_parts = existing_content.split('---')
43
+ for part in header_parts:
44
+ if 'description:' in part or 'comments:' in part:
45
+ header_content += f'---{part}---\n\n'
46
+
47
+ module_name = module_path.replace('.__init__', '')
48
+ module_path = module_path.replace(".", "/")
49
+ url = f'https://github.com/ultralytics/ultralytics/blob/main/{module_path}.py'
50
+ title_content = (f'# Reference for `{module_path}.py`\n\n'
51
+ f'!!! note\n\n'
52
+ f' Full source code for this file is available at [{url}]({url}). Help us fix any issues you see by submitting a [Pull Request](https://docs.ultralytics.com/help/contributing/) 🛠️. Thank you 🙏!\n\n')
53
+ md_content = [f'---\n## ::: {module_name}.{class_name}\n<br><br>\n' for class_name in classes]
54
+ md_content.extend(f'---\n## ::: {module_name}.{func_name}\n<br><br>\n' for func_name in functions)
55
+ md_content = header_content + title_content + '\n'.join(md_content)
56
+ if not md_content.endswith('\n'):
57
+ md_content += '\n'
58
+
59
+ os.makedirs(os.path.dirname(md_filepath), exist_ok=True)
60
+ with open(md_filepath, 'w') as file:
61
+ file.write(md_content)
62
+
63
+ return md_filepath.relative_to(NEW_YAML_DIR)
64
+
65
+
66
+ def nested_dict():
67
+ return defaultdict(nested_dict)
68
+
69
+
70
+ def sort_nested_dict(d):
71
+ return {
72
+ key: sort_nested_dict(value) if isinstance(value, dict) else value
73
+ for key, value in sorted(d.items())
74
+ }
75
+
76
+
77
+ def create_nav_menu_yaml(nav_items):
78
+ nav_tree = nested_dict()
79
+
80
+ for item_str in nav_items:
81
+ item = Path(item_str)
82
+ parts = item.parts
83
+ current_level = nav_tree['reference']
84
+ for part in parts[2:-1]: # skip the first two parts (docs and reference) and the last part (filename)
85
+ current_level = current_level[part]
86
+
87
+ md_file_name = parts[-1].replace('.md', '')
88
+ current_level[md_file_name] = item
89
+
90
+ nav_tree_sorted = sort_nested_dict(nav_tree)
91
+
92
+ def _dict_to_yaml(d, level=0):
93
+ yaml_str = ''
94
+ indent = ' ' * level
95
+ for k, v in d.items():
96
+ if isinstance(v, dict):
97
+ yaml_str += f'{indent}- {k}:\n{_dict_to_yaml(v, level + 1)}'
98
+ else:
99
+ yaml_str += f"{indent}- {k}: {str(v).replace('docs/', '')}\n"
100
+ return yaml_str
101
+
102
+ with open(NEW_YAML_DIR / 'nav_menu_updated.yml', 'w') as file:
103
+ yaml_str = _dict_to_yaml(nav_tree_sorted)
104
+ file.write(yaml_str)
105
+
106
+
107
+ def main():
108
+ nav_items = []
109
+ for root, _, files in os.walk(CODE_DIR):
110
+ for file in files:
111
+ if file.endswith('.py'):
112
+ py_filepath = Path(root) / file
113
+ classes, functions = extract_classes_and_functions(py_filepath)
114
+
115
+ if classes or functions:
116
+ py_filepath_rel = py_filepath.relative_to(CODE_DIR)
117
+ md_filepath = REFERENCE_DIR / py_filepath_rel
118
+ module_path = f"ultralytics.{py_filepath_rel.with_suffix('').as_posix().replace('/', '.')}"
119
+ md_rel_filepath = create_markdown(md_filepath, module_path, classes, functions)
120
+ nav_items.append(str(md_rel_filepath))
121
+
122
+ create_nav_menu_yaml(nav_items)
123
+
124
+
125
+ if __name__ == '__main__':
126
+ main()
yolov8-to/docs/datasets/classify/caltech101.md ADDED
@@ -0,0 +1,81 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: Learn about the Caltech-101 dataset, its structure and uses in machine learning. Includes instructions to train a YOLO model using this dataset.
4
+ keywords: Caltech-101, dataset, YOLO training, machine learning, object recognition, ultralytics
5
+ ---
6
+
7
+ # Caltech-101 Dataset
8
+
9
+ The [Caltech-101](https://data.caltech.edu/records/mzrjq-6wc02) dataset is a widely used dataset for object recognition tasks, containing around 9,000 images from 101 object categories. The categories were chosen to reflect a variety of real-world objects, and the images themselves were carefully selected and annotated to provide a challenging benchmark for object recognition algorithms.
10
+
11
+ ## Key Features
12
+
13
+ - The Caltech-101 dataset comprises around 9,000 color images divided into 101 categories.
14
+ - The categories encompass a wide variety of objects, including animals, vehicles, household items, and people.
15
+ - The number of images per category varies, with about 40 to 800 images in each category.
16
+ - Images are of variable sizes, with most images being medium resolution.
17
+ - Caltech-101 is widely used for training and testing in the field of machine learning, particularly for object recognition tasks.
18
+
19
+ ## Dataset Structure
20
+
21
+ Unlike many other datasets, the Caltech-101 dataset is not formally split into training and testing sets. Users typically create their own splits based on their specific needs. However, a common practice is to use a random subset of images for training (e.g., 30 images per category) and the remaining images for testing.
22
+
23
+ ## Applications
24
+
25
+ The Caltech-101 dataset is extensively used for training and evaluating deep learning models in object recognition tasks, such as Convolutional Neural Networks (CNNs), Support Vector Machines (SVMs), and various other machine learning algorithms. Its wide variety of categories and high-quality images make it an excellent dataset for research and development in the field of machine learning and computer vision.
26
+
27
+ ## Usage
28
+
29
+ To train a YOLO model on the Caltech-101 dataset for 100 epochs, you can use the following code snippets. For a comprehensive list of available arguments, refer to the model [Training](../../modes/train.md) page.
30
+
31
+ !!! example "Train Example"
32
+
33
+ === "Python"
34
+
35
+ ```python
36
+ from ultralytics import YOLO
37
+
38
+ # Load a model
39
+ model = YOLO('yolov8n-cls.pt') # load a pretrained model (recommended for training)
40
+
41
+ # Train the model
42
+ results = model.train(data='caltech101', epochs=100, imgsz=416)
43
+ ```
44
+
45
+ === "CLI"
46
+
47
+ ```bash
48
+ # Start training from a pretrained *.pt model
49
+ yolo detect train data=caltech101 model=yolov8n-cls.pt epochs=100 imgsz=416
50
+ ```
51
+
52
+ ## Sample Images and Annotations
53
+
54
+ The Caltech-101 dataset contains high-quality color images of various objects, providing a well-structured dataset for object recognition tasks. Here are some examples of images from the dataset:
55
+
56
+ ![Dataset sample image](https://user-images.githubusercontent.com/26833433/239366386-44171121-b745-4206-9b59-a3be41e16089.png)
57
+
58
+ The example showcases the variety and complexity of the objects in the Caltech-101 dataset, emphasizing the significance of a diverse dataset for training robust object recognition models.
59
+
60
+ ## Citations and Acknowledgments
61
+
62
+ If you use the Caltech-101 dataset in your research or development work, please cite the following paper:
63
+
64
+ !!! note ""
65
+
66
+ === "BibTeX"
67
+
68
+ ```bibtex
69
+ @article{fei2007learning,
70
+ title={Learning generative visual models from few training examples: An incremental Bayesian approach tested on 101 object categories},
71
+ author={Fei-Fei, Li and Fergus, Rob and Perona, Pietro},
72
+ journal={Computer vision and Image understanding},
73
+ volume={106},
74
+ number={1},
75
+ pages={59--70},
76
+ year={2007},
77
+ publisher={Elsevier}
78
+ }
79
+ ```
80
+
81
+ We would like to acknowledge Li Fei-Fei, Rob Fergus, and Pietro Perona for creating and maintaining the Caltech-101 dataset as a valuable resource for the machine learning and computer vision research community. For more information about the Caltech-101 dataset and its creators, visit the [Caltech-101 dataset website](https://data.caltech.edu/records/mzrjq-6wc02).
yolov8-to/docs/datasets/classify/caltech256.md ADDED
@@ -0,0 +1,78 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: Explore the Caltech-256 dataset, a diverse collection of images used for object recognition tasks in machine learning. Learn to train a YOLO model on the dataset.
4
+ keywords: Ultralytics, YOLO, Caltech-256, dataset, object recognition, machine learning, computer vision, deep learning
5
+ ---
6
+
7
+ # Caltech-256 Dataset
8
+
9
+ The [Caltech-256](https://data.caltech.edu/records/nyy15-4j048) dataset is an extensive collection of images used for object classification tasks. It contains around 30,000 images divided into 257 categories (256 object categories and 1 background category). The images are carefully curated and annotated to provide a challenging and diverse benchmark for object recognition algorithms.
10
+
11
+ ## Key Features
12
+
13
+ - The Caltech-256 dataset comprises around 30,000 color images divided into 257 categories.
14
+ - Each category contains a minimum of 80 images.
15
+ - The categories encompass a wide variety of real-world objects, including animals, vehicles, household items, and people.
16
+ - Images are of variable sizes and resolutions.
17
+ - Caltech-256 is widely used for training and testing in the field of machine learning, particularly for object recognition tasks.
18
+
19
+ ## Dataset Structure
20
+
21
+ Like Caltech-101, the Caltech-256 dataset does not have a formal split between training and testing sets. Users typically create their own splits according to their specific needs. A common practice is to use a random subset of images for training and the remaining images for testing.
22
+
23
+ ## Applications
24
+
25
+ The Caltech-256 dataset is extensively used for training and evaluating deep learning models in object recognition tasks, such as Convolutional Neural Networks (CNNs), Support Vector Machines (SVMs), and various other machine learning algorithms. Its diverse set of categories and high-quality images make it an invaluable dataset for research and development in the field of machine learning and computer vision.
26
+
27
+ ## Usage
28
+
29
+ To train a YOLO model on the Caltech-256 dataset for 100 epochs, you can use the following code snippets. For a comprehensive list of available arguments, refer to the model [Training](../../modes/train.md) page.
30
+
31
+ !!! example "Train Example"
32
+
33
+ === "Python"
34
+
35
+ ```python
36
+ from ultralytics import YOLO
37
+
38
+ # Load a model
39
+ model = YOLO('yolov8n-cls.pt') # load a pretrained model (recommended for training)
40
+
41
+ # Train the model
42
+ results = model.train(data='caltech256', epochs=100, imgsz=416)
43
+ ```
44
+
45
+ === "CLI"
46
+
47
+ ```bash
48
+ # Start training from a pretrained *.pt model
49
+ yolo detect train data=caltech256 model=yolov8n-cls.pt epochs=100 imgsz=416
50
+ ```
51
+
52
+ ## Sample Images and Annotations
53
+
54
+ The Caltech-256 dataset contains high-quality color images of various objects, providing a comprehensive dataset for object recognition tasks. Here are some examples of images from the dataset ([credit](https://ml4a.github.io/demos/tsne_viewer.html)):
55
+
56
+ ![Dataset sample image](https://user-images.githubusercontent.com/26833433/239365061-1e5f7857-b1e8-44ca-b3d7-d0befbcd33f9.jpg)
57
+
58
+ The example showcases the diversity and complexity of the objects in the Caltech-256 dataset, emphasizing the importance of a varied dataset for training robust object recognition models.
59
+
60
+ ## Citations and Acknowledgments
61
+
62
+ If you use the Caltech-256 dataset in your research or development work, please cite the following paper:
63
+
64
+ !!! note ""
65
+
66
+ === "BibTeX"
67
+
68
+ ```bibtex
69
+ @article{griffin2007caltech,
70
+ title={Caltech-256 object category dataset},
71
+ author={Griffin, Gregory and Holub, Alex and Perona, Pietro},
72
+ year={2007}
73
+ }
74
+ ```
75
+
76
+ We would like to acknowledge Gregory Griffin, Alex Holub, and Pietro Perona for creating and maintaining the Caltech-256 dataset as a valuable resource for the machine learning and computer vision research community. For more information about the
77
+
78
+ Caltech-256 dataset and its creators, visit the [Caltech-256 dataset website](https://data.caltech.edu/records/nyy15-4j048).
yolov8-to/docs/datasets/classify/cifar10.md ADDED
@@ -0,0 +1,80 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: Explore the CIFAR-10 dataset, widely used for training in machine learning and computer vision, and learn how to use it with Ultralytics YOLO.
4
+ keywords: CIFAR-10, dataset, machine learning, image classification, computer vision, YOLO, Ultralytics, training, testing, deep learning, Convolutional Neural Networks, Support Vector Machines
5
+ ---
6
+
7
+ # CIFAR-10 Dataset
8
+
9
+ The [CIFAR-10](https://www.cs.toronto.edu/~kriz/cifar.html) (Canadian Institute For Advanced Research) dataset is a collection of images used widely for machine learning and computer vision algorithms. It was developed by researchers at the CIFAR institute and consists of 60,000 32x32 color images in 10 different classes.
10
+
11
+ ## Key Features
12
+
13
+ - The CIFAR-10 dataset consists of 60,000 images, divided into 10 classes.
14
+ - Each class contains 6,000 images, split into 5,000 for training and 1,000 for testing.
15
+ - The images are colored and of size 32x32 pixels.
16
+ - The 10 different classes represent airplanes, cars, birds, cats, deer, dogs, frogs, horses, ships, and trucks.
17
+ - CIFAR-10 is commonly used for training and testing in the field of machine learning and computer vision.
18
+
19
+ ## Dataset Structure
20
+
21
+ The CIFAR-10 dataset is split into two subsets:
22
+
23
+ 1. **Training Set**: This subset contains 50,000 images used for training machine learning models.
24
+ 2. **Testing Set**: This subset consists of 10,000 images used for testing and benchmarking the trained models.
25
+
26
+ ## Applications
27
+
28
+ The CIFAR-10 dataset is widely used for training and evaluating deep learning models in image classification tasks, such as Convolutional Neural Networks (CNNs), Support Vector Machines (SVMs), and various other machine learning algorithms. The diversity of the dataset in terms of classes and the presence of color images make it a well-rounded dataset for research and development in the field of machine learning and computer vision.
29
+
30
+ ## Usage
31
+
32
+ To train a YOLO model on the CIFAR-10 dataset for 100 epochs with an image size of 32x32, you can use the following code snippets. For a comprehensive list of available arguments, refer to the model [Training](../../modes/train.md) page.
33
+
34
+ !!! example "Train Example"
35
+
36
+ === "Python"
37
+
38
+ ```python
39
+ from ultralytics import YOLO
40
+
41
+ # Load a model
42
+ model = YOLO('yolov8n-cls.pt') # load a pretrained model (recommended for training)
43
+
44
+ # Train the model
45
+ results = model.train(data='cifar10', epochs=100, imgsz=32)
46
+ ```
47
+
48
+ === "CLI"
49
+
50
+ ```bash
51
+ # Start training from a pretrained *.pt model
52
+ yolo detect train data=cifar10 model=yolov8n-cls.pt epochs=100 imgsz=32
53
+ ```
54
+
55
+ ## Sample Images and Annotations
56
+
57
+ The CIFAR-10 dataset contains color images of various objects, providing a well-structured dataset for image classification tasks. Here are some examples of images from the dataset:
58
+
59
+ ![Dataset sample image](https://miro.medium.com/max/1100/1*SZnidBt7CQ4Xqcag6rd8Ew.png)
60
+
61
+ The example showcases the variety and complexity of the objects in the CIFAR-10 dataset, highlighting the importance of a diverse dataset for training robust image classification models.
62
+
63
+ ## Citations and Acknowledgments
64
+
65
+ If you use the CIFAR-10 dataset in your research or development work, please cite the following paper:
66
+
67
+ !!! note ""
68
+
69
+ === "BibTeX"
70
+
71
+ ```bibtex
72
+ @TECHREPORT{Krizhevsky09learningmultiple,
73
+ author={Alex Krizhevsky},
74
+ title={Learning multiple layers of features from tiny images},
75
+ institution={},
76
+ year={2009}
77
+ }
78
+ ```
79
+
80
+ We would like to acknowledge Alex Krizhevsky for creating and maintaining the CIFAR-10 dataset as a valuable resource for the machine learning and computer vision research community. For more information about the CIFAR-10 dataset and its creator, visit the [CIFAR-10 dataset website](https://www.cs.toronto.edu/~kriz/cifar.html).
yolov8-to/docs/datasets/classify/cifar100.md ADDED
@@ -0,0 +1,80 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: Discover how to leverage the CIFAR-100 dataset for machine learning and computer vision tasks with YOLO. Gain insights on its structure, use, and utilization for model training.
4
+ keywords: Ultralytics, YOLO, CIFAR-100 dataset, image classification, machine learning, computer vision, YOLO model training
5
+ ---
6
+
7
+ # CIFAR-100 Dataset
8
+
9
+ The [CIFAR-100](https://www.cs.toronto.edu/~kriz/cifar.html) (Canadian Institute For Advanced Research) dataset is a significant extension of the CIFAR-10 dataset, composed of 60,000 32x32 color images in 100 different classes. It was developed by researchers at the CIFAR institute, offering a more challenging dataset for more complex machine learning and computer vision tasks.
10
+
11
+ ## Key Features
12
+
13
+ - The CIFAR-100 dataset consists of 60,000 images, divided into 100 classes.
14
+ - Each class contains 600 images, split into 500 for training and 100 for testing.
15
+ - The images are colored and of size 32x32 pixels.
16
+ - The 100 different classes are grouped into 20 coarse categories for higher level classification.
17
+ - CIFAR-100 is commonly used for training and testing in the field of machine learning and computer vision.
18
+
19
+ ## Dataset Structure
20
+
21
+ The CIFAR-100 dataset is split into two subsets:
22
+
23
+ 1. **Training Set**: This subset contains 50,000 images used for training machine learning models.
24
+ 2. **Testing Set**: This subset consists of 10,000 images used for testing and benchmarking the trained models.
25
+
26
+ ## Applications
27
+
28
+ The CIFAR-100 dataset is extensively used for training and evaluating deep learning models in image classification tasks, such as Convolutional Neural Networks (CNNs), Support Vector Machines (SVMs), and various other machine learning algorithms. The diversity of the dataset in terms of classes and the presence of color images make it a more challenging and comprehensive dataset for research and development in the field of machine learning and computer vision.
29
+
30
+ ## Usage
31
+
32
+ To train a YOLO model on the CIFAR-100 dataset for 100 epochs with an image size of 32x32, you can use the following code snippets. For a comprehensive list of available arguments, refer to the model [Training](../../modes/train.md) page.
33
+
34
+ !!! example "Train Example"
35
+
36
+ === "Python"
37
+
38
+ ```python
39
+ from ultralytics import YOLO
40
+
41
+ # Load a model
42
+ model = YOLO('yolov8n-cls.pt') # load a pretrained model (recommended for training)
43
+
44
+ # Train the model
45
+ results = model.train(data='cifar100', epochs=100, imgsz=32)
46
+ ```
47
+
48
+ === "CLI"
49
+
50
+ ```bash
51
+ # Start training from a pretrained *.pt model
52
+ yolo detect train data=cifar100 model=yolov8n-cls.pt epochs=100 imgsz=32
53
+ ```
54
+
55
+ ## Sample Images and Annotations
56
+
57
+ The CIFAR-100 dataset contains color images of various objects, providing a well-structured dataset for image classification tasks. Here are some examples of images from the dataset:
58
+
59
+ ![Dataset sample image](https://user-images.githubusercontent.com/26833433/239363319-62ebf02f-7469-4178-b066-ccac3cd334db.jpg)
60
+
61
+ The example showcases the variety and complexity of the objects in the CIFAR-100 dataset, highlighting the importance of a diverse dataset for training robust image classification models.
62
+
63
+ ## Citations and Acknowledgments
64
+
65
+ If you use the CIFAR-100 dataset in your research or development work, please cite the following paper:
66
+
67
+ !!! note ""
68
+
69
+ === "BibTeX"
70
+
71
+ ```bibtex
72
+ @TECHREPORT{Krizhevsky09learningmultiple,
73
+ author={Alex Krizhevsky},
74
+ title={Learning multiple layers of features from tiny images},
75
+ institution={},
76
+ year={2009}
77
+ }
78
+ ```
79
+
80
+ We would like to acknowledge Alex Krizhevsky for creating and maintaining the CIFAR-100 dataset as a valuable resource for the machine learning and computer vision research community. For more information about the CIFAR-100 dataset and its creator, visit the [CIFAR-100 dataset website](https://www.cs.toronto.edu/~kriz/cifar.html).
yolov8-to/docs/datasets/classify/fashion-mnist.md ADDED
@@ -0,0 +1,79 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: Learn how to use the Fashion-MNIST dataset for image classification with the Ultralytics YOLO model. Covers dataset structure, labels, applications, and usage.
4
+ keywords: Ultralytics, YOLO, Fashion-MNIST, dataset, image classification, machine learning, deep learning, neural networks, training, testing
5
+ ---
6
+
7
+ # Fashion-MNIST Dataset
8
+
9
+ The [Fashion-MNIST](https://github.com/zalandoresearch/fashion-mnist) dataset is a database of Zalando's article images—consisting of a training set of 60,000 examples and a test set of 10,000 examples. Each example is a 28x28 grayscale image, associated with a label from 10 classes. Fashion-MNIST is intended to serve as a direct drop-in replacement for the original MNIST dataset for benchmarking machine learning algorithms.
10
+
11
+ ## Key Features
12
+
13
+ - Fashion-MNIST contains 60,000 training images and 10,000 testing images of Zalando's article images.
14
+ - The dataset comprises grayscale images of size 28x28 pixels.
15
+ - Each pixel has a single pixel-value associated with it, indicating the lightness or darkness of that pixel, with higher numbers meaning darker. This pixel-value is an integer between 0 and 255.
16
+ - Fashion-MNIST is widely used for training and testing in the field of machine learning, especially for image classification tasks.
17
+
18
+ ## Dataset Structure
19
+
20
+ The Fashion-MNIST dataset is split into two subsets:
21
+
22
+ 1. **Training Set**: This subset contains 60,000 images used for training machine learning models.
23
+ 2. **Testing Set**: This subset consists of 10,000 images used for testing and benchmarking the trained models.
24
+
25
+ ## Labels
26
+
27
+ Each training and test example is assigned to one of the following labels:
28
+
29
+ 0. T-shirt/top
30
+ 1. Trouser
31
+ 2. Pullover
32
+ 3. Dress
33
+ 4. Coat
34
+ 5. Sandal
35
+ 6. Shirt
36
+ 7. Sneaker
37
+ 8. Bag
38
+ 9. Ankle boot
39
+
40
+ ## Applications
41
+
42
+ The Fashion-MNIST dataset is widely used for training and evaluating deep learning models in image classification tasks, such as Convolutional Neural Networks (CNNs), Support Vector Machines (SVMs), and various other machine learning algorithms. The dataset's simple and well-structured format makes it an essential resource for researchers and practitioners in the field of machine learning and computer vision.
43
+
44
+ ## Usage
45
+
46
+ To train a CNN model on the Fashion-MNIST dataset for 100 epochs with an image size of 28x28, you can use the following code snippets. For a comprehensive list of available arguments, refer to the model [Training](../../modes/train.md) page.
47
+
48
+ !!! example "Train Example"
49
+
50
+ === "Python"
51
+
52
+ ```python
53
+ from ultralytics import YOLO
54
+
55
+ # Load a model
56
+ model = YOLO('yolov8n-cls.pt') # load a pretrained model (recommended for training)
57
+
58
+ # Train the model
59
+ results = model.train(data='fashion-mnist', epochs=100, imgsz=28)
60
+ ```
61
+
62
+ === "CLI"
63
+
64
+ ```bash
65
+ # Start training from a pretrained *.pt model
66
+ yolo detect train data=fashion-mnist model=yolov8n-cls.pt epochs=100 imgsz=28
67
+ ```
68
+
69
+ ## Sample Images and Annotations
70
+
71
+ The Fashion-MNIST dataset contains grayscale images of Zalando's article images, providing a well-structured dataset for image classification tasks. Here are some examples of images from the dataset:
72
+
73
+ ![Dataset sample image](https://user-images.githubusercontent.com/26833433/239359139-ce0a434e-9056-43e0-a306-3214f193dcce.png)
74
+
75
+ The example showcases the variety and complexity of the images in the Fashion-MNIST dataset, highlighting the importance of a diverse dataset for training robust image classification models.
76
+
77
+ ## Acknowledgments
78
+
79
+ If you use the Fashion-MNIST dataset in your research or development work, please acknowledge the dataset by linking to the [GitHub repository](https://github.com/zalandoresearch/fashion-mnist). This dataset was made available by Zalando Research.
yolov8-to/docs/datasets/classify/imagenet.md ADDED
@@ -0,0 +1,83 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: Understand how to use ImageNet, an extensive annotated image dataset for object recognition research, with Ultralytics YOLO models. Learn about its structure, usage, and significance in computer vision.
4
+ keywords: Ultralytics, YOLO, ImageNet, dataset, object recognition, deep learning, computer vision, machine learning, dataset training, model training, image classification, object detection
5
+ ---
6
+
7
+ # ImageNet Dataset
8
+
9
+ [ImageNet](https://www.image-net.org/) is a large-scale database of annotated images designed for use in visual object recognition research. It contains over 14 million images, with each image annotated using WordNet synsets, making it one of the most extensive resources available for training deep learning models in computer vision tasks.
10
+
11
+ ## Key Features
12
+
13
+ - ImageNet contains over 14 million high-resolution images spanning thousands of object categories.
14
+ - The dataset is organized according to the WordNet hierarchy, with each synset representing a category.
15
+ - ImageNet is widely used for training and benchmarking in the field of computer vision, particularly for image classification and object detection tasks.
16
+ - The annual ImageNet Large Scale Visual Recognition Challenge (ILSVRC) has been instrumental in advancing computer vision research.
17
+
18
+ ## Dataset Structure
19
+
20
+ The ImageNet dataset is organized using the WordNet hierarchy. Each node in the hierarchy represents a category, and each category is described by a synset (a collection of synonymous terms). The images in ImageNet are annotated with one or more synsets, providing a rich resource for training models to recognize various objects and their relationships.
21
+
22
+ ## ImageNet Large Scale Visual Recognition Challenge (ILSVRC)
23
+
24
+ The annual [ImageNet Large Scale Visual Recognition Challenge (ILSVRC)](http://image-net.org/challenges/LSVRC/) has been an important event in the field of computer vision. It has provided a platform for researchers and developers to evaluate their algorithms and models on a large-scale dataset with standardized evaluation metrics. The ILSVRC has led to significant advancements in the development of deep learning models for image classification, object detection, and other computer vision tasks.
25
+
26
+ ## Applications
27
+
28
+ The ImageNet dataset is widely used for training and evaluating deep learning models in various computer vision tasks, such as image classification, object detection, and object localization. Some popular deep learning architectures, such as AlexNet, VGG, and ResNet, were developed and benchmarked using the ImageNet dataset.
29
+
30
+ ## Usage
31
+
32
+ To train a deep learning model on the ImageNet dataset for 100 epochs with an image size of 224x224, you can use the following code snippets. For a comprehensive list of available arguments, refer to the model [Training](../../modes/train.md) page.
33
+
34
+ !!! example "Train Example"
35
+
36
+ === "Python"
37
+
38
+ ```python
39
+ from ultralytics import YOLO
40
+
41
+ # Load a model
42
+ model = YOLO('yolov8n-cls.pt') # load a pretrained model (recommended for training)
43
+
44
+ # Train the model
45
+ results = model.train(data='imagenet', epochs=100, imgsz=224)
46
+ ```
47
+
48
+ === "CLI"
49
+
50
+ ```bash
51
+ # Start training from a pretrained *.pt model
52
+ yolo train data=imagenet model=yolov8n-cls.pt epochs=100 imgsz=224
53
+ ```
54
+
55
+ ## Sample Images and Annotations
56
+
57
+ The ImageNet dataset contains high-resolution images spanning thousands of object categories, providing a diverse and extensive dataset for training and evaluating computer vision models. Here are some examples of images from the dataset:
58
+
59
+ ![Dataset sample images](https://user-images.githubusercontent.com/26833433/239280348-3d8f30c7-6f05-4dda-9cfe-d62ad9faecc9.png)
60
+
61
+ The example showcases the variety and complexity of the images in the ImageNet dataset, highlighting the importance of a diverse dataset for training robust computer vision models.
62
+
63
+ ## Citations and Acknowledgments
64
+
65
+ If you use the ImageNet dataset in your research or development work, please cite the following paper:
66
+
67
+ !!! note ""
68
+
69
+ === "BibTeX"
70
+
71
+ ```bibtex
72
+ @article{ILSVRC15,
73
+ author = {Olga Russakovsky and Jia Deng and Hao Su and Jonathan Krause and Sanjeev Satheesh and Sean Ma and Zhiheng Huang and Andrej Karpathy and Aditya Khosla and Michael Bernstein and Alexander C. Berg and Li Fei-Fei},
74
+ title={ImageNet Large Scale Visual Recognition Challenge},
75
+ year={2015},
76
+ journal={International Journal of Computer Vision (IJCV)},
77
+ volume={115},
78
+ number={3},
79
+ pages={211-252}
80
+ }
81
+ ```
82
+
83
+ We would like to acknowledge the ImageNet team, led by Olga Russakovsky, Jia Deng, and Li Fei-Fei, for creating and maintaining the ImageNet dataset as a valuable resource for the machine learning and computer vision research community. For more information about the ImageNet dataset and its creators, visit the [ImageNet website](https://www.image-net.org/).
yolov8-to/docs/datasets/classify/imagenet10.md ADDED
@@ -0,0 +1,78 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: Explore the compact ImageNet10 Dataset developed by Ultralytics. Ideal for fast testing of computer vision training pipelines and CV model sanity checks.
4
+ keywords: Ultralytics, YOLO, ImageNet10 Dataset, Image detection, Deep Learning, ImageNet, AI model testing, Computer vision, Machine learning
5
+ ---
6
+
7
+ # ImageNet10 Dataset
8
+
9
+ The [ImageNet10](https://github.com/ultralytics/yolov5/releases/download/v1.0/imagenet10.zip) dataset is a small-scale subset of the [ImageNet](https://www.image-net.org/) database, developed by [Ultralytics](https://ultralytics.com) and designed for CI tests, sanity checks, and fast testing of training pipelines. This dataset is composed of the first image in the training set and the first image from the validation set of the first 10 classes in ImageNet. Although significantly smaller, it retains the structure and diversity of the original ImageNet dataset.
10
+
11
+ ## Key Features
12
+
13
+ - ImageNet10 is a compact version of ImageNet, with 20 images representing the first 10 classes of the original dataset.
14
+ - The dataset is organized according to the WordNet hierarchy, mirroring the structure of the full ImageNet dataset.
15
+ - It is ideally suited for CI tests, sanity checks, and rapid testing of training pipelines in computer vision tasks.
16
+ - Although not designed for model benchmarking, it can provide a quick indication of a model's basic functionality and correctness.
17
+
18
+ ## Dataset Structure
19
+
20
+ The ImageNet10 dataset, like the original ImageNet, is organized using the WordNet hierarchy. Each of the 10 classes in ImageNet10 is described by a synset (a collection of synonymous terms). The images in ImageNet10 are annotated with one or more synsets, providing a compact resource for testing models to recognize various objects and their relationships.
21
+
22
+ ## Applications
23
+
24
+ The ImageNet10 dataset is useful for quickly testing and debugging computer vision models and pipelines. Its small size allows for rapid iteration, making it ideal for continuous integration tests and sanity checks. It can also be used for fast preliminary testing of new models or changes to existing models before moving on to full-scale testing with the complete ImageNet dataset.
25
+
26
+ ## Usage
27
+
28
+ To test a deep learning model on the ImageNet10 dataset with an image size of 224x224, you can use the following code snippets. For a comprehensive list of available arguments, refer to the model [Training](../../modes/train.md) page.
29
+
30
+ !!! example "Test Example"
31
+
32
+ === "Python"
33
+
34
+ ```python
35
+ from ultralytics import YOLO
36
+
37
+ # Load a model
38
+ model = YOLO('yolov8n-cls.pt') # load a pretrained model (recommended for training)
39
+
40
+ # Train the model
41
+ results = model.train(data='imagenet10', epochs=5, imgsz=224)
42
+ ```
43
+
44
+ === "CLI"
45
+
46
+ ```bash
47
+ # Start training from a pretrained *.pt model
48
+ yolo train data=imagenet10 model=yolov8n-cls.pt epochs=5 imgsz=224
49
+ ```
50
+
51
+ ## Sample Images and Annotations
52
+
53
+ The ImageNet10 dataset contains a subset of images from the original ImageNet dataset. These images are chosen to represent the first 10 classes in the dataset, providing a diverse yet compact dataset for quick testing and evaluation.
54
+
55
+ ![Dataset sample images](https://user-images.githubusercontent.com/26833433/239689723-16f9b4a7-becc-4deb-b875-d3e5c28eb03b.png)
56
+ The example showcases the variety and complexity of the images in the ImageNet10 dataset, highlighting its usefulness for sanity checks and quick testing of computer vision models.
57
+
58
+ ## Citations and Acknowledgments
59
+
60
+ If you use the ImageNet10 dataset in your research or development work, please cite the original ImageNet paper:
61
+
62
+ !!! note ""
63
+
64
+ === "BibTeX"
65
+
66
+ ```bibtex
67
+ @article{ILSVRC15,
68
+ author = {Olga Russakovsky and Jia Deng and Hao Su and Jonathan Krause and Sanjeev Satheesh and Sean Ma and Zhiheng Huang and Andrej Karpathy and Aditya Khosla and Michael Bernstein and Alexander C. Berg and Li Fei-Fei},
69
+ title={ImageNet Large Scale Visual Recognition Challenge},
70
+ year={2015},
71
+ journal={International Journal of Computer Vision (IJCV)},
72
+ volume={115},
73
+ number={3},
74
+ pages={211-252}
75
+ }
76
+ ```
77
+
78
+ We would like to acknowledge the ImageNet team, led by Olga Russakovsky, Jia Deng, and Li Fei-Fei, for creating and maintaining the ImageNet dataset. The ImageNet10 dataset, while a compact subset, is a valuable resource for quick testing and debugging in the machine learning and computer vision research community. For more information about the ImageNet dataset and its creators, visit the [ImageNet website](https://www.image-net.org/).
yolov8-to/docs/datasets/classify/imagenette.md ADDED
@@ -0,0 +1,113 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: Learn about the ImageNette dataset and its usage in deep learning model training. Find code snippets for model training and explore ImageNette datatypes.
4
+ keywords: ImageNette dataset, Ultralytics, YOLO, Image classification, Machine Learning, Deep learning, Training code snippets, CNN, ImageNette160, ImageNette320
5
+ ---
6
+
7
+ # ImageNette Dataset
8
+
9
+ The [ImageNette](https://github.com/fastai/imagenette) dataset is a subset of the larger [Imagenet](http://www.image-net.org/) dataset, but it only includes 10 easily distinguishable classes. It was created to provide a quicker, easier-to-use version of Imagenet for software development and education.
10
+
11
+ ## Key Features
12
+
13
+ - ImageNette contains images from 10 different classes such as tench, English springer, cassette player, chain saw, church, French horn, garbage truck, gas pump, golf ball, parachute.
14
+ - The dataset comprises colored images of varying dimensions.
15
+ - ImageNette is widely used for training and testing in the field of machine learning, especially for image classification tasks.
16
+
17
+ ## Dataset Structure
18
+
19
+ The ImageNette dataset is split into two subsets:
20
+
21
+ 1. **Training Set**: This subset contains several thousands of images used for training machine learning models. The exact number varies per class.
22
+ 2. **Validation Set**: This subset consists of several hundreds of images used for validating and benchmarking the trained models. Again, the exact number varies per class.
23
+
24
+ ## Applications
25
+
26
+ The ImageNette dataset is widely used for training and evaluating deep learning models in image classification tasks, such as Convolutional Neural Networks (CNNs), and various other machine learning algorithms. The dataset's straightforward format and well-chosen classes make it a handy resource for both beginner and experienced practitioners in the field of machine learning and computer vision.
27
+
28
+ ## Usage
29
+
30
+ To train a model on the ImageNette dataset for 100 epochs with a standard image size of 224x224, you can use the following code snippets. For a comprehensive list of available arguments, refer to the model [Training](../../modes/train.md) page.
31
+
32
+ !!! example "Train Example"
33
+
34
+ === "Python"
35
+
36
+ ```python
37
+ from ultralytics import YOLO
38
+
39
+ # Load a model
40
+ model = YOLO('yolov8n-cls.pt') # load a pretrained model (recommended for training)
41
+
42
+ # Train the model
43
+ results = model.train(data='imagenette', epochs=100, imgsz=224)
44
+ ```
45
+
46
+ === "CLI"
47
+
48
+ ```bash
49
+ # Start training from a pretrained *.pt model
50
+ yolo detect train data=imagenette model=yolov8n-cls.pt epochs=100 imgsz=224
51
+ ```
52
+
53
+ ## Sample Images and Annotations
54
+
55
+ The ImageNette dataset contains colored images of various objects and scenes, providing a diverse dataset for image classification tasks. Here are some examples of images from the dataset:
56
+
57
+ ![Dataset sample image](https://docs.fast.ai/22_tutorial.imagenette_files/figure-html/cell-21-output-1.png)
58
+
59
+ The example showcases the variety and complexity of the images in the ImageNette dataset, highlighting the importance of a diverse dataset for training robust image classification models.
60
+
61
+ ## ImageNette160 and ImageNette320
62
+
63
+ For faster prototyping and training, the ImageNette dataset is also available in two reduced sizes: ImageNette160 and ImageNette320. These datasets maintain the same classes and structure as the full ImageNette dataset, but the images are resized to a smaller dimension. As such, these versions of the dataset are particularly useful for preliminary model testing, or when computational resources are limited.
64
+
65
+ To use these datasets, simply replace 'imagenette' with 'imagenette160' or 'imagenette320' in the training command. The following code snippets illustrate this:
66
+
67
+ !!! example "Train Example with ImageNette160"
68
+
69
+ === "Python"
70
+
71
+ ```python
72
+ from ultralytics import YOLO
73
+
74
+ # Load a model
75
+ model = YOLO('yolov8n-cls.pt') # load a pretrained model (recommended for training)
76
+
77
+ # Train the model with ImageNette160
78
+ results = model.train(data='imagenette160', epochs=100, imgsz=160)
79
+ ```
80
+
81
+ === "CLI"
82
+
83
+ ```bash
84
+ # Start training from a pretrained *.pt model with ImageNette160
85
+ yolo detect train data=imagenette160 model=yolov8n-cls.pt epochs=100 imgsz=160
86
+ ```
87
+
88
+ !!! example "Train Example with ImageNette320"
89
+
90
+ === "Python"
91
+
92
+ ```python
93
+ from ultralytics import YOLO
94
+
95
+ # Load a model
96
+ model = YOLO('yolov8n-cls.pt') # load a pretrained model (recommended for training)
97
+
98
+ # Train the model with ImageNette320
99
+ results = model.train(data='imagenette320', epochs=100, imgsz=320)
100
+ ```
101
+
102
+ === "CLI"
103
+
104
+ ```bash
105
+ # Start training from a pretrained *.pt model with ImageNette320
106
+ yolo detect train data=imagenette320 model=yolov8n-cls.pt epochs=100 imgsz=320
107
+ ```
108
+
109
+ These smaller versions of the dataset allow for rapid iterations during the development process while still providing valuable and realistic image classification tasks.
110
+
111
+ ## Citations and Acknowledgments
112
+
113
+ If you use the ImageNette dataset in your research or development work, please acknowledge it appropriately. For more information about the ImageNette dataset, visit the [ImageNette dataset GitHub page](https://github.com/fastai/imagenette).
yolov8-to/docs/datasets/classify/imagewoof.md ADDED
@@ -0,0 +1,84 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: Explore the ImageWoof dataset, designed for challenging dog breed classification. Train AI models with Ultralytics YOLO using this dataset.
4
+ keywords: ImageWoof, image classification, dog breeds, machine learning, deep learning, Ultralytics, YOLO, dataset
5
+ ---
6
+
7
+ # ImageWoof Dataset
8
+
9
+ The [ImageWoof](https://github.com/fastai/imagenette) dataset is a subset of the ImageNet consisting of 10 classes that are challenging to classify, since they're all dog breeds. It was created as a more difficult task for image classification algorithms to solve, aiming at encouraging development of more advanced models.
10
+
11
+ ## Key Features
12
+
13
+ - ImageWoof contains images of 10 different dog breeds: Australian terrier, Border terrier, Samoyed, Beagle, Shih-Tzu, English foxhound, Rhodesian ridgeback, Dingo, Golden retriever, and Old English sheepdog.
14
+ - The dataset provides images at various resolutions (full size, 320px, 160px), accommodating for different computational capabilities and research needs.
15
+ - It also includes a version with noisy labels, providing a more realistic scenario where labels might not always be reliable.
16
+
17
+ ## Dataset Structure
18
+
19
+ The ImageWoof dataset structure is based on the dog breed classes, with each breed having its own directory of images.
20
+
21
+ ## Applications
22
+
23
+ The ImageWoof dataset is widely used for training and evaluating deep learning models in image classification tasks, especially when it comes to more complex and similar classes. The dataset's challenge lies in the subtle differences between the dog breeds, pushing the limits of model's performance and generalization.
24
+
25
+ ## Usage
26
+
27
+ To train a CNN model on the ImageWoof dataset for 100 epochs with an image size of 224x224, you can use the following code snippets. For a comprehensive list of available arguments, refer to the model [Training](../../modes/train.md) page.
28
+
29
+ !!! example "Train Example"
30
+
31
+ === "Python"
32
+
33
+ ```python
34
+ from ultralytics import YOLO
35
+
36
+ # Load a model
37
+ model = YOLO('yolov8n-cls.pt') # load a pretrained model (recommended for training)
38
+
39
+ # Train the model
40
+ results = model.train(data='imagewoof', epochs=100, imgsz=224)
41
+ ```
42
+
43
+ === "CLI"
44
+
45
+ ```bash
46
+ # Start training from a pretrained *.pt model
47
+ yolo detect train data=imagewoof model=yolov8n-cls.pt epochs=100 imgsz=224
48
+ ```
49
+
50
+ ## Dataset Variants
51
+
52
+ ImageWoof dataset comes in three different sizes to accommodate various research needs and computational capabilities:
53
+
54
+ 1. **Full Size (imagewoof)**: This is the original version of the ImageWoof dataset. It contains full-sized images and is ideal for final training and performance benchmarking.
55
+
56
+ 2. **Medium Size (imagewoof320)**: This version contains images resized to have a maximum edge length of 320 pixels. It's suitable for faster training without significantly sacrificing model performance.
57
+
58
+ 3. **Small Size (imagewoof160)**: This version contains images resized to have a maximum edge length of 160 pixels. It's designed for rapid prototyping and experimentation where training speed is a priority.
59
+
60
+ To use these variants in your training, simply replace 'imagewoof' in the dataset argument with 'imagewoof320' or 'imagewoof160'. For example:
61
+
62
+ ```python
63
+ # For medium-sized dataset
64
+ model.train(data='imagewoof320', epochs=100, imgsz=224)
65
+
66
+ # For small-sized dataset
67
+ model.train(data='imagewoof160', epochs=100, imgsz=224)
68
+ ```
69
+
70
+ It's important to note that using smaller images will likely yield lower performance in terms of classification accuracy. However, it's an excellent way to iterate quickly in the early stages of model development and prototyping.
71
+
72
+ ## Sample Images and Annotations
73
+
74
+ The ImageWoof dataset contains colorful images of various dog breeds, providing a challenging dataset for image classification tasks. Here are some examples of images from the dataset:
75
+
76
+ ![Dataset sample image](https://user-images.githubusercontent.com/26833433/239357533-ec833254-4351-491b-8cb3-59578ea5d0b2.png)
77
+
78
+ The example showcases the subtle differences and similarities among the different dog breeds in the ImageWoof dataset, highlighting the complexity and difficulty of the classification task.
79
+
80
+ ## Citations and Acknowledgments
81
+
82
+ If you use the ImageWoof dataset in your research or development work, please make sure to acknowledge the creators of the dataset by linking to the [official dataset repository](https://github.com/fastai/imagenette).
83
+
84
+ We would like to acknowledge the FastAI team for creating and maintaining the ImageWoof dataset as a valuable resource for the machine learning and computer vision research community. For more information about the ImageWoof dataset, visit the [ImageWoof dataset repository](https://github.com/fastai/imagenette).
yolov8-to/docs/datasets/classify/index.md ADDED
@@ -0,0 +1,120 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: Explore image classification datasets supported by Ultralytics, learn the standard dataset format, and set up your own dataset for training models.
4
+ keywords: Ultralytics, image classification, dataset, machine learning, CIFAR-10, ImageNet, MNIST, torchvision
5
+ ---
6
+
7
+ # Image Classification Datasets Overview
8
+
9
+ ## Dataset format
10
+
11
+ The folder structure for classification datasets in torchvision typically follows a standard format:
12
+
13
+ ```
14
+ root/
15
+ |-- class1/
16
+ | |-- img1.jpg
17
+ | |-- img2.jpg
18
+ | |-- ...
19
+ |
20
+ |-- class2/
21
+ | |-- img1.jpg
22
+ | |-- img2.jpg
23
+ | |-- ...
24
+ |
25
+ |-- class3/
26
+ | |-- img1.jpg
27
+ | |-- img2.jpg
28
+ | |-- ...
29
+ |
30
+ |-- ...
31
+ ```
32
+
33
+ In this folder structure, the `root` directory contains one subdirectory for each class in the dataset. Each subdirectory is named after the corresponding class and contains all the images for that class. Each image file is named uniquely and is typically in a common image file format such as JPEG or PNG.
34
+
35
+ ** Example **
36
+
37
+ For example, in the CIFAR10 dataset, the folder structure would look like this:
38
+
39
+ ```
40
+ cifar-10-/
41
+ |
42
+ |-- train/
43
+ | |-- airplane/
44
+ | | |-- 10008_airplane.png
45
+ | | |-- 10009_airplane.png
46
+ | | |-- ...
47
+ | |
48
+ | |-- automobile/
49
+ | | |-- 1000_automobile.png
50
+ | | |-- 1001_automobile.png
51
+ | | |-- ...
52
+ | |
53
+ | |-- bird/
54
+ | | |-- 10014_bird.png
55
+ | | |-- 10015_bird.png
56
+ | | |-- ...
57
+ | |
58
+ | |-- ...
59
+ |
60
+ |-- test/
61
+ | |-- airplane/
62
+ | | |-- 10_airplane.png
63
+ | | |-- 11_airplane.png
64
+ | | |-- ...
65
+ | |
66
+ | |-- automobile/
67
+ | | |-- 100_automobile.png
68
+ | | |-- 101_automobile.png
69
+ | | |-- ...
70
+ | |
71
+ | |-- bird/
72
+ | | |-- 1000_bird.png
73
+ | | |-- 1001_bird.png
74
+ | | |-- ...
75
+ | |
76
+ | |-- ...
77
+ ```
78
+
79
+ In this example, the `train` directory contains subdirectories for each class in the dataset, and each class subdirectory contains all the images for that class. The `test` directory has a similar structure. The `root` directory also contains other files that are part of the CIFAR10 dataset.
80
+
81
+ ## Usage
82
+
83
+ !!! example ""
84
+
85
+ === "Python"
86
+
87
+ ```python
88
+ from ultralytics import YOLO
89
+
90
+ # Load a model
91
+ model = YOLO('yolov8n-cls.pt') # load a pretrained model (recommended for training)
92
+
93
+ # Train the model
94
+ results = model.train(data='path/to/dataset', epochs=100, imgsz=640)
95
+ ```
96
+ === "CLI"
97
+
98
+ ```bash
99
+ # Start training from a pretrained *.pt model
100
+ yolo detect train data=path/to/data model=yolov8n-cls.pt epochs=100 imgsz=640
101
+ ```
102
+
103
+ ## Supported Datasets
104
+
105
+ Ultralytics supports the following datasets with automatic download:
106
+
107
+ * [Caltech 101](caltech101.md): A dataset containing images of 101 object categories for image classification tasks.
108
+ * [Caltech 256](caltech256.md): An extended version of Caltech 101 with 256 object categories and more challenging images.
109
+ * [CIFAR-10](cifar10.md): A dataset of 60K 32x32 color images in 10 classes, with 6K images per class.
110
+ * [CIFAR-100](cifar100.md): An extended version of CIFAR-10 with 100 object categories and 600 images per class.
111
+ * [Fashion-MNIST](fashion-mnist.md): A dataset consisting of 70,000 grayscale images of 10 fashion categories for image classification tasks.
112
+ * [ImageNet](imagenet.md): A large-scale dataset for object detection and image classification with over 14 million images and 20,000 categories.
113
+ * [ImageNet-10](imagenet10.md): A smaller subset of ImageNet with 10 categories for faster experimentation and testing.
114
+ * [Imagenette](imagenette.md): A smaller subset of ImageNet that contains 10 easily distinguishable classes for quicker training and testing.
115
+ * [Imagewoof](imagewoof.md): A more challenging subset of ImageNet containing 10 dog breed categories for image classification tasks.
116
+ * [MNIST](mnist.md): A dataset of 70,000 grayscale images of handwritten digits for image classification tasks.
117
+
118
+ ### Adding your own dataset
119
+
120
+ If you have your own dataset and would like to use it for training classification models with Ultralytics, ensure that it follows the format specified above under "Dataset format" and then point your `data` argument to the dataset directory.
yolov8-to/docs/datasets/classify/mnist.md ADDED
@@ -0,0 +1,86 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: Detailed guide on the MNIST Dataset, a benchmark in the machine learning community for image classification tasks. Learn about its structure, usage and application.
4
+ keywords: MNIST dataset, Ultralytics, image classification, machine learning, computer vision, deep learning, AI, dataset guide
5
+ ---
6
+
7
+ # MNIST Dataset
8
+
9
+ The [MNIST](http://yann.lecun.com/exdb/mnist/) (Modified National Institute of Standards and Technology) dataset is a large database of handwritten digits that is commonly used for training various image processing systems and machine learning models. It was created by "re-mixing" the samples from NIST's original datasets and has become a benchmark for evaluating the performance of image classification algorithms.
10
+
11
+ ## Key Features
12
+
13
+ - MNIST contains 60,000 training images and 10,000 testing images of handwritten digits.
14
+ - The dataset comprises grayscale images of size 28x28 pixels.
15
+ - The images are normalized to fit into a 28x28 pixel bounding box and anti-aliased, introducing grayscale levels.
16
+ - MNIST is widely used for training and testing in the field of machine learning, especially for image classification tasks.
17
+
18
+ ## Dataset Structure
19
+
20
+ The MNIST dataset is split into two subsets:
21
+
22
+ 1. **Training Set**: This subset contains 60,000 images of handwritten digits used for training machine learning models.
23
+ 2. **Testing Set**: This subset consists of 10,000 images used for testing and benchmarking the trained models.
24
+
25
+ ## Extended MNIST (EMNIST)
26
+
27
+ Extended MNIST (EMNIST) is a newer dataset developed and released by NIST to be the successor to MNIST. While MNIST included images only of handwritten digits, EMNIST includes all the images from NIST Special Database 19, which is a large database of handwritten uppercase and lowercase letters as well as digits. The images in EMNIST were converted into the same 28x28 pixel format, by the same process, as were the MNIST images. Accordingly, tools that work with the older, smaller MNIST dataset will likely work unmodified with EMNIST.
28
+
29
+ ## Applications
30
+
31
+ The MNIST dataset is widely used for training and evaluating deep learning models in image classification tasks, such as Convolutional Neural Networks (CNNs), Support Vector Machines (SVMs), and various other machine learning algorithms. The dataset's simple and well-structured format makes it an essential resource for researchers and practitioners in the field of machine learning and computer vision.
32
+
33
+ ## Usage
34
+
35
+ To train a CNN model on the MNIST dataset for 100 epochs with an image size of 32x32, you can use the following code snippets. For a comprehensive list of available arguments, refer to the model [Training](../../modes/train.md) page.
36
+
37
+ !!! example "Train Example"
38
+
39
+ === "Python"
40
+
41
+ ```python
42
+ from ultralytics import YOLO
43
+
44
+ # Load a model
45
+ model = YOLO('yolov8n-cls.pt') # load a pretrained model (recommended for training)
46
+
47
+ # Train the model
48
+ results = model.train(data='mnist', epochs=100, imgsz=32)
49
+ ```
50
+
51
+ === "CLI"
52
+
53
+ ```bash
54
+ # Start training from a pretrained *.pt model
55
+ cnn detect train data=mnist model=yolov8n-cls.pt epochs=100 imgsz=28
56
+ ```
57
+
58
+ ## Sample Images and Annotations
59
+
60
+ The MNIST dataset contains grayscale images of handwritten digits, providing a well-structured dataset for image classification tasks. Here are some examples of images from the dataset:
61
+
62
+ ![Dataset sample image](https://upload.wikimedia.org/wikipedia/commons/2/27/MnistExamples.png)
63
+
64
+ The example showcases the variety and complexity of the handwritten digits in the MNIST dataset, highlighting the importance of a diverse dataset for training robust image classification models.
65
+
66
+ ## Citations and Acknowledgments
67
+
68
+ If you use the MNIST dataset in your
69
+
70
+ research or development work, please cite the following paper:
71
+
72
+ !!! note ""
73
+
74
+ === "BibTeX"
75
+
76
+ ```bibtex
77
+ @article{lecun2010mnist,
78
+ title={MNIST handwritten digit database},
79
+ author={LeCun, Yann and Cortes, Corinna and Burges, CJ},
80
+ journal={ATT Labs [Online]. Available: http://yann.lecun.com/exdb/mnist},
81
+ volume={2},
82
+ year={2010}
83
+ }
84
+ ```
85
+
86
+ We would like to acknowledge Yann LeCun, Corinna Cortes, and Christopher J.C. Burges for creating and maintaining the MNIST dataset as a valuable resource for the machine learning and computer vision research community. For more information about the MNIST dataset and its creators, visit the [MNIST dataset website](http://yann.lecun.com/exdb/mnist/).
yolov8-to/docs/datasets/detect/argoverse.md ADDED
@@ -0,0 +1,97 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: Explore Argoverse, a comprehensive dataset for autonomous driving tasks including 3D tracking, motion forecasting and depth estimation used in YOLO.
4
+ keywords: Argoverse dataset, autonomous driving, YOLO, 3D tracking, motion forecasting, LiDAR data, HD maps, ultralytics documentation
5
+ ---
6
+
7
+ # Argoverse Dataset
8
+
9
+ The [Argoverse](https://www.argoverse.org/) dataset is a collection of data designed to support research in autonomous driving tasks, such as 3D tracking, motion forecasting, and stereo depth estimation. Developed by Argo AI, the dataset provides a wide range of high-quality sensor data, including high-resolution images, LiDAR point clouds, and map data.
10
+
11
+ !!! note
12
+
13
+ The Argoverse dataset *.zip file required for training was removed from Amazon S3 after the shutdown of Argo AI by Ford, but we have made it available for manual download on [Google Drive](https://drive.google.com/file/d/1st9qW3BeIwQsnR0t8mRpvbsSWIo16ACi/view?usp=drive_link).
14
+
15
+ ## Key Features
16
+
17
+ - Argoverse contains over 290K labeled 3D object tracks and 5 million object instances across 1,263 distinct scenes.
18
+ - The dataset includes high-resolution camera images, LiDAR point clouds, and richly annotated HD maps.
19
+ - Annotations include 3D bounding boxes for objects, object tracks, and trajectory information.
20
+ - Argoverse provides multiple subsets for different tasks, such as 3D tracking, motion forecasting, and stereo depth estimation.
21
+
22
+ ## Dataset Structure
23
+
24
+ The Argoverse dataset is organized into three main subsets:
25
+
26
+ 1. **Argoverse 3D Tracking**: This subset contains 113 scenes with over 290K labeled 3D object tracks, focusing on 3D object tracking tasks. It includes LiDAR point clouds, camera images, and sensor calibration information.
27
+ 2. **Argoverse Motion Forecasting**: This subset consists of 324K vehicle trajectories collected from 60 hours of driving data, suitable for motion forecasting tasks.
28
+ 3. **Argoverse Stereo Depth Estimation**: This subset is designed for stereo depth estimation tasks and includes over 10K stereo image pairs with corresponding LiDAR point clouds for ground truth depth estimation.
29
+
30
+ ## Applications
31
+
32
+ The Argoverse dataset is widely used for training and evaluating deep learning models in autonomous driving tasks such as 3D object tracking, motion forecasting, and stereo depth estimation. The dataset's diverse set of sensor data, object annotations, and map information make it a valuable resource for researchers and practitioners in the field of autonomous driving.
33
+
34
+ ## Dataset YAML
35
+
36
+ A YAML (Yet Another Markup Language) file is used to define the dataset configuration. It contains information about the dataset's paths, classes, and other relevant information. For the case of the Argoverse dataset, the `Argoverse.yaml` file is maintained at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/Argoverse.yaml](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/Argoverse.yaml).
37
+
38
+ !!! example "ultralytics/cfg/datasets/Argoverse.yaml"
39
+
40
+ ```yaml
41
+ --8<-- "ultralytics/cfg/datasets/Argoverse.yaml"
42
+ ```
43
+
44
+ ## Usage
45
+
46
+ To train a YOLOv8n model on the Argoverse dataset for 100 epochs with an image size of 640, you can use the following code snippets. For a comprehensive list of available arguments, refer to the model [Training](../../modes/train.md) page.
47
+
48
+ !!! example "Train Example"
49
+
50
+ === "Python"
51
+
52
+ ```python
53
+ from ultralytics import YOLO
54
+
55
+ # Load a model
56
+ model = YOLO('yolov8n.pt') # load a pretrained model (recommended for training)
57
+
58
+ # Train the model
59
+ results = model.train(data='Argoverse.yaml', epochs=100, imgsz=640)
60
+ ```
61
+
62
+ === "CLI"
63
+
64
+ ```bash
65
+ # Start training from a pretrained *.pt model
66
+ yolo detect train data=Argoverse.yaml model=yolov8n.pt epochs=100 imgsz=640
67
+ ```
68
+
69
+ ## Sample Data and Annotations
70
+
71
+ The Argoverse dataset contains a diverse set of sensor data, including camera images, LiDAR point clouds, and HD map information, providing rich context for autonomous driving tasks. Here are some examples of data from the dataset, along with their corresponding annotations:
72
+
73
+ ![Dataset sample image](https://www.argoverse.org/assets/images/reference_images/av2_ground_height.png)
74
+
75
+ - **Argoverse 3D Tracking**: This image demonstrates an example of 3D object tracking, where objects are annotated with 3D bounding boxes. The dataset provides LiDAR point clouds and camera images to facilitate the development of models for this task.
76
+
77
+ The example showcases the variety and complexity of the data in the Argoverse dataset and highlights the importance of high-quality sensor data for autonomous driving tasks.
78
+
79
+ ## Citations and Acknowledgments
80
+
81
+ If you use the Argoverse dataset in your research or development work, please cite the following paper:
82
+
83
+ !!! note ""
84
+
85
+ === "BibTeX"
86
+
87
+ ```bibtex
88
+ @inproceedings{chang2019argoverse,
89
+ title={Argoverse: 3D Tracking and Forecasting with Rich Maps},
90
+ author={Chang, Ming-Fang and Lambert, John and Sangkloy, Patsorn and Singh, Jagjeet and Bak, Slawomir and Hartnett, Andrew and Wang, Dequan and Carr, Peter and Lucey, Simon and Ramanan, Deva and others},
91
+ booktitle={Proceedings of the IEEE/CVF Conference on Computer Vision and Pattern Recognition},
92
+ pages={8748--8757},
93
+ year={2019}
94
+ }
95
+ ```
96
+
97
+ We would like to acknowledge Argo AI for creating and maintaining the Argoverse dataset as a valuable resource for the autonomous driving research community. For more information about the Argoverse dataset and its creators, visit the [Argoverse dataset website](https://www.argoverse.org/).
yolov8-to/docs/datasets/detect/coco.md ADDED
@@ -0,0 +1,94 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: Learn how COCO, a leading dataset for object detection and segmentation, integrates with Ultralytics. Discover ways to use it for training YOLO models.
4
+ keywords: Ultralytics, COCO dataset, object detection, YOLO, YOLO model training, image segmentation, computer vision, deep learning models
5
+ ---
6
+
7
+ # COCO Dataset
8
+
9
+ The [COCO](https://cocodataset.org/#home) (Common Objects in Context) dataset is a large-scale object detection, segmentation, and captioning dataset. It is designed to encourage research on a wide variety of object categories and is commonly used for benchmarking computer vision models. It is an essential dataset for researchers and developers working on object detection, segmentation, and pose estimation tasks.
10
+
11
+ ## Key Features
12
+
13
+ - COCO contains 330K images, with 200K images having annotations for object detection, segmentation, and captioning tasks.
14
+ - The dataset comprises 80 object categories, including common objects like cars, bicycles, and animals, as well as more specific categories such as umbrellas, handbags, and sports equipment.
15
+ - Annotations include object bounding boxes, segmentation masks, and captions for each image.
16
+ - COCO provides standardized evaluation metrics like mean Average Precision (mAP) for object detection, and mean Average Recall (mAR) for segmentation tasks, making it suitable for comparing model performance.
17
+
18
+ ## Dataset Structure
19
+
20
+ The COCO dataset is split into three subsets:
21
+
22
+ 1. **Train2017**: This subset contains 118K images for training object detection, segmentation, and captioning models.
23
+ 2. **Val2017**: This subset has 5K images used for validation purposes during model training.
24
+ 3. **Test2017**: This subset consists of 20K images used for testing and benchmarking the trained models. Ground truth annotations for this subset are not publicly available, and the results are submitted to the [COCO evaluation server](https://codalab.lisn.upsaclay.fr/competitions/7384) for performance evaluation.
25
+
26
+ ## Applications
27
+
28
+ The COCO dataset is widely used for training and evaluating deep learning models in object detection (such as YOLO, Faster R-CNN, and SSD), instance segmentation (such as Mask R-CNN), and keypoint detection (such as OpenPose). The dataset's diverse set of object categories, large number of annotated images, and standardized evaluation metrics make it an essential resource for computer vision researchers and practitioners.
29
+
30
+ ## Dataset YAML
31
+
32
+ A YAML (Yet Another Markup Language) file is used to define the dataset configuration. It contains information about the dataset's paths, classes, and other relevant information. In the case of the COCO dataset, the `coco.yaml` file is maintained at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/coco.yaml](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/coco.yaml).
33
+
34
+ !!! example "ultralytics/cfg/datasets/coco.yaml"
35
+
36
+ ```yaml
37
+ --8<-- "ultralytics/cfg/datasets/coco.yaml"
38
+ ```
39
+
40
+ ## Usage
41
+
42
+ To train a YOLOv8n model on the COCO dataset for 100 epochs with an image size of 640, you can use the following code snippets. For a comprehensive list of available arguments, refer to the model [Training](../../modes/train.md) page.
43
+
44
+ !!! example "Train Example"
45
+
46
+ === "Python"
47
+
48
+ ```python
49
+ from ultralytics import YOLO
50
+
51
+ # Load a model
52
+ model = YOLO('yolov8n.pt') # load a pretrained model (recommended for training)
53
+
54
+ # Train the model
55
+ results = model.train(data='coco.yaml', epochs=100, imgsz=640)
56
+ ```
57
+
58
+ === "CLI"
59
+
60
+ ```bash
61
+ # Start training from a pretrained *.pt model
62
+ yolo detect train data=coco.yaml model=yolov8n.pt epochs=100 imgsz=640
63
+ ```
64
+
65
+ ## Sample Images and Annotations
66
+
67
+ The COCO dataset contains a diverse set of images with various object categories and complex scenes. Here are some examples of images from the dataset, along with their corresponding annotations:
68
+
69
+ ![Dataset sample image](https://user-images.githubusercontent.com/26833433/236811818-5b566576-1e92-42fa-9462-4b6a848abe89.jpg)
70
+
71
+ - **Mosaiced Image**: This image demonstrates a training batch composed of mosaiced dataset images. Mosaicing is a technique used during training that combines multiple images into a single image to increase the variety of objects and scenes within each training batch. This helps improve the model's ability to generalize to different object sizes, aspect ratios, and contexts.
72
+
73
+ The example showcases the variety and complexity of the images in the COCO dataset and the benefits of using mosaicing during the training process.
74
+
75
+ ## Citations and Acknowledgments
76
+
77
+ If you use the COCO dataset in your research or development work, please cite the following paper:
78
+
79
+ !!! note ""
80
+
81
+ === "BibTeX"
82
+
83
+ ```bibtex
84
+ @misc{lin2015microsoft,
85
+ title={Microsoft COCO: Common Objects in Context},
86
+ author={Tsung-Yi Lin and Michael Maire and Serge Belongie and Lubomir Bourdev and Ross Girshick and James Hays and Pietro Perona and Deva Ramanan and C. Lawrence Zitnick and Piotr Dollár},
87
+ year={2015},
88
+ eprint={1405.0312},
89
+ archivePrefix={arXiv},
90
+ primaryClass={cs.CV}
91
+ }
92
+ ```
93
+
94
+ We would like to acknowledge the COCO Consortium for creating and maintaining this valuable resource for the computer vision community. For more information about the COCO dataset and its creators, visit the [COCO dataset website](https://cocodataset.org/#home).
yolov8-to/docs/datasets/detect/coco8.md ADDED
@@ -0,0 +1,84 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: Discover the benefits of using the practical and diverse COCO8 dataset for object detection model testing. Learn to configure and use it via Ultralytics HUB and YOLOv8.
4
+ keywords: Ultralytics, COCO8 dataset, object detection, model testing, dataset configuration, detection approaches, sanity check, training pipelines, YOLOv8
5
+ ---
6
+
7
+ # COCO8 Dataset
8
+
9
+ ## Introduction
10
+
11
+ [Ultralytics](https://ultralytics.com) COCO8 is a small, but versatile object detection dataset composed of the first 8
12
+ images of the COCO train 2017 set, 4 for training and 4 for validation. This dataset is ideal for testing and debugging
13
+ object detection models, or for experimenting with new detection approaches. With 8 images, it is small enough to be
14
+ easily manageable, yet diverse enough to test training pipelines for errors and act as a sanity check before training
15
+ larger datasets.
16
+
17
+ This dataset is intended for use with Ultralytics [HUB](https://hub.ultralytics.com)
18
+ and [YOLOv8](https://github.com/ultralytics/ultralytics).
19
+
20
+ ## Dataset YAML
21
+
22
+ A YAML (Yet Another Markup Language) file is used to define the dataset configuration. It contains information about the dataset's paths, classes, and other relevant information. In the case of the COCO8 dataset, the `coco8.yaml` file is maintained at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/coco8.yaml](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/coco8.yaml).
23
+
24
+ !!! example "ultralytics/cfg/datasets/coco8.yaml"
25
+
26
+ ```yaml
27
+ --8<-- "ultralytics/cfg/datasets/coco8.yaml"
28
+ ```
29
+
30
+ ## Usage
31
+
32
+ To train a YOLOv8n model on the COCO8 dataset for 100 epochs with an image size of 640, you can use the following code snippets. For a comprehensive list of available arguments, refer to the model [Training](../../modes/train.md) page.
33
+
34
+ !!! example "Train Example"
35
+
36
+ === "Python"
37
+
38
+ ```python
39
+ from ultralytics import YOLO
40
+
41
+ # Load a model
42
+ model = YOLO('yolov8n.pt') # load a pretrained model (recommended for training)
43
+
44
+ # Train the model
45
+ results = model.train(data='coco8.yaml', epochs=100, imgsz=640)
46
+ ```
47
+
48
+ === "CLI"
49
+
50
+ ```bash
51
+ # Start training from a pretrained *.pt model
52
+ yolo detect train data=coco8.yaml model=yolov8n.pt epochs=100 imgsz=640
53
+ ```
54
+
55
+ ## Sample Images and Annotations
56
+
57
+ Here are some examples of images from the COCO8 dataset, along with their corresponding annotations:
58
+
59
+ <img src="https://user-images.githubusercontent.com/26833433/236818348-e6260a3d-0454-436b-83a9-de366ba07235.jpg" alt="Dataset sample image" width="800">
60
+
61
+ - **Mosaiced Image**: This image demonstrates a training batch composed of mosaiced dataset images. Mosaicing is a technique used during training that combines multiple images into a single image to increase the variety of objects and scenes within each training batch. This helps improve the model's ability to generalize to different object sizes, aspect ratios, and contexts.
62
+
63
+ The example showcases the variety and complexity of the images in the COCO8 dataset and the benefits of using mosaicing during the training process.
64
+
65
+ ## Citations and Acknowledgments
66
+
67
+ If you use the COCO dataset in your research or development work, please cite the following paper:
68
+
69
+ !!! note ""
70
+
71
+ === "BibTeX"
72
+
73
+ ```bibtex
74
+ @misc{lin2015microsoft,
75
+ title={Microsoft COCO: Common Objects in Context},
76
+ author={Tsung-Yi Lin and Michael Maire and Serge Belongie and Lubomir Bourdev and Ross Girshick and James Hays and Pietro Perona and Deva Ramanan and C. Lawrence Zitnick and Piotr Dollár},
77
+ year={2015},
78
+ eprint={1405.0312},
79
+ archivePrefix={arXiv},
80
+ primaryClass={cs.CV}
81
+ }
82
+ ```
83
+
84
+ We would like to acknowledge the COCO Consortium for creating and maintaining this valuable resource for the computer vision community. For more information about the COCO dataset and its creators, visit the [COCO dataset website](https://cocodataset.org/#home).
yolov8-to/docs/datasets/detect/globalwheat2020.md ADDED
@@ -0,0 +1,91 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: Understand how to utilize the vast Global Wheat Head Dataset for building wheat head detection models. Features, structure, applications, usage, sample data, and citation.
4
+ keywords: Ultralytics, YOLO, Global Wheat Head Dataset, wheat head detection, plant phenotyping, crop management, deep learning, outdoor images, annotations, YAML configuration
5
+ ---
6
+
7
+ # Global Wheat Head Dataset
8
+
9
+ The [Global Wheat Head Dataset](http://www.global-wheat.com/) is a collection of images designed to support the development of accurate wheat head detection models for applications in wheat phenotyping and crop management. Wheat heads, also known as spikes, are the grain-bearing parts of the wheat plant. Accurate estimation of wheat head density and size is essential for assessing crop health, maturity, and yield potential. The dataset, created by a collaboration of nine research institutes from seven countries, covers multiple growing regions to ensure models generalize well across different environments.
10
+
11
+ ## Key Features
12
+
13
+ - The dataset contains over 3,000 training images from Europe (France, UK, Switzerland) and North America (Canada).
14
+ - It includes approximately 1,000 test images from Australia, Japan, and China.
15
+ - Images are outdoor field images, capturing the natural variability in wheat head appearances.
16
+ - Annotations include wheat head bounding boxes to support object detection tasks.
17
+
18
+ ## Dataset Structure
19
+
20
+ The Global Wheat Head Dataset is organized into two main subsets:
21
+
22
+ 1. **Training Set**: This subset contains over 3,000 images from Europe and North America. The images are labeled with wheat head bounding boxes, providing ground truth for training object detection models.
23
+ 2. **Test Set**: This subset consists of approximately 1,000 images from Australia, Japan, and China. These images are used for evaluating the performance of trained models on unseen genotypes, environments, and observational conditions.
24
+
25
+ ## Applications
26
+
27
+ The Global Wheat Head Dataset is widely used for training and evaluating deep learning models in wheat head detection tasks. The dataset's diverse set of images, capturing a wide range of appearances, environments, and conditions, make it a valuable resource for researchers and practitioners in the field of plant phenotyping and crop management.
28
+
29
+ ## Dataset YAML
30
+
31
+ A YAML (Yet Another Markup Language) file is used to define the dataset configuration. It contains information about the dataset's paths, classes, and other relevant information. For the case of the Global Wheat Head Dataset, the `GlobalWheat2020.yaml` file is maintained at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/GlobalWheat2020.yaml](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/GlobalWheat2020.yaml).
32
+
33
+ !!! example "ultralytics/cfg/datasets/GlobalWheat2020.yaml"
34
+
35
+ ```yaml
36
+ --8<-- "ultralytics/cfg/datasets/GlobalWheat2020.yaml"
37
+ ```
38
+
39
+ ## Usage
40
+
41
+ To train a YOLOv8n model on the Global Wheat Head Dataset for 100 epochs with an image size of 640, you can use the following code snippets. For a comprehensive list of available arguments, refer to the model [Training](../../modes/train.md) page.
42
+
43
+ !!! example "Train Example"
44
+
45
+ === "Python"
46
+
47
+ ```python
48
+ from ultralytics import YOLO
49
+
50
+ # Load a model
51
+ model = YOLO('yolov8n.pt') # load a pretrained model (recommended for training)
52
+
53
+ # Train the model
54
+ results = model.train(data='GlobalWheat2020.yaml', epochs=100, imgsz=640)
55
+ ```
56
+
57
+ === "CLI"
58
+
59
+ ```bash
60
+ # Start training from a pretrained *.pt model
61
+ yolo detect train data=GlobalWheat2020.yaml model=yolov8n.pt epochs=100 imgsz=640
62
+ ```
63
+
64
+ ## Sample Data and Annotations
65
+
66
+ The Global Wheat Head Dataset contains a diverse set of outdoor field images, capturing the natural variability in wheat head appearances, environments, and conditions. Here are some examples of data from the dataset, along with their corresponding annotations:
67
+
68
+ ![Dataset sample image](https://i.ytimg.com/vi/yqvMuw-uedU/maxresdefault.jpg)
69
+
70
+ - **Wheat Head Detection**: This image demonstrates an example of wheat head detection, where wheat heads are annotated with bounding boxes. The dataset provides a variety of images to facilitate the development of models for this task.
71
+
72
+ The example showcases the variety and complexity of the data in the Global Wheat Head Dataset and highlights the importance of accurate wheat head detection for applications in wheat phenotyping and crop management.
73
+
74
+ ## Citations and Acknowledgments
75
+
76
+ If you use the Global Wheat Head Dataset in your research or development work, please cite the following paper:
77
+
78
+ !!! note ""
79
+
80
+ === "BibTeX"
81
+
82
+ ```bibtex
83
+ @article{david2020global,
84
+ title={Global Wheat Head Detection (GWHD) Dataset: A Large and Diverse Dataset of High-Resolution RGB-Labelled Images to Develop and Benchmark Wheat Head Detection Methods},
85
+ author={David, Etienne and Madec, Simon and Sadeghi-Tehran, Pouria and Aasen, Helge and Zheng, Bangyou and Liu, Shouyang and Kirchgessner, Norbert and Ishikawa, Goro and Nagasawa, Koichi and Badhon, Minhajul and others},
86
+ journal={arXiv preprint arXiv:2005.02162},
87
+ year={2020}
88
+ }
89
+ ```
90
+
91
+ We would like to acknowledge the researchers and institutions that contributed to the creation and maintenance of the Global Wheat Head Dataset as a valuable resource for the plant phenotyping and crop management research community. For more information about the dataset and its creators, visit the [Global Wheat Head Dataset website](http://www.global-wheat.com/).
yolov8-to/docs/datasets/detect/index.md ADDED
@@ -0,0 +1,108 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: Navigate through supported dataset formats, methods to utilize them and how to add your own datasets. Get insights on porting or converting label formats.
4
+ keywords: Ultralytics, YOLO, datasets, object detection, dataset formats, label formats, data conversion
5
+ ---
6
+
7
+ # Object Detection Datasets Overview
8
+
9
+ Training a robust and accurate object detection model requires a comprehensive dataset. This guide introduces various formats of datasets that are compatible with the Ultralytics YOLO model and provides insights into their structure, usage, and how to convert between different formats.
10
+
11
+ ## Supported Dataset Formats
12
+
13
+ ### Ultralytics YOLO format
14
+
15
+ The Ultralytics YOLO format is a dataset configuration format that allows you to define the dataset root directory, the relative paths to training/validation/testing image directories or *.txt files containing image paths, and a dictionary of class names. Here is an example:
16
+
17
+ ```yaml
18
+ # Train/val/test sets as 1) dir: path/to/imgs, 2) file: path/to/imgs.txt, or 3) list: [path/to/imgs1, path/to/imgs2, ..]
19
+ path: ../datasets/coco8 # dataset root dir
20
+ train: images/train # train images (relative to 'path') 4 images
21
+ val: images/val # val images (relative to 'path') 4 images
22
+ test: # test images (optional)
23
+
24
+ # Classes (80 COCO classes)
25
+ names:
26
+ 0: person
27
+ 1: bicycle
28
+ 2: car
29
+ ...
30
+ 77: teddy bear
31
+ 78: hair drier
32
+ 79: toothbrush
33
+ ```
34
+
35
+ Labels for this format should be exported to YOLO format with one `*.txt` file per image. If there are no objects in an image, no `*.txt` file is required. The `*.txt` file should be formatted with one row per object in `class x_center y_center width height` format. Box coordinates must be in **normalized xywh** format (from 0 to 1). If your boxes are in pixels, you should divide `x_center` and `width` by image width, and `y_center` and `height` by image height. Class numbers should be zero-indexed (start with 0).
36
+
37
+ <p align="center"><img width="750" src="https://user-images.githubusercontent.com/26833433/91506361-c7965000-e886-11ea-8291-c72b98c25eec.jpg"></p>
38
+
39
+ The label file corresponding to the above image contains 2 persons (class `0`) and a tie (class `27`):
40
+
41
+ <p align="center"><img width="428" src="https://user-images.githubusercontent.com/26833433/112467037-d2568c00-8d66-11eb-8796-55402ac0d62f.png"></p>
42
+
43
+ When using the Ultralytics YOLO format, organize your training and validation images and labels as shown in the example below.
44
+
45
+ <p align="center"><img width="700" src="https://user-images.githubusercontent.com/26833433/134436012-65111ad1-9541-4853-81a6-f19a3468b75f.png"></p>
46
+
47
+ ## Usage
48
+
49
+ Here's how you can use these formats to train your model:
50
+
51
+ !!! example ""
52
+
53
+ === "Python"
54
+
55
+ ```python
56
+ from ultralytics import YOLO
57
+
58
+ # Load a model
59
+ model = YOLO('yolov8n.pt') # load a pretrained model (recommended for training)
60
+
61
+ # Train the model
62
+ results = model.train(data='coco8.yaml', epochs=100, imgsz=640)
63
+ ```
64
+ === "CLI"
65
+
66
+ ```bash
67
+ # Start training from a pretrained *.pt model
68
+ yolo detect train data=coco8.yaml model=yolov8n.pt epochs=100 imgsz=640
69
+ ```
70
+
71
+ ## Supported Datasets
72
+
73
+ Here is a list of the supported datasets and a brief description for each:
74
+
75
+ - [**Argoverse**](./argoverse.md): A collection of sensor data collected from autonomous vehicles. It contains 3D tracking annotations for car objects.
76
+ - [**COCO**](./coco.md): Common Objects in Context (COCO) is a large-scale object detection, segmentation, and captioning dataset with 80 object categories.
77
+ - [**COCO8**](./coco8.md): A smaller subset of the COCO dataset, COCO8 is more lightweight and faster to train.
78
+ - [**GlobalWheat2020**](./globalwheat2020.md): A dataset containing images of wheat heads for the Global Wheat Challenge 2020.
79
+ - [**Objects365**](./objects365.md): A large-scale object detection dataset with 365 object categories and 600k images, aimed at advancing object detection research.
80
+ - [**OpenImagesV7**](./open-images-v7.md): A comprehensive dataset by Google with 1.7M train images and 42k validation images.
81
+ - [**SKU-110K**](./sku-110k.md): A dataset containing images of densely packed retail products, intended for retail environment object detection.
82
+ - [**VisDrone**](./visdrone.md): A dataset focusing on drone-based images, containing various object categories like cars, pedestrians, and cyclists.
83
+ - [**VOC**](./voc.md): PASCAL VOC is a popular object detection dataset with 20 object categories including vehicles, animals, and furniture.
84
+ - [**xView**](./xview.md): A dataset containing high-resolution satellite imagery, designed for the detection of various object classes in overhead views.
85
+
86
+ ### Adding your own dataset
87
+
88
+ If you have your own dataset and would like to use it for training detection models with Ultralytics YOLO format, ensure that it follows the format specified above under "Ultralytics YOLO format". Convert your annotations to the required format and specify the paths, number of classes, and class names in the YAML configuration file.
89
+
90
+ ## Port or Convert Label Formats
91
+
92
+ ### COCO Dataset Format to YOLO Format
93
+
94
+ You can easily convert labels from the popular COCO dataset format to the YOLO format using the following code snippet:
95
+
96
+ !!! example ""
97
+
98
+ === "Python"
99
+
100
+ ```python
101
+ from ultralytics.data.converter import convert_coco
102
+
103
+ convert_coco(labels_dir='path/to/coco/annotations/')
104
+ ```
105
+
106
+ This conversion tool can be used to convert the COCO dataset or any dataset in the COCO format to the Ultralytics YOLO format.
107
+
108
+ Remember to double-check if the dataset you want to use is compatible with your model and follows the necessary format conventions. Properly formatted datasets are crucial for training successful object detection models.
yolov8-to/docs/datasets/detect/objects365.md ADDED
@@ -0,0 +1,92 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: Discover the Objects365 dataset, a wide-scale, high-quality resource for object detection research. Learn to use it with the Ultralytics YOLO model.
4
+ keywords: Objects365, object detection, Ultralytics, dataset, YOLO, bounding boxes, annotations, computer vision, deep learning, training models
5
+ ---
6
+
7
+ # Objects365 Dataset
8
+
9
+ The [Objects365](https://www.objects365.org/) dataset is a large-scale, high-quality dataset designed to foster object detection research with a focus on diverse objects in the wild. Created by a team of [Megvii](https://en.megvii.com/) researchers, the dataset offers a wide range of high-resolution images with a comprehensive set of annotated bounding boxes covering 365 object categories.
10
+
11
+ ## Key Features
12
+
13
+ - Objects365 contains 365 object categories, with 2 million images and over 30 million bounding boxes.
14
+ - The dataset includes diverse objects in various scenarios, providing a rich and challenging benchmark for object detection tasks.
15
+ - Annotations include bounding boxes for objects, making it suitable for training and evaluating object detection models.
16
+ - Objects365 pre-trained models significantly outperform ImageNet pre-trained models, leading to better generalization on various tasks.
17
+
18
+ ## Dataset Structure
19
+
20
+ The Objects365 dataset is organized into a single set of images with corresponding annotations:
21
+
22
+ - **Images**: The dataset includes 2 million high-resolution images, each containing a variety of objects across 365 categories.
23
+ - **Annotations**: The images are annotated with over 30 million bounding boxes, providing comprehensive ground truth information for object detection tasks.
24
+
25
+ ## Applications
26
+
27
+ The Objects365 dataset is widely used for training and evaluating deep learning models in object detection tasks. The dataset's diverse set of object categories and high-quality annotations make it a valuable resource for researchers and practitioners in the field of computer vision.
28
+
29
+ ## Dataset YAML
30
+
31
+ A YAML (Yet Another Markup Language) file is used to define the dataset configuration. It contains information about the dataset's paths, classes, and other relevant information. For the case of the Objects365 Dataset, the `Objects365.yaml` file is maintained at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/Objects365.yaml](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/Objects365.yaml).
32
+
33
+ !!! example "ultralytics/cfg/datasets/Objects365.yaml"
34
+
35
+ ```yaml
36
+ --8<-- "ultralytics/cfg/datasets/Objects365.yaml"
37
+ ```
38
+
39
+ ## Usage
40
+
41
+ To train a YOLOv8n model on the Objects365 dataset for 100 epochs with an image size of 640, you can use the following code snippets. For a comprehensive list of available arguments, refer to the model [Training](../../modes/train.md) page.
42
+
43
+ !!! example "Train Example"
44
+
45
+ === "Python"
46
+
47
+ ```python
48
+ from ultralytics import YOLO
49
+
50
+ # Load a model
51
+ model = YOLO('yolov8n.pt') # load a pretrained model (recommended for training)
52
+
53
+ # Train the model
54
+ results = model.train(data='Objects365.yaml', epochs=100, imgsz=640)
55
+ ```
56
+
57
+ === "CLI"
58
+
59
+ ```bash
60
+ # Start training from a pretrained *.pt model
61
+ yolo detect train data=Objects365.yaml model=yolov8n.pt epochs=100 imgsz=640
62
+ ```
63
+
64
+ ## Sample Data and Annotations
65
+
66
+ The Objects365 dataset contains a diverse set of high-resolution images with objects from 365 categories, providing rich context for object detection tasks. Here are some examples of the images in the dataset:
67
+
68
+ ![Dataset sample image](https://user-images.githubusercontent.com/26833433/238215467-caf757dd-0b87-4b0d-bb19-d94a547f7fbf.jpg)
69
+
70
+ - **Objects365**: This image demonstrates an example of object detection, where objects are annotated with bounding boxes. The dataset provides a wide range of images to facilitate the development of models for this task.
71
+
72
+ The example showcases the variety and complexity of the data in the Objects365 dataset and highlights the importance of accurate object detection for computer vision applications.
73
+
74
+ ## Citations and Acknowledgments
75
+
76
+ If you use the Objects365 dataset in your research or development work, please cite the following paper:
77
+
78
+ !!! note ""
79
+
80
+ === "BibTeX"
81
+
82
+ ```bibtex
83
+ @inproceedings{shao2019objects365,
84
+ title={Objects365: A Large-scale, High-quality Dataset for Object Detection},
85
+ author={Shao, Shuai and Li, Zeming and Zhang, Tianyuan and Peng, Chao and Yu, Gang and Li, Jing and Zhang, Xiangyu and Sun, Jian},
86
+ booktitle={Proceedings of the IEEE/CVF International Conference on Computer Vision},
87
+ pages={8425--8434},
88
+ year={2019}
89
+ }
90
+ ```
91
+
92
+ We would like to acknowledge the team of researchers who created and maintain the Objects365 dataset as a valuable resource for the computer vision research community. For more information about the Objects365 dataset and its creators, visit the [Objects365 dataset website](https://www.objects365.org/).
yolov8-to/docs/datasets/detect/open-images-v7.md ADDED
@@ -0,0 +1,110 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: Dive into Google's Open Images V7, a comprehensive dataset offering a broad scope for computer vision research. Understand its usage with deep learning models.
4
+ keywords: Open Images V7, object detection, segmentation masks, visual relationships, localized narratives, computer vision, deep learning, annotations, bounding boxes
5
+ ---
6
+
7
+ # Open Images V7 Dataset
8
+
9
+ [Open Images V7](https://storage.googleapis.com/openimages/web/index.html) is a versatile and expansive dataset championed by Google. Aimed at propelling research in the realm of computer vision, it boasts a vast collection of images annotated with a plethora of data, including image-level labels, object bounding boxes, object segmentation masks, visual relationships, and localized narratives.
10
+
11
+ ![Open Images V7 classes visual](https://user-images.githubusercontent.com/26833433/258660358-2dc07771-ec08-4d11-b24a-f66e07550050.png)
12
+
13
+ ## Key Features
14
+
15
+ - Encompasses ~9M images annotated in various ways to suit multiple computer vision tasks.
16
+ - Houses a staggering 16M bounding boxes across 600 object classes in 1.9M images. These boxes are primarily hand-drawn by experts ensuring high precision.
17
+ - Visual relationship annotations totaling 3.3M are available, detailing 1,466 unique relationship triplets, object properties, and human activities.
18
+ - V5 introduced segmentation masks for 2.8M objects across 350 classes.
19
+ - V6 introduced 675k localized narratives that amalgamate voice, text, and mouse traces highlighting described objects.
20
+ - V7 introduced 66.4M point-level labels on 1.4M images, spanning 5,827 classes.
21
+ - Encompasses 61.4M image-level labels across a diverse set of 20,638 classes.
22
+ - Provides a unified platform for image classification, object detection, relationship detection, instance segmentation, and multimodal image descriptions.
23
+
24
+ ## Dataset Structure
25
+
26
+ Open Images V7 is structured in multiple components catering to varied computer vision challenges:
27
+
28
+ - **Images**: About 9 million images, often showcasing intricate scenes with an average of 8.3 objects per image.
29
+ - **Bounding Boxes**: Over 16 million boxes that demarcate objects across 600 categories.
30
+ - **Segmentation Masks**: These detail the exact boundary of 2.8M objects across 350 classes.
31
+ - **Visual Relationships**: 3.3M annotations indicating object relationships, properties, and actions.
32
+ - **Localized Narratives**: 675k descriptions combining voice, text, and mouse traces.
33
+ - **Point-Level Labels**: 66.4M labels across 1.4M images, suitable for zero/few-shot semantic segmentation.
34
+
35
+ ## Applications
36
+
37
+ Open Images V7 is a cornerstone for training and evaluating state-of-the-art models in various computer vision tasks. The dataset's broad scope and high-quality annotations make it indispensable for researchers and developers specializing in computer vision.
38
+
39
+ ## Dataset YAML
40
+
41
+ Typically, datasets come with a YAML (Yet Another Markup Language) file that delineates the dataset's configuration. For the case of Open Images V7, a hypothetical `OpenImagesV7.yaml` might exist. For accurate paths and configurations, one should refer to the dataset's official repository or documentation.
42
+
43
+ !!! example "OpenImagesV7.yaml"
44
+
45
+ ```yaml
46
+ --8<-- "ultralytics/cfg/datasets/open-images-v7.yaml"
47
+ ```
48
+
49
+ ## Usage
50
+
51
+ To train a YOLOv8n model on the Open Images V7 dataset for 100 epochs with an image size of 640, you can use the following code snippets. For a comprehensive list of available arguments, refer to the model [Training](../../modes/train.md) page.
52
+
53
+ !!! warning
54
+
55
+ The complete Open Images V7 dataset comprises 1,743,042 training images and 41,620 validation images, requiring approximately **561 GB of storage space** upon download.
56
+
57
+ Executing the commands provided below will trigger an automatic download of the full dataset if it's not already present locally. Before running the below example it's crucial to:
58
+
59
+ - Verify that your device has enough storage capacity.
60
+ - Ensure a robust and speedy internet connection.
61
+
62
+ !!! example "Train Example"
63
+
64
+ === "Python"
65
+
66
+ ```python
67
+ from ultralytics import YOLO
68
+
69
+ # Load a COCO-pretrained YOLOv8n model
70
+ model = YOLO('yolov8n.pt')
71
+
72
+ # Train the model on the Open Images V7 dataset
73
+ results = model.train(data='open-images-v7.yaml', epochs=100, imgsz=640)
74
+ ```
75
+
76
+ === "CLI"
77
+
78
+ ```bash
79
+ # Train a COCO-pretrained YOLOv8n model on the Open Images V7 dataset
80
+ yolo detect train data=open-images-v7.yaml model=yolov8n.pt epochs=100 imgsz=640
81
+ ```
82
+
83
+ ## Sample Data and Annotations
84
+
85
+ Illustrations of the dataset help provide insights into its richness:
86
+
87
+ ![Dataset sample image](https://storage.googleapis.com/openimages/web/images/oidv7_all-in-one_example_ab.jpg)
88
+
89
+ - **Open Images V7**: This image exemplifies the depth and detail of annotations available, including bounding boxes, relationships, and segmentation masks.
90
+
91
+ Researchers can gain invaluable insights into the array of computer vision challenges that the dataset addresses, from basic object detection to intricate relationship identification.
92
+
93
+ ## Citations and Acknowledgments
94
+
95
+ For those employing Open Images V7 in their work, it's prudent to cite the relevant papers and acknowledge the creators:
96
+
97
+ !!! note ""
98
+
99
+ === "BibTeX"
100
+
101
+ ```bibtex
102
+ @article{OpenImages,
103
+ author = {Alina Kuznetsova and Hassan Rom and Neil Alldrin and Jasper Uijlings and Ivan Krasin and Jordi Pont-Tuset and Shahab Kamali and Stefan Popov and Matteo Malloci and Alexander Kolesnikov and Tom Duerig and Vittorio Ferrari},
104
+ title = {The Open Images Dataset V4: Unified image classification, object detection, and visual relationship detection at scale},
105
+ year = {2020},
106
+ journal = {IJCV}
107
+ }
108
+ ```
109
+
110
+ A heartfelt acknowledgment goes out to the Google AI team for creating and maintaining the Open Images V7 dataset. For a deep dive into the dataset and its offerings, navigate to the [official Open Images V7 website](https://storage.googleapis.com/openimages/web/index.html).
yolov8-to/docs/datasets/detect/sku-110k.md ADDED
@@ -0,0 +1,93 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: 'Explore the SKU-110k dataset: densely packed retail shelf images for object detection research. Learn how to use it with Ultralytics.'
4
+ keywords: SKU-110k dataset, object detection, retail shelf images, Ultralytics, YOLO, computer vision, deep learning models
5
+ ---
6
+
7
+ # SKU-110k Dataset
8
+
9
+ The [SKU-110k](https://github.com/eg4000/SKU110K_CVPR19) dataset is a collection of densely packed retail shelf images, designed to support research in object detection tasks. Developed by Eran Goldman et al., the dataset contains over 110,000 unique store keeping unit (SKU) categories with densely packed objects, often looking similar or even identical, positioned in close proximity.
10
+
11
+ ![Dataset sample image](https://github.com/eg4000/SKU110K_CVPR19/raw/master/figures/benchmarks_comparison.jpg)
12
+
13
+ ## Key Features
14
+
15
+ - SKU-110k contains images of store shelves from around the world, featuring densely packed objects that pose challenges for state-of-the-art object detectors.
16
+ - The dataset includes over 110,000 unique SKU categories, providing a diverse range of object appearances.
17
+ - Annotations include bounding boxes for objects and SKU category labels.
18
+
19
+ ## Dataset Structure
20
+
21
+ The SKU-110k dataset is organized into three main subsets:
22
+
23
+ 1. **Training set**: This subset contains images and annotations used for training object detection models.
24
+ 2. **Validation set**: This subset consists of images and annotations used for model validation during training.
25
+ 3. **Test set**: This subset is designed for the final evaluation of trained object detection models.
26
+
27
+ ## Applications
28
+
29
+ The SKU-110k dataset is widely used for training and evaluating deep learning models in object detection tasks, especially in densely packed scenes such as retail shelf displays. The dataset's diverse set of SKU categories and densely packed object arrangements make it a valuable resource for researchers and practitioners in the field of computer vision.
30
+
31
+ ## Dataset YAML
32
+
33
+ A YAML (Yet Another Markup Language) file is used to define the dataset configuration. It contains information about the dataset's paths, classes, and other relevant information. For the case of the SKU-110K dataset, the `SKU-110K.yaml` file is maintained at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/SKU-110K.yaml](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/SKU-110K.yaml).
34
+
35
+ !!! example "ultralytics/cfg/datasets/SKU-110K.yaml"
36
+
37
+ ```yaml
38
+ --8<-- "ultralytics/cfg/datasets/SKU-110K.yaml"
39
+ ```
40
+
41
+ ## Usage
42
+
43
+ To train a YOLOv8n model on the SKU-110K dataset for 100 epochs with an image size of 640, you can use the following code snippets. For a comprehensive list of available arguments, refer to the model [Training](../../modes/train.md) page.
44
+
45
+ !!! example "Train Example"
46
+
47
+ === "Python"
48
+
49
+ ```python
50
+ from ultralytics import YOLO
51
+
52
+ # Load a model
53
+ model = YOLO('yolov8n.pt') # load a pretrained model (recommended for training)
54
+
55
+ # Train the model
56
+ results = model.train(data='SKU-110K.yaml', epochs=100, imgsz=640)
57
+ ```
58
+
59
+ === "CLI"
60
+
61
+ ```bash
62
+ # Start training from a pretrained *.pt model
63
+ yolo detect train data=SKU-110K.yaml model=yolov8n.pt epochs=100 imgsz=640
64
+ ```
65
+
66
+ ## Sample Data and Annotations
67
+
68
+ The SKU-110k dataset contains a diverse set of retail shelf images with densely packed objects, providing rich context for object detection tasks. Here are some examples of data from the dataset, along with their corresponding annotations:
69
+
70
+ ![Dataset sample image](https://user-images.githubusercontent.com/26833433/238215979-1ab791c4-15d9-46f6-a5d6-0092c05dff7a.jpg)
71
+
72
+ - **Densely packed retail shelf image**: This image demonstrates an example of densely packed objects in a retail shelf setting. Objects are annotated with bounding boxes and SKU category labels.
73
+
74
+ The example showcases the variety and complexity of the data in the SKU-110k dataset and highlights the importance of high-quality data for object detection tasks.
75
+
76
+ ## Citations and Acknowledgments
77
+
78
+ If you use the SKU-110k dataset in your research or development work, please cite the following paper:
79
+
80
+ !!! note ""
81
+
82
+ === "BibTeX"
83
+
84
+ ```bibtex
85
+ @inproceedings{goldman2019dense,
86
+ author = {Eran Goldman and Roei Herzig and Aviv Eisenschtat and Jacob Goldberger and Tal Hassner},
87
+ title = {Precise Detection in Densely Packed Scenes},
88
+ booktitle = {Proc. Conf. Comput. Vision Pattern Recognition (CVPR)},
89
+ year = {2019}
90
+ }
91
+ ```
92
+
93
+ We would like to acknowledge Eran Goldman et al. for creating and maintaining the SKU-110k dataset as a valuable resource for the computer vision research community. For more information about the SKU-110k dataset and its creators, visit the [SKU-110k dataset GitHub repository](https://github.com/eg4000/SKU110K_CVPR19).
yolov8-to/docs/datasets/detect/visdrone.md ADDED
@@ -0,0 +1,92 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: Explore the VisDrone Dataset, a large-scale benchmark for drone-based image analysis, and learn how to train a YOLO model using it.
4
+ keywords: VisDrone Dataset, Ultralytics, drone-based image analysis, YOLO model, object detection, object tracking, crowd counting
5
+ ---
6
+
7
+ # VisDrone Dataset
8
+
9
+ The [VisDrone Dataset](https://github.com/VisDrone/VisDrone-Dataset) is a large-scale benchmark created by the AISKYEYE team at the Lab of Machine Learning and Data Mining, Tianjin University, China. It contains carefully annotated ground truth data for various computer vision tasks related to drone-based image and video analysis.
10
+
11
+ VisDrone is composed of 288 video clips with 261,908 frames and 10,209 static images, captured by various drone-mounted cameras. The dataset covers a wide range of aspects, including location (14 different cities across China), environment (urban and rural), objects (pedestrians, vehicles, bicycles, etc.), and density (sparse and crowded scenes). The dataset was collected using various drone platforms under different scenarios and weather and lighting conditions. These frames are manually annotated with over 2.6 million bounding boxes of targets such as pedestrians, cars, bicycles, and tricycles. Attributes like scene visibility, object class, and occlusion are also provided for better data utilization.
12
+
13
+ ## Dataset Structure
14
+
15
+ The VisDrone dataset is organized into five main subsets, each focusing on a specific task:
16
+
17
+ 1. **Task 1**: Object detection in images
18
+ 2. **Task 2**: Object detection in videos
19
+ 3. **Task 3**: Single-object tracking
20
+ 4. **Task 4**: Multi-object tracking
21
+ 5. **Task 5**: Crowd counting
22
+
23
+ ## Applications
24
+
25
+ The VisDrone dataset is widely used for training and evaluating deep learning models in drone-based computer vision tasks such as object detection, object tracking, and crowd counting. The dataset's diverse set of sensor data, object annotations, and attributes make it a valuable resource for researchers and practitioners in the field of drone-based computer vision.
26
+
27
+ ## Dataset YAML
28
+
29
+ A YAML (Yet Another Markup Language) file is used to define the dataset configuration. It contains information about the dataset's paths, classes, and other relevant information. In the case of the Visdrone dataset, the `VisDrone.yaml` file is maintained at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/VisDrone.yaml](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/VisDrone.yaml).
30
+
31
+ !!! example "ultralytics/cfg/datasets/VisDrone.yaml"
32
+
33
+ ```yaml
34
+ --8<-- "ultralytics/cfg/datasets/VisDrone.yaml"
35
+ ```
36
+
37
+ ## Usage
38
+
39
+ To train a YOLOv8n model on the VisDrone dataset for 100 epochs with an image size of 640, you can use the following code snippets. For a comprehensive list of available arguments, refer to the model [Training](../../modes/train.md) page.
40
+
41
+ !!! example "Train Example"
42
+
43
+ === "Python"
44
+
45
+ ```python
46
+ from ultralytics import YOLO
47
+
48
+ # Load a model
49
+ model = YOLO('yolov8n.pt') # load a pretrained model (recommended for training)
50
+
51
+ # Train the model
52
+ results = model.train(data='VisDrone.yaml', epochs=100, imgsz=640)
53
+ ```
54
+
55
+ === "CLI"
56
+
57
+ ```bash
58
+ # Start training from a pretrained *.pt model
59
+ yolo detect train data=VisDrone.yaml model=yolov8n.pt epochs=100 imgsz=640
60
+ ```
61
+
62
+ ## Sample Data and Annotations
63
+
64
+ The VisDrone dataset contains a diverse set of images and videos captured by drone-mounted cameras. Here are some examples of data from the dataset, along with their corresponding annotations:
65
+
66
+ ![Dataset sample image](https://user-images.githubusercontent.com/26833433/238217600-df0b7334-4c9e-4c77-81a5-c70cd33429cc.jpg)
67
+
68
+ - **Task 1**: Object detection in images - This image demonstrates an example of object detection in images, where objects are annotated with bounding boxes. The dataset provides a wide variety of images taken from different locations, environments, and densities to facilitate the development of models for this task.
69
+
70
+ The example showcases the variety and complexity of the data in the VisDrone dataset and highlights the importance of high-quality sensor data for drone-based computer vision tasks.
71
+
72
+ ## Citations and Acknowledgments
73
+
74
+ If you use the VisDrone dataset in your research or development work, please cite the following paper:
75
+
76
+ !!! note ""
77
+
78
+ === "BibTeX"
79
+
80
+ ```bibtex
81
+ @ARTICLE{9573394,
82
+ author={Zhu, Pengfei and Wen, Longyin and Du, Dawei and Bian, Xiao and Fan, Heng and Hu, Qinghua and Ling, Haibin},
83
+ journal={IEEE Transactions on Pattern Analysis and Machine Intelligence},
84
+ title={Detection and Tracking Meet Drones Challenge},
85
+ year={2021},
86
+ volume={},
87
+ number={},
88
+ pages={1-1},
89
+ doi={10.1109/TPAMI.2021.3119563}}
90
+ ```
91
+
92
+ We would like to acknowledge the AISKYEYE team at the Lab of Machine Learning and Data Mining, Tianjin University, China, for creating and maintaining the VisDrone dataset as a valuable resource for the drone-based computer vision research community. For more information about the VisDrone dataset and its creators, visit the [VisDrone Dataset GitHub repository](https://github.com/VisDrone/VisDrone-Dataset).
yolov8-to/docs/datasets/detect/voc.md ADDED
@@ -0,0 +1,95 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: A complete guide to the PASCAL VOC dataset used for object detection, segmentation and classification tasks with relevance to YOLO model training.
4
+ keywords: Ultralytics, PASCAL VOC dataset, object detection, segmentation, image classification, YOLO, model training, VOC.yaml, deep learning
5
+ ---
6
+
7
+ # VOC Dataset
8
+
9
+ The [PASCAL VOC](http://host.robots.ox.ac.uk/pascal/VOC/) (Visual Object Classes) dataset is a well-known object detection, segmentation, and classification dataset. It is designed to encourage research on a wide variety of object categories and is commonly used for benchmarking computer vision models. It is an essential dataset for researchers and developers working on object detection, segmentation, and classification tasks.
10
+
11
+ ## Key Features
12
+
13
+ - VOC dataset includes two main challenges: VOC2007 and VOC2012.
14
+ - The dataset comprises 20 object categories, including common objects like cars, bicycles, and animals, as well as more specific categories such as boats, sofas, and dining tables.
15
+ - Annotations include object bounding boxes and class labels for object detection and classification tasks, and segmentation masks for the segmentation tasks.
16
+ - VOC provides standardized evaluation metrics like mean Average Precision (mAP) for object detection and classification, making it suitable for comparing model performance.
17
+
18
+ ## Dataset Structure
19
+
20
+ The VOC dataset is split into three subsets:
21
+
22
+ 1. **Train**: This subset contains images for training object detection, segmentation, and classification models.
23
+ 2. **Validation**: This subset has images used for validation purposes during model training.
24
+ 3. **Test**: This subset consists of images used for testing and benchmarking the trained models. Ground truth annotations for this subset are not publicly available, and the results are submitted to the [PASCAL VOC evaluation server](http://host.robots.ox.ac.uk:8080/leaderboard/displaylb.php) for performance evaluation.
25
+
26
+ ## Applications
27
+
28
+ The VOC dataset is widely used for training and evaluating deep learning models in object detection (such as YOLO, Faster R-CNN, and SSD), instance segmentation (such as Mask R-CNN), and image classification. The dataset's diverse set of object categories, large number of annotated images, and standardized evaluation metrics make it an essential resource for computer vision researchers and practitioners.
29
+
30
+ ## Dataset YAML
31
+
32
+ A YAML (Yet Another Markup Language) file is used to define the dataset configuration. It contains information about the dataset's paths, classes, and other relevant information. In the case of the VOC dataset, the `VOC.yaml` file is maintained at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/VOC.yaml](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/VOC.yaml).
33
+
34
+ !!! example "ultralytics/cfg/datasets/VOC.yaml"
35
+
36
+ ```yaml
37
+ --8<-- "ultralytics/cfg/datasets/VOC.yaml"
38
+ ```
39
+
40
+ ## Usage
41
+
42
+ To train a YOLOv8n model on the VOC dataset for 100 epochs with an image size of 640, you can use the following code snippets. For a comprehensive list of available arguments, refer to the model [Training](../../modes/train.md) page.
43
+
44
+ !!! example "Train Example"
45
+
46
+ === "Python"
47
+
48
+ ```python
49
+ from ultralytics import YOLO
50
+
51
+ # Load a model
52
+ model = YOLO('yolov8n.pt') # load a pretrained model (recommended for training)
53
+
54
+ # Train the model
55
+ results = model.train(data='VOC.yaml', epochs=100, imgsz=640)
56
+ ```
57
+
58
+ === "CLI"
59
+
60
+ ```bash
61
+ # Start training from
62
+ a pretrained *.pt model
63
+ yolo detect train data=VOC.yaml model=yolov8n.pt epochs=100 imgsz=640
64
+ ```
65
+
66
+ ## Sample Images and Annotations
67
+
68
+ The VOC dataset contains a diverse set of images with various object categories and complex scenes. Here are some examples of images from the dataset, along with their corresponding annotations:
69
+
70
+ ![Dataset sample image](https://github.com/ultralytics/ultralytics/assets/26833433/7d4c18f4-774e-43f8-a5f3-9467cda7de4a)
71
+
72
+ - **Mosaiced Image**: This image demonstrates a training batch composed of mosaiced dataset images. Mosaicing is a technique used during training that combines multiple images into a single image to increase the variety of objects and scenes within each training batch. This helps improve the model's ability to generalize to different object sizes, aspect ratios, and contexts.
73
+
74
+ The example showcases the variety and complexity of the images in the VOC dataset and the benefits of using mosaicing during the training process.
75
+
76
+ ## Citations and Acknowledgments
77
+
78
+ If you use the VOC dataset in your research or development work, please cite the following paper:
79
+
80
+ !!! note ""
81
+
82
+ === "BibTeX"
83
+
84
+ ```bibtex
85
+ @misc{everingham2010pascal,
86
+ title={The PASCAL Visual Object Classes (VOC) Challenge},
87
+ author={Mark Everingham and Luc Van Gool and Christopher K. I. Williams and John Winn and Andrew Zisserman},
88
+ year={2010},
89
+ eprint={0909.5206},
90
+ archivePrefix={arXiv},
91
+ primaryClass={cs.CV}
92
+ }
93
+ ```
94
+
95
+ We would like to acknowledge the PASCAL VOC Consortium for creating and maintaining this valuable resource for the computer vision community. For more information about the VOC dataset and its creators, visit the [PASCAL VOC dataset website](http://host.robots.ox.ac.uk/pascal/VOC/).
yolov8-to/docs/datasets/detect/xview.md ADDED
@@ -0,0 +1,97 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: Explore xView, a large-scale, high resolution satellite imagery dataset for object detection. Dive into dataset structure, usage examples & its potential applications.
4
+ keywords: Ultralytics, YOLO, computer vision, xView dataset, satellite imagery, object detection, overhead imagery, training, deep learning, dataset YAML
5
+ ---
6
+
7
+ # xView Dataset
8
+
9
+ The [xView](http://xviewdataset.org/) dataset is one of the largest publicly available datasets of overhead imagery, containing images from complex scenes around the world annotated using bounding boxes. The goal of the xView dataset is to accelerate progress in four computer vision frontiers:
10
+
11
+ 1. Reduce minimum resolution for detection.
12
+ 2. Improve learning efficiency.
13
+ 3. Enable discovery of more object classes.
14
+ 4. Improve detection of fine-grained classes.
15
+
16
+ xView builds on the success of challenges like Common Objects in Context (COCO) and aims to leverage computer vision to analyze the growing amount of available imagery from space in order to understand the visual world in new ways and address a range of important applications.
17
+
18
+ ## Key Features
19
+
20
+ - xView contains over 1 million object instances across 60 classes.
21
+ - The dataset has a resolution of 0.3 meters, providing higher resolution imagery than most public satellite imagery datasets.
22
+ - xView features a diverse collection of small, rare, fine-grained, and multi-type objects with bounding box annotation.
23
+ - Comes with a pre-trained baseline model using the TensorFlow object detection API and an example for PyTorch.
24
+
25
+ ## Dataset Structure
26
+
27
+ The xView dataset is composed of satellite images collected from WorldView-3 satellites at a 0.3m ground sample distance. It contains over 1 million objects across 60 classes in over 1,400 km² of imagery.
28
+
29
+ ## Applications
30
+
31
+ The xView dataset is widely used for training and evaluating deep learning models for object detection in overhead imagery. The dataset's diverse set of object classes and high-resolution imagery make it a valuable resource for researchers and practitioners in the field of computer vision, especially for satellite imagery analysis.
32
+
33
+ ## Dataset YAML
34
+
35
+ A YAML (Yet Another Markup Language) file is used to define the dataset configuration. It contains information about the dataset's paths, classes, and other relevant information. In the case of the xView dataset, the `xView.yaml` file is maintained at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/xView.yaml](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/xView.yaml).
36
+
37
+ !!! example "ultralytics/cfg/datasets/xView.yaml"
38
+
39
+ ```yaml
40
+ --8<-- "ultralytics/cfg/datasets/xView.yaml"
41
+ ```
42
+
43
+ ## Usage
44
+
45
+ To train a model on the xView dataset for 100 epochs with an image size of 640, you can use the following code snippets. For a comprehensive list of available arguments, refer to the model [Training](../../modes/train.md) page.
46
+
47
+ !!! example "Train Example"
48
+
49
+ === "Python"
50
+
51
+ ```python
52
+ from ultralytics import YOLO
53
+
54
+ # Load a model
55
+ model = YOLO('yolov8n.pt') # load a pretrained model (recommended for training)
56
+
57
+ # Train the model
58
+ results = model.train(data='xView.yaml', epochs=100, imgsz=640)
59
+ ```
60
+
61
+ === "CLI"
62
+
63
+ ```bash
64
+ # Start training from a pretrained *.pt model
65
+ yolo detect train data=xView.yaml model=yolov8n.pt epochs=100 imgsz=640
66
+ ```
67
+
68
+ ## Sample Data and Annotations
69
+
70
+ The xView dataset contains high-resolution satellite images with a diverse set of objects annotated using bounding boxes. Here are some examples of data from the dataset, along with their corresponding annotations:
71
+
72
+ ![Dataset sample image](https://github-production-user-asset-6210df.s3.amazonaws.com/26833433/238799379-bb3b02f0-dee4-4e67-80ae-4b2378b813ad.jpg)
73
+
74
+ - **Overhead Imagery**: This image demonstrates an example of object detection in overhead imagery, where objects are annotated with bounding boxes. The dataset provides high-resolution satellite images to facilitate the development of models for this task.
75
+
76
+ The example showcases the variety and complexity of the data in the xView dataset and highlights the importance of high-quality satellite imagery for object detection tasks.
77
+
78
+ ## Citations and Acknowledgments
79
+
80
+ If you use the xView dataset in your research or development work, please cite the following paper:
81
+
82
+ !!! note ""
83
+
84
+ === "BibTeX"
85
+
86
+ ```bibtex
87
+ @misc{lam2018xview,
88
+ title={xView: Objects in Context in Overhead Imagery},
89
+ author={Darius Lam and Richard Kuzma and Kevin McGee and Samuel Dooley and Michael Laielli and Matthew Klaric and Yaroslav Bulatov and Brendan McCord},
90
+ year={2018},
91
+ eprint={1802.07856},
92
+ archivePrefix={arXiv},
93
+ primaryClass={cs.CV}
94
+ }
95
+ ```
96
+
97
+ We would like to acknowledge the [Defense Innovation Unit](https://www.diu.mil/) (DIU) and the creators of the xView dataset for their valuable contribution to the computer vision research community. For more information about the xView dataset and its creators, visit the [xView dataset website](http://xviewdataset.org/).
yolov8-to/docs/datasets/index.md ADDED
@@ -0,0 +1,66 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: Explore various computer vision datasets supported by Ultralytics for object detection, segmentation, pose estimation, image classification, and multi-object tracking.
4
+ keywords: computer vision, datasets, Ultralytics, YOLO, object detection, instance segmentation, pose estimation, image classification, multi-object tracking
5
+ ---
6
+
7
+ # Datasets Overview
8
+
9
+ Ultralytics provides support for various datasets to facilitate computer vision tasks such as detection, instance segmentation, pose estimation, classification, and multi-object tracking. Below is a list of the main Ultralytics datasets, followed by a summary of each computer vision task and the respective datasets.
10
+
11
+ ## [Detection Datasets](detect/index.md)
12
+
13
+ Bounding box object detection is a computer vision technique that involves detecting and localizing objects in an image by drawing a bounding box around each object.
14
+
15
+ - [Argoverse](detect/argoverse.md): A dataset containing 3D tracking and motion forecasting data from urban environments with rich annotations.
16
+ - [COCO](detect/coco.md): A large-scale dataset designed for object detection, segmentation, and captioning with over 200K labeled images.
17
+ - [COCO8](detect/coco8.md): Contains the first 4 images from COCO train and COCO val, suitable for quick tests.
18
+ - [Global Wheat 2020](detect/globalwheat2020.md): A dataset of wheat head images collected from around the world for object detection and localization tasks.
19
+ - [Objects365](detect/objects365.md): A high-quality, large-scale dataset for object detection with 365 object categories and over 600K annotated images.
20
+ - [OpenImagesV7](detect/open-images-v7.md): A comprehensive dataset by Google with 1.7M train images and 42k validation images.
21
+ - [SKU-110K](detect/sku-110k.md): A dataset featuring dense object detection in retail environments with over 11K images and 1.7 million bounding boxes.
22
+ - [VisDrone](detect/visdrone.md): A dataset containing object detection and multi-object tracking data from drone-captured imagery with over 10K images and video sequences.
23
+ - [VOC](detect/voc.md): The Pascal Visual Object Classes (VOC) dataset for object detection and segmentation with 20 object classes and over 11K images.
24
+ - [xView](detect/xview.md): A dataset for object detection in overhead imagery with 60 object categories and over 1 million annotated objects.
25
+
26
+ ## [Instance Segmentation Datasets](segment/index.md)
27
+
28
+ Instance segmentation is a computer vision technique that involves identifying and localizing objects in an image at the pixel level.
29
+
30
+ - [COCO](segment/coco.md): A large-scale dataset designed for object detection, segmentation, and captioning tasks with over 200K labeled images.
31
+ - [COCO8-seg](segment/coco8-seg.md): A smaller dataset for instance segmentation tasks, containing a subset of 8 COCO images with segmentation annotations.
32
+
33
+ ## [Pose Estimation](pose/index.md)
34
+
35
+ Pose estimation is a technique used to determine the pose of the object relative to the camera or the world coordinate system.
36
+
37
+ - [COCO](pose/coco.md): A large-scale dataset with human pose annotations designed for pose estimation tasks.
38
+ - [COCO8-pose](pose/coco8-pose.md): A smaller dataset for pose estimation tasks, containing a subset of 8 COCO images with human pose annotations.
39
+
40
+ ## [Classification](classify/index.md)
41
+
42
+ Image classification is a computer vision task that involves categorizing an image into one or more predefined classes or categories based on its visual content.
43
+
44
+ - [Caltech 101](classify/caltech101.md): A dataset containing images of 101 object categories for image classification tasks.
45
+ - [Caltech 256](classify/caltech256.md): An extended version of Caltech 101 with 256 object categories and more challenging images.
46
+ - [CIFAR-10](classify/cifar10.md): A dataset of 60K 32x32 color images in 10 classes, with 6K images per class.
47
+ - [CIFAR-100](classify/cifar100.md): An extended version of CIFAR-10 with 100 object categories and 600 images per class.
48
+ - [Fashion-MNIST](classify/fashion-mnist.md): A dataset consisting of 70,000 grayscale images of 10 fashion categories for image classification tasks.
49
+ - [ImageNet](classify/imagenet.md): A large-scale dataset for object detection and image classification with over 14 million images and 20,000 categories.
50
+ - [ImageNet-10](classify/imagenet10.md): A smaller subset of ImageNet with 10 categories for faster experimentation and testing.
51
+ - [Imagenette](classify/imagenette.md): A smaller subset of ImageNet that contains 10 easily distinguishable classes for quicker training and testing.
52
+ - [Imagewoof](classify/imagewoof.md): A more challenging subset of ImageNet containing 10 dog breed categories for image classification tasks.
53
+ - [MNIST](classify/mnist.md): A dataset of 70,000 grayscale images of handwritten digits for image classification tasks.
54
+
55
+ ## [Oriented Bounding Boxes (OBB)](obb/index.md)
56
+
57
+ Oriented Bounding Boxes (OBB) is a method in computer vision for detecting angled objects in images using rotated bounding boxes, often applied to aerial and satellite imagery.
58
+
59
+ - [DOTAv2](obb/dota-v2.md): A popular OBB aerial imagery dataset with 1.7 million instances and 11,268 images.
60
+
61
+ ## [Multi-Object Tracking](track/index.md)
62
+
63
+ Multi-object tracking is a computer vision technique that involves detecting and tracking multiple objects over time in a video sequence.
64
+
65
+ - [Argoverse](detect/argoverse.md): A dataset containing 3D tracking and motion forecasting data from urban environments with rich annotations for multi-object tracking tasks.
66
+ - [VisDrone](detect/visdrone.md): A dataset containing object detection and multi-object tracking data from drone-captured imagery with over 10K images and video sequences.
yolov8-to/docs/datasets/obb/dota-v2.md ADDED
@@ -0,0 +1,129 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: Delve into DOTA v2, an Oriented Bounding Box (OBB) aerial imagery dataset with 1.7 million instances and 11,268 images.
4
+ keywords: DOTA v2, object detection, aerial images, computer vision, deep learning, annotations, oriented bounding boxes, OBB
5
+ ---
6
+
7
+ # DOTA v2 Dataset with OBB
8
+
9
+ [DOTA v2](https://captain-whu.github.io/DOTA/index.html) stands as a specialized dataset, emphasizing object detection in aerial images. Originating from the DOTA series of datasets, it offers annotated images capturing a diverse array of aerial scenes with Oriented Bounding Boxes (OBB).
10
+
11
+ ![DOTA v2 classes visual](https://user-images.githubusercontent.com/26833433/259461765-72fdd0d8-266b-44a9-8199-199329bf5ca9.jpg)
12
+
13
+ ## Key Features
14
+
15
+ - Collection from various sensors and platforms, with image sizes ranging from 800 × 800 to 20,000 × 20,000 pixels.
16
+ - Features more than 1.7M Oriented Bounding Boxes across 18 categories.
17
+ - Encompasses multiscale object detection.
18
+ - Instances are annotated by experts using arbitrary (8 d.o.f.) quadrilateral, capturing objects of different scales, orientations, and shapes.
19
+
20
+ ## Dataset Versions
21
+
22
+ ### DOTA-v1.0
23
+
24
+ - Contains 15 common categories.
25
+ - Comprises 2,806 images with 188,282 instances.
26
+ - Split ratios: 1/2 for training, 1/6 for validation, and 1/3 for testing.
27
+
28
+ ### DOTA-v1.5
29
+
30
+ - Incorporates the same images as DOTA-v1.0.
31
+ - Very small instances (less than 10 pixels) are also annotated.
32
+ - Addition of a new category: "container crane".
33
+ - A total of 403,318 instances.
34
+ - Released for the DOAI Challenge 2019 on Object Detection in Aerial Images.
35
+
36
+ ### DOTA-v2.0
37
+
38
+ - Collections from Google Earth, GF-2 Satellite, and other aerial images.
39
+ - Contains 18 common categories.
40
+ - Comprises 11,268 images with a whopping 1,793,658 instances.
41
+ - New categories introduced: "airport" and "helipad".
42
+ - Image splits:
43
+ - Training: 1,830 images with 268,627 instances.
44
+ - Validation: 593 images with 81,048 instances.
45
+ - Test-dev: 2,792 images with 353,346 instances.
46
+ - Test-challenge: 6,053 images with 1,090,637 instances.
47
+
48
+ ## Dataset Structure
49
+
50
+ DOTA v2 exhibits a structured layout tailored for OBB object detection challenges:
51
+
52
+ - **Images**: A vast collection of high-resolution aerial images capturing diverse terrains and structures.
53
+ - **Oriented Bounding Boxes**: Annotations in the form of rotated rectangles encapsulating objects irrespective of their orientation, ideal for capturing objects like airplanes, ships, and buildings.
54
+
55
+ ## Applications
56
+
57
+ DOTA v2 serves as a benchmark for training and evaluating models specifically tailored for aerial image analysis. With the inclusion of OBB annotations, it provides a unique challenge, enabling the development of specialized object detection models that cater to aerial imagery's nuances.
58
+
59
+ ## Dataset YAML
60
+
61
+ Typically, datasets incorporate a YAML (Yet Another Markup Language) file detailing the dataset's configuration. For DOTA v2, a hypothetical `DOTAv2.yaml` could be used. For accurate paths and configurations, it's vital to consult the dataset's official repository or documentation.
62
+
63
+ !!! example "DOTAv2.yaml"
64
+
65
+ ```yaml
66
+ --8<-- "ultralytics/cfg/datasets/DOTAv2.yaml"
67
+ ```
68
+
69
+ ## Usage
70
+
71
+ To train a model on the DOTA v2 dataset, you can utilize the following code snippets. Always refer to your model's documentation for a thorough list of available arguments.
72
+
73
+ !!! warning
74
+
75
+ Please note that all images and associated annotations in the DOTAv2 dataset can be used for academic purposes, but commercial use is prohibited. Your understanding and respect for the dataset creators' wishes are greatly appreciated!
76
+
77
+ !!! example "Train Example"
78
+
79
+ === "Python"
80
+
81
+ ```python
82
+ from ultralytics import YOLO
83
+
84
+ # Create a new YOLOv8n-OBB model from scratch
85
+ model = YOLO('yolov8n-obb.yaml')
86
+
87
+ # Train the model on the DOTAv2 dataset
88
+ results = model.train(data='DOTAv2.yaml', epochs=100, imgsz=640)
89
+ ```
90
+
91
+ === "CLI"
92
+
93
+ ```bash
94
+ # Train a new YOLOv8n-OBB model on the DOTAv2 dataset
95
+ yolo detect train data=DOTAv2.yaml model=yolov8n.pt epochs=100 imgsz=640
96
+ ```
97
+
98
+ ## Sample Data and Annotations
99
+
100
+ Having a glance at the dataset illustrates its depth:
101
+
102
+ ![Dataset sample image](https://captain-whu.github.io/DOTA/images/instances-DOTA.jpg)
103
+
104
+ - **DOTA v2**: This snapshot underlines the complexity of aerial scenes and the significance of Oriented Bounding Box annotations, capturing objects in their natural orientation.
105
+
106
+ The dataset's richness offers invaluable insights into object detection challenges exclusive to aerial imagery.
107
+
108
+ ## Citations and Acknowledgments
109
+
110
+ For those leveraging DOTA v2 in their endeavors, it's pertinent to cite the relevant research papers:
111
+
112
+ !!! note ""
113
+
114
+ === "BibTeX"
115
+
116
+ ```bibtex
117
+ @article{9560031,
118
+ author={Ding, Jian and Xue, Nan and Xia, Gui-Song and Bai, Xiang and Yang, Wen and Yang, Michael and Belongie, Serge and Luo, Jiebo and Datcu, Mihai and Pelillo, Marcello and Zhang, Liangpei},
119
+ journal={IEEE Transactions on Pattern Analysis and Machine Intelligence},
120
+ title={Object Detection in Aerial Images: A Large-Scale Benchmark and Challenges},
121
+ year={2021},
122
+ volume={},
123
+ number={},
124
+ pages={1-1},
125
+ doi={10.1109/TPAMI.2021.3117983}
126
+ }
127
+ ```
128
+
129
+ A special note of gratitude to the team behind DOTA v2 for their commendable effort in curating this dataset. For an exhaustive understanding of the dataset and its nuances, please visit the [official DOTA v2 website](https://captain-whu.github.io/DOTA/index.html).
yolov8-to/docs/datasets/obb/index.md ADDED
@@ -0,0 +1,84 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: Dive deep into various oriented bounding box (OBB) dataset formats compatible with Ultralytics YOLO models. Grasp the nuances of using and converting datasets to this format.
4
+ keywords: Ultralytics, YOLO, oriented bounding boxes, OBB, dataset formats, label formats, DOTA v2, data conversion
5
+ ---
6
+
7
+ # Oriented Bounding Box (OBB) Datasets Overview
8
+
9
+ Training a precise object detection model with oriented bounding boxes (OBB) requires a thorough dataset. This guide explains the various OBB dataset formats compatible with Ultralytics YOLO models, offering insights into their structure, application, and methods for format conversions.
10
+
11
+ ## Supported OBB Dataset Formats
12
+
13
+ ### YOLO OBB Format
14
+
15
+ The YOLO OBB format designates bounding boxes by their four corner points with coordinates normalized between 0 and 1. It follows this format:
16
+
17
+ ```bash
18
+ class_index, x1, y1, x2, y2, x3, y3, x4, y4
19
+ ```
20
+
21
+ Internally, YOLO processes losses and outputs in the `xywhr` format, which represents the bounding box's center point (xy), width, height, and rotation.
22
+
23
+ <p align="center"><img width="800" src="https://user-images.githubusercontent.com/26833433/259471881-59020fe2-09a4-4dcc-acce-9b0f7cfa40ee.png"></p>
24
+
25
+ An example of a `*.txt` label file for the above image, which contains an object of class `0` in OBB format, could look like:
26
+
27
+ ```bash
28
+ 0 0.780811 0.743961 0.782371 0.74686 0.777691 0.752174 0.776131 0.749758
29
+ ```
30
+
31
+ ## Usage
32
+
33
+ To train a model using these OBB formats:
34
+
35
+ !!! example ""
36
+
37
+ === "Python"
38
+
39
+ ```python
40
+ from ultralytics import YOLO
41
+
42
+ # Create a new YOLOv8n-OBB model from scratch
43
+ model = YOLO('yolov8n-obb.yaml')
44
+
45
+ # Train the model on the DOTAv2 dataset
46
+ results = model.train(data='DOTAv2.yaml', epochs=100, imgsz=640)
47
+ ```
48
+
49
+ === "CLI"
50
+
51
+ ```bash
52
+ # Train a new YOLOv8n-OBB model on the DOTAv2 dataset
53
+ yolo detect train data=DOTAv2.yaml model=yolov8n.pt epochs=100 imgsz=640
54
+ ```
55
+
56
+ ## Supported Datasets
57
+
58
+ Currently, the following datasets with Oriented Bounding Boxes are supported:
59
+
60
+ - [**DOTA v2**](./dota-v2.md): DOTA (A Large-scale Dataset for Object Detection in Aerial Images) version 2, emphasizes detection from aerial perspectives and contains oriented bounding boxes with 1.7 million instances and 11,268 images.
61
+
62
+ ### Incorporating your own OBB dataset
63
+
64
+ For those looking to introduce their own datasets with oriented bounding boxes, ensure compatibility with the "YOLO OBB format" mentioned above. Convert your annotations to this required format and detail the paths, classes, and class names in a corresponding YAML configuration file.
65
+
66
+ ## Convert Label Formats
67
+
68
+ ### DOTA Dataset Format to YOLO OBB Format
69
+
70
+ Transitioning labels from the DOTA dataset format to the YOLO OBB format can be achieved with this script:
71
+
72
+ !!! example ""
73
+
74
+ === "Python"
75
+
76
+ ```python
77
+ from ultralytics.data.converter import convert_dota_to_yolo_obb
78
+
79
+ convert_dota_to_yolo_obb('path/to/DOTA')
80
+ ```
81
+
82
+ This conversion mechanism is instrumental for datasets in the DOTA format, ensuring alignment with the Ultralytics YOLO OBB format.
83
+
84
+ It's imperative to validate the compatibility of the dataset with your model and adhere to the necessary format conventions. Properly structured datasets are pivotal for training efficient object detection models with oriented bounding boxes.
yolov8-to/docs/datasets/pose/coco.md ADDED
@@ -0,0 +1,95 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: Detailed guide on the special COCO-Pose Dataset in Ultralytics. Learn about its key features, structure, and usage in pose estimation tasks with YOLO.
4
+ keywords: Ultralytics YOLO, COCO-Pose Dataset, Deep Learning, Pose Estimation, Training Models, Dataset YAML, openpose, YOLO
5
+ ---
6
+
7
+ # COCO-Pose Dataset
8
+
9
+ The [COCO-Pose](https://cocodataset.org/#keypoints-2017) dataset is a specialized version of the COCO (Common Objects in Context) dataset, designed for pose estimation tasks. It leverages the COCO Keypoints 2017 images and labels to enable the training of models like YOLO for pose estimation tasks.
10
+
11
+ ![Pose sample image](https://user-images.githubusercontent.com/26833433/239691398-d62692dc-713e-4207-9908-2f6710050e5c.jpg)
12
+
13
+ ## Key Features
14
+
15
+ - COCO-Pose builds upon the COCO Keypoints 2017 dataset which contains 200K images labeled with keypoints for pose estimation tasks.
16
+ - The dataset supports 17 keypoints for human figures, facilitating detailed pose estimation.
17
+ - Like COCO, it provides standardized evaluation metrics, including Object Keypoint Similarity (OKS) for pose estimation tasks, making it suitable for comparing model performance.
18
+
19
+ ## Dataset Structure
20
+
21
+ The COCO-Pose dataset is split into three subsets:
22
+
23
+ 1. **Train2017**: This subset contains a portion of the 118K images from the COCO dataset, annotated for training pose estimation models.
24
+ 2. **Val2017**: This subset has a selection of images used for validation purposes during model training.
25
+ 3. **Test2017**: This subset consists of images used for testing and benchmarking the trained models. Ground truth annotations for this subset are not publicly available, and the results are submitted to the [COCO evaluation server](https://codalab.lisn.upsaclay.fr/competitions/7384) for performance evaluation.
26
+
27
+ ## Applications
28
+
29
+ The COCO-Pose dataset is specifically used for training and evaluating deep learning models in keypoint detection and pose estimation tasks, such as OpenPose. The dataset's large number of annotated images and standardized evaluation metrics make it an essential resource for computer vision researchers and practitioners focused on pose estimation.
30
+
31
+ ## Dataset YAML
32
+
33
+ A YAML (Yet Another Markup Language) file is used to define the dataset configuration. It contains information about the dataset's paths, classes, and other relevant information. In the case of the COCO-Pose dataset, the `coco-pose.yaml` file is maintained at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/coco-pose.yaml](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/coco-pose.yaml).
34
+
35
+ !!! example "ultralytics/cfg/datasets/coco-pose.yaml"
36
+
37
+ ```yaml
38
+ --8<-- "ultralytics/cfg/datasets/coco-pose.yaml"
39
+ ```
40
+
41
+ ## Usage
42
+
43
+ To train a YOLOv8n-pose model on the COCO-Pose dataset for 100 epochs with an image size of 640, you can use the following code snippets. For a comprehensive list of available arguments, refer to the model [Training](../../modes/train.md) page.
44
+
45
+ !!! example "Train Example"
46
+
47
+ === "Python"
48
+
49
+ ```python
50
+ from ultralytics import YOLO
51
+
52
+ # Load a model
53
+ model = YOLO('yolov8n-pose.pt') # load a pretrained model (recommended for training)
54
+
55
+ # Train the model
56
+ results = model.train(data='coco-pose.yaml', epochs=100, imgsz=640)
57
+ ```
58
+
59
+ === "CLI"
60
+
61
+ ```bash
62
+ # Start training from a pretrained *.pt model
63
+ yolo detect train data=coco-pose.yaml model=yolov8n.pt epochs=100 imgsz=640
64
+ ```
65
+
66
+ ## Sample Images and Annotations
67
+
68
+ The COCO-Pose dataset contains a diverse set of images with human figures annotated with keypoints. Here are some examples of images from the dataset, along with their corresponding annotations:
69
+
70
+ ![Dataset sample image](https://user-images.githubusercontent.com/26833433/239690150-a9dc0bd0-7ad9-4b78-a30f-189ed727ea0e.jpg)
71
+
72
+ - **Mosaiced Image**: This image demonstrates a training batch composed of mosaiced dataset images. Mosaicing is a technique used during training that combines multiple images into a single image to increase the variety of objects and scenes within each training batch. This helps improve the model's ability to generalize to different object sizes, aspect ratios, and contexts.
73
+
74
+ The example showcases the variety and complexity of the images in the COCO-Pose dataset and the benefits of using mosaicing during the training process.
75
+
76
+ ## Citations and Acknowledgments
77
+
78
+ If you use the COCO-Pose dataset in your research or development work, please cite the following paper:
79
+
80
+ !!! note ""
81
+
82
+ === "BibTeX"
83
+
84
+ ```bibtex
85
+ @misc{lin2015microsoft,
86
+ title={Microsoft COCO: Common Objects in Context},
87
+ author={Tsung-Yi Lin and Michael Maire and Serge Belongie and Lubomir Bourdev and Ross Girshick and James Hays and Pietro Perona and Deva Ramanan and C. Lawrence Zitnick and Piotr Dollár},
88
+ year={2015},
89
+ eprint={1405.0312},
90
+ archivePrefix={arXiv},
91
+ primaryClass={cs.CV}
92
+ }
93
+ ```
94
+
95
+ We would like to acknowledge the COCO Consortium for creating and maintaining this valuable resource for the computer vision community. For more information about the COCO-Pose dataset and its creators, visit the [COCO dataset website](https://cocodataset.org/#home).
yolov8-to/docs/datasets/pose/coco8-pose.md ADDED
@@ -0,0 +1,84 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: Discover the versatile COCO8-Pose dataset, perfect for testing and debugging pose detection models. Learn how to get started with YOLOv8-pose model training.
4
+ keywords: Ultralytics, YOLOv8, pose detection, COCO8-Pose dataset, dataset, model training, YAML
5
+ ---
6
+
7
+ # COCO8-Pose Dataset
8
+
9
+ ## Introduction
10
+
11
+ [Ultralytics](https://ultralytics.com) COCO8-Pose is a small, but versatile pose detection dataset composed of the first
12
+ 8 images of the COCO train 2017 set, 4 for training and 4 for validation. This dataset is ideal for testing and
13
+ debugging object detection models, or for experimenting with new detection approaches. With 8 images, it is small enough
14
+ to be easily manageable, yet diverse enough to test training pipelines for errors and act as a sanity check before
15
+ training larger datasets.
16
+
17
+ This dataset is intended for use with Ultralytics [HUB](https://hub.ultralytics.com)
18
+ and [YOLOv8](https://github.com/ultralytics/ultralytics).
19
+
20
+ ## Dataset YAML
21
+
22
+ A YAML (Yet Another Markup Language) file is used to define the dataset configuration. It contains information about the dataset's paths, classes, and other relevant information. In the case of the COCO8-Pose dataset, the `coco8-pose.yaml` file is maintained at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/coco8-pose.yaml](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/coco8-pose.yaml).
23
+
24
+ !!! example "ultralytics/cfg/datasets/coco8-pose.yaml"
25
+
26
+ ```yaml
27
+ --8<-- "ultralytics/cfg/datasets/coco8-pose.yaml"
28
+ ```
29
+
30
+ ## Usage
31
+
32
+ To train a YOLOv8n-pose model on the COCO8-Pose dataset for 100 epochs with an image size of 640, you can use the following code snippets. For a comprehensive list of available arguments, refer to the model [Training](../../modes/train.md) page.
33
+
34
+ !!! example "Train Example"
35
+
36
+ === "Python"
37
+
38
+ ```python
39
+ from ultralytics import YOLO
40
+
41
+ # Load a model
42
+ model = YOLO('yolov8n-pose.pt') # load a pretrained model (recommended for training)
43
+
44
+ # Train the model
45
+ results = model.train(data='coco8-pose.yaml', epochs=100, imgsz=640)
46
+ ```
47
+
48
+ === "CLI"
49
+
50
+ ```bash
51
+ # Start training from a pretrained *.pt model
52
+ yolo detect train data=coco8-pose.yaml model=yolov8n.pt epochs=100 imgsz=640
53
+ ```
54
+
55
+ ## Sample Images and Annotations
56
+
57
+ Here are some examples of images from the COCO8-Pose dataset, along with their corresponding annotations:
58
+
59
+ <img src="https://user-images.githubusercontent.com/26833433/236818283-52eecb96-fc6a-420d-8a26-d488b352dd4c.jpg" alt="Dataset sample image" width="800">
60
+
61
+ - **Mosaiced Image**: This image demonstrates a training batch composed of mosaiced dataset images. Mosaicing is a technique used during training that combines multiple images into a single image to increase the variety of objects and scenes within each training batch. This helps improve the model's ability to generalize to different object sizes, aspect ratios, and contexts.
62
+
63
+ The example showcases the variety and complexity of the images in the COCO8-Pose dataset and the benefits of using mosaicing during the training process.
64
+
65
+ ## Citations and Acknowledgments
66
+
67
+ If you use the COCO dataset in your research or development work, please cite the following paper:
68
+
69
+ !!! note ""
70
+
71
+ === "BibTeX"
72
+
73
+ ```bibtex
74
+ @misc{lin2015microsoft,
75
+ title={Microsoft COCO: Common Objects in Context},
76
+ author={Tsung-Yi Lin and Michael Maire and Serge Belongie and Lubomir Bourdev and Ross Girshick and James Hays and Pietro Perona and Deva Ramanan and C. Lawrence Zitnick and Piotr Dollár},
77
+ year={2015},
78
+ eprint={1405.0312},
79
+ archivePrefix={arXiv},
80
+ primaryClass={cs.CV}
81
+ }
82
+ ```
83
+
84
+ We would like to acknowledge the COCO Consortium for creating and maintaining this valuable resource for the computer vision community. For more information about the COCO dataset and its creators, visit the [COCO dataset website](https://cocodataset.org/#home).
yolov8-to/docs/datasets/pose/index.md ADDED
@@ -0,0 +1,130 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: Understand the YOLO pose dataset format and learn to use Ultralytics datasets to train your pose estimation models effectively.
4
+ keywords: Ultralytics, YOLO, pose estimation, datasets, training, YAML, keypoints, COCO-Pose, COCO8-Pose, data conversion
5
+ ---
6
+
7
+ # Pose Estimation Datasets Overview
8
+
9
+ ## Supported Dataset Formats
10
+
11
+ ### Ultralytics YOLO format
12
+
13
+ The dataset label format used for training YOLO pose models is as follows:
14
+
15
+ 1. One text file per image: Each image in the dataset has a corresponding text file with the same name as the image file and the ".txt" extension.
16
+ 2. One row per object: Each row in the text file corresponds to one object instance in the image.
17
+ 3. Object information per row: Each row contains the following information about the object instance:
18
+ - Object class index: An integer representing the class of the object (e.g., 0 for person, 1 for car, etc.).
19
+ - Object center coordinates: The x and y coordinates of the center of the object, normalized to be between 0 and 1.
20
+ - Object width and height: The width and height of the object, normalized to be between 0 and 1.
21
+ - Object keypoint coordinates: The keypoints of the object, normalized to be between 0 and 1.
22
+
23
+ Here is an example of the label format for pose estimation task:
24
+
25
+ Format with Dim = 2
26
+
27
+ ```
28
+ <class-index> <x> <y> <width> <height> <px1> <py1> <px2> <py2> ... <pxn> <pyn>
29
+ ```
30
+
31
+ Format with Dim = 3
32
+
33
+ ```
34
+ <class-index> <x> <y> <width> <height> <px1> <py1> <p1-visibility> <px2> <py2> <p2-visibility> <pxn> <pyn> <p2-visibility>
35
+ ```
36
+
37
+ In this format, `<class-index>` is the index of the class for the object,`<x> <y> <width> <height>` are coordinates of boudning box, and `<px1> <py1> <px2> <py2> ... <pxn> <pyn>` are the pixel coordinates of the keypoints. The coordinates are separated by spaces.
38
+
39
+ ### Dataset YAML format
40
+
41
+ The Ultralytics framework uses a YAML file format to define the dataset and model configuration for training Detection Models. Here is an example of the YAML format used for defining a detection dataset:
42
+
43
+ ```yaml
44
+ # Train/val/test sets as 1) dir: path/to/imgs, 2) file: path/to/imgs.txt, or 3) list: [path/to/imgs1, path/to/imgs2, ..]
45
+ path: ../datasets/coco8-pose # dataset root dir
46
+ train: images/train # train images (relative to 'path') 4 images
47
+ val: images/val # val images (relative to 'path') 4 images
48
+ test: # test images (optional)
49
+
50
+ # Keypoints
51
+ kpt_shape: [17, 3] # number of keypoints, number of dims (2 for x,y or 3 for x,y,visible)
52
+ flip_idx: [0, 2, 1, 4, 3, 6, 5, 8, 7, 10, 9, 12, 11, 14, 13, 16, 15]
53
+
54
+ # Classes dictionary
55
+ names:
56
+ 0: person
57
+ ```
58
+
59
+ The `train` and `val` fields specify the paths to the directories containing the training and validation images, respectively.
60
+
61
+ `names` is a dictionary of class names. The order of the names should match the order of the object class indices in the YOLO dataset files.
62
+
63
+ (Optional) if the points are symmetric then need flip_idx, like left-right side of human or face.
64
+ For example if we assume five keypoints of facial landmark: [left eye, right eye, nose, left mouth, right mouth], and the original index is [0, 1, 2, 3, 4], then flip_idx is [1, 0, 2, 4, 3] (just exchange the left-right index, i.e 0-1 and 3-4, and do not modify others like nose in this example).
65
+
66
+ ## Usage
67
+
68
+ !!! example ""
69
+
70
+ === "Python"
71
+
72
+ ```python
73
+ from ultralytics import YOLO
74
+
75
+ # Load a model
76
+ model = YOLO('yolov8n-pose.pt') # load a pretrained model (recommended for training)
77
+
78
+ # Train the model
79
+ results = model.train(data='coco128-pose.yaml', epochs=100, imgsz=640)
80
+ ```
81
+ === "CLI"
82
+
83
+ ```bash
84
+ # Start training from a pretrained *.pt model
85
+ yolo detect train data=coco128-pose.yaml model=yolov8n-pose.pt epochs=100 imgsz=640
86
+ ```
87
+
88
+ ## Supported Datasets
89
+
90
+ This section outlines the datasets that are compatible with Ultralytics YOLO format and can be used for training pose estimation models:
91
+
92
+ ### COCO-Pose
93
+
94
+ - **Description**: COCO-Pose is a large-scale object detection, segmentation, and pose estimation dataset. It is a subset of the popular COCO dataset and focuses on human pose estimation. COCO-Pose includes multiple keypoints for each human instance.
95
+ - **Label Format**: Same as Ultralytics YOLO format as described above, with keypoints for human poses.
96
+ - **Number of Classes**: 1 (Human).
97
+ - **Keypoints**: 17 keypoints including nose, eyes, ears, shoulders, elbows, wrists, hips, knees, and ankles.
98
+ - **Usage**: Suitable for training human pose estimation models.
99
+ - **Additional Notes**: The dataset is rich and diverse, containing over 200k labeled images.
100
+ - [Read more about COCO-Pose](./coco.md)
101
+
102
+ ### COCO8-Pose
103
+
104
+ - **Description**: [Ultralytics](https://ultralytics.com) COCO8-Pose is a small, but versatile pose detection dataset composed of the first 8 images of the COCO train 2017 set, 4 for training and 4 for validation.
105
+ - **Label Format**: Same as Ultralytics YOLO format as described above, with keypoints for human poses.
106
+ - **Number of Classes**: 1 (Human).
107
+ - **Keypoints**: 17 keypoints including nose, eyes, ears, shoulders, elbows, wrists, hips, knees, and ankles.
108
+ - **Usage**: Suitable for testing and debugging object detection models, or for experimenting with new detection approaches.
109
+ - **Additional Notes**: COCO8-Pose is ideal for sanity checks and CI checks.
110
+ - [Read more about COCO8-Pose](./coco8-pose.md)
111
+
112
+ ### Adding your own dataset
113
+
114
+ If you have your own dataset and would like to use it for training pose estimation models with Ultralytics YOLO format, ensure that it follows the format specified above under "Ultralytics YOLO format". Convert your annotations to the required format and specify the paths, number of classes, and class names in the YAML configuration file.
115
+
116
+ ### Conversion Tool
117
+
118
+ Ultralytics provides a convenient conversion tool to convert labels from the popular COCO dataset format to YOLO format:
119
+
120
+ !!! example ""
121
+
122
+ === "Python"
123
+
124
+ ```python
125
+ from ultralytics.data.converter import convert_coco
126
+
127
+ convert_coco(labels_dir='path/to/coco/annotations/', use_keypoints=True)
128
+ ```
129
+
130
+ This conversion tool can be used to convert the COCO dataset or any dataset in the COCO format to the Ultralytics YOLO format. The `use_keypoints` parameter specifies whether to include keypoints (for pose estimation) in the converted labels.
yolov8-to/docs/datasets/segment/coco.md ADDED
@@ -0,0 +1,94 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: Explore the possibilities of the COCO-Seg dataset, designed for object instance segmentation and YOLO model training. Discover key features, dataset structure, applications, and usage.
4
+ keywords: Ultralytics, YOLO, COCO-Seg, dataset, instance segmentation, model training, deep learning, computer vision
5
+ ---
6
+
7
+ # COCO-Seg Dataset
8
+
9
+ The [COCO-Seg](https://cocodataset.org/#home) dataset, an extension of the COCO (Common Objects in Context) dataset, is specially designed to aid research in object instance segmentation. It uses the same images as COCO but introduces more detailed segmentation annotations. This dataset is a crucial resource for researchers and developers working on instance segmentation tasks, especially for training YOLO models.
10
+
11
+ ## Key Features
12
+
13
+ - COCO-Seg retains the original 330K images from COCO.
14
+ - The dataset consists of the same 80 object categories found in the original COCO dataset.
15
+ - Annotations now include more detailed instance segmentation masks for each object in the images.
16
+ - COCO-Seg provides standardized evaluation metrics like mean Average Precision (mAP) for object detection, and mean Average Recall (mAR) for instance segmentation tasks, enabling effective comparison of model performance.
17
+
18
+ ## Dataset Structure
19
+
20
+ The COCO-Seg dataset is partitioned into three subsets:
21
+
22
+ 1. **Train2017**: This subset contains 118K images for training instance segmentation models.
23
+ 2. **Val2017**: This subset includes 5K images used for validation purposes during model training.
24
+ 3. **Test2017**: This subset encompasses 20K images used for testing and benchmarking the trained models. Ground truth annotations for this subset are not publicly available, and the results are submitted to the [COCO evaluation server](https://codalab.lisn.upsaclay.fr/competitions/7383) for performance evaluation.
25
+
26
+ ## Applications
27
+
28
+ COCO-Seg is widely used for training and evaluating deep learning models in instance segmentation, such as the YOLO models. The large number of annotated images, the diversity of object categories, and the standardized evaluation metrics make it an indispensable resource for computer vision researchers and practitioners.
29
+
30
+ ## Dataset YAML
31
+
32
+ A YAML (Yet Another Markup Language) file is used to define the dataset configuration. It contains information about the dataset's paths, classes, and other relevant information. In the case of the COCO-Seg dataset, the `coco.yaml` file is maintained at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/coco.yaml](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/coco.yaml).
33
+
34
+ !!! example "ultralytics/cfg/datasets/coco.yaml"
35
+
36
+ ```yaml
37
+ --8<-- "ultralytics/cfg/datasets/coco.yaml"
38
+ ```
39
+
40
+ ## Usage
41
+
42
+ To train a YOLOv8n-seg model on the COCO-Seg dataset for 100 epochs with an image size of 640, you can use the following code snippets. For a comprehensive list of available arguments, refer to the model [Training](../../modes/train.md) page.
43
+
44
+ !!! example "Train Example"
45
+
46
+ === "Python"
47
+
48
+ ```python
49
+ from ultralytics import YOLO
50
+
51
+ # Load a model
52
+ model = YOLO('yolov8n-seg.pt') # load a pretrained model (recommended for training)
53
+
54
+ # Train the model
55
+ results = model.train(data='coco-seg.yaml', epochs=100, imgsz=640)
56
+ ```
57
+
58
+ === "CLI"
59
+
60
+ ```bash
61
+ # Start training from a pretrained *.pt model
62
+ yolo detect train data=coco-seg.yaml model=yolov8n.pt epochs=100 imgsz=640
63
+ ```
64
+
65
+ ## Sample Images and Annotations
66
+
67
+ COCO-Seg, like its predecessor COCO, contains a diverse set of images with various object categories and complex scenes. However, COCO-Seg introduces more detailed instance segmentation masks for each object in the images. Here are some examples of images from the dataset, along with their corresponding instance segmentation masks:
68
+
69
+ ![Dataset sample image](https://user-images.githubusercontent.com/26833433/239690696-93fa8765-47a2-4b34-a6e5-516d0d1c725b.jpg)
70
+
71
+ - **Mosaiced Image**: This image demonstrates a training batch composed of mosaiced dataset images. Mosaicing is a technique used during training that combines multiple images into a single image to increase the variety of objects and scenes within each training batch. This aids the model's ability to generalize to different object sizes, aspect ratios, and contexts.
72
+
73
+ The example showcases the variety and complexity of the images in the COCO-Seg dataset and the benefits of using mosaicing during the training process.
74
+
75
+ ## Citations and Acknowledgments
76
+
77
+ If you use the COCO-Seg dataset in your research or development work, please cite the original COCO paper and acknowledge the extension to COCO-Seg:
78
+
79
+ !!! note ""
80
+
81
+ === "BibTeX"
82
+
83
+ ```bibtex
84
+ @misc{lin2015microsoft,
85
+ title={Microsoft COCO: Common Objects in Context},
86
+ author={Tsung-Yi Lin and Michael Maire and Serge Belongie and Lubomir Bourdev and Ross Girshick and James Hays and Pietro Perona and Deva Ramanan and C. Lawrence Zitnick and Piotr Dollár},
87
+ year={2015},
88
+ eprint={1405.0312},
89
+ archivePrefix={arXiv},
90
+ primaryClass={cs.CV}
91
+ }
92
+ ```
93
+
94
+ We extend our thanks to the COCO Consortium for creating and maintaining this invaluable resource for the computer vision community. For more information about the COCO dataset and its creators, visit the [COCO dataset website](https://cocodataset.org/#home).
yolov8-to/docs/datasets/segment/coco8-seg.md ADDED
@@ -0,0 +1,84 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: 'Discover the COCO8-Seg: a compact but versatile instance segmentation dataset ideal for testing Ultralytics YOLOv8 detection approaches. Complete usage guide included.'
4
+ keywords: COCO8-Seg dataset, Ultralytics, YOLOv8, instance segmentation, dataset configuration, YAML, YOLOv8n-seg model, mosaiced dataset images
5
+ ---
6
+
7
+ # COCO8-Seg Dataset
8
+
9
+ ## Introduction
10
+
11
+ [Ultralytics](https://ultralytics.com) COCO8-Seg is a small, but versatile instance segmentation dataset composed of the
12
+ first 8 images of the COCO train 2017 set, 4 for training and 4 for validation. This dataset is ideal for testing and
13
+ debugging segmentation models, or for experimenting with new detection approaches. With 8 images, it is small enough to
14
+ be easily manageable, yet diverse enough to test training pipelines for errors and act as a sanity check before training
15
+ larger datasets.
16
+
17
+ This dataset is intended for use with Ultralytics [HUB](https://hub.ultralytics.com)
18
+ and [YOLOv8](https://github.com/ultralytics/ultralytics).
19
+
20
+ ## Dataset YAML
21
+
22
+ A YAML (Yet Another Markup Language) file is used to define the dataset configuration. It contains information about the dataset's paths, classes, and other relevant information. In the case of the COCO8-Seg dataset, the `coco8-seg.yaml` file is maintained at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/coco8-seg.yaml](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/coco8-seg.yaml).
23
+
24
+ !!! example "ultralytics/cfg/datasets/coco8-seg.yaml"
25
+
26
+ ```yaml
27
+ --8<-- "ultralytics/cfg/datasets/coco8-seg.yaml"
28
+ ```
29
+
30
+ ## Usage
31
+
32
+ To train a YOLOv8n-seg model on the COCO8-Seg dataset for 100 epochs with an image size of 640, you can use the following code snippets. For a comprehensive list of available arguments, refer to the model [Training](../../modes/train.md) page.
33
+
34
+ !!! example "Train Example"
35
+
36
+ === "Python"
37
+
38
+ ```python
39
+ from ultralytics import YOLO
40
+
41
+ # Load a model
42
+ model = YOLO('yolov8n-seg.pt') # load a pretrained model (recommended for training)
43
+
44
+ # Train the model
45
+ results = model.train(data='coco8-seg.yaml', epochs=100, imgsz=640)
46
+ ```
47
+
48
+ === "CLI"
49
+
50
+ ```bash
51
+ # Start training from a pretrained *.pt model
52
+ yolo detect train data=coco8-seg.yaml model=yolov8n.pt epochs=100 imgsz=640
53
+ ```
54
+
55
+ ## Sample Images and Annotations
56
+
57
+ Here are some examples of images from the COCO8-Seg dataset, along with their corresponding annotations:
58
+
59
+ <img src="https://user-images.githubusercontent.com/26833433/236818387-f7bde7df-caaa-46d1-8341-1f7504cd11a1.jpg" alt="Dataset sample image" width="800">
60
+
61
+ - **Mosaiced Image**: This image demonstrates a training batch composed of mosaiced dataset images. Mosaicing is a technique used during training that combines multiple images into a single image to increase the variety of objects and scenes within each training batch. This helps improve the model's ability to generalize to different object sizes, aspect ratios, and contexts.
62
+
63
+ The example showcases the variety and complexity of the images in the COCO8-Seg dataset and the benefits of using mosaicing during the training process.
64
+
65
+ ## Citations and Acknowledgments
66
+
67
+ If you use the COCO dataset in your research or development work, please cite the following paper:
68
+
69
+ !!! note ""
70
+
71
+ === "BibTeX"
72
+
73
+ ```bibtex
74
+ @misc{lin2015microsoft,
75
+ title={Microsoft COCO: Common Objects in Context},
76
+ author={Tsung-Yi Lin and Michael Maire and Serge Belongie and Lubomir Bourdev and Ross Girshick and James Hays and Pietro Perona and Deva Ramanan and C. Lawrence Zitnick and Piotr Dollár},
77
+ year={2015},
78
+ eprint={1405.0312},
79
+ archivePrefix={arXiv},
80
+ primaryClass={cs.CV}
81
+ }
82
+ ```
83
+
84
+ We would like to acknowledge the COCO Consortium for creating and maintaining this valuable resource for the computer vision community. For more information about the COCO dataset and its creators, visit the [COCO dataset website](https://cocodataset.org/#home).
yolov8-to/docs/datasets/segment/index.md ADDED
@@ -0,0 +1,148 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: Learn how Ultralytics YOLO supports various dataset formats for instance segmentation. This guide includes information on data conversions, auto-annotations, and dataset usage.
4
+ keywords: Ultralytics, YOLO, Instance Segmentation, Dataset, YAML, COCO, Auto-Annotation, Image Segmentation
5
+ ---
6
+
7
+ # Instance Segmentation Datasets Overview
8
+
9
+ ## Supported Dataset Formats
10
+
11
+ ### Ultralytics YOLO format
12
+
13
+ The dataset label format used for training YOLO segmentation models is as follows:
14
+
15
+ 1. One text file per image: Each image in the dataset has a corresponding text file with the same name as the image file and the ".txt" extension.
16
+ 2. One row per object: Each row in the text file corresponds to one object instance in the image.
17
+ 3. Object information per row: Each row contains the following information about the object instance:
18
+ - Object class index: An integer representing the class of the object (e.g., 0 for person, 1 for car, etc.).
19
+ - Object bounding coordinates: The bounding coordinates around the mask area, normalized to be between 0 and 1.
20
+
21
+ The format for a single row in the segmentation dataset file is as follows:
22
+
23
+ ```
24
+ <class-index> <x1> <y1> <x2> <y2> ... <xn> <yn>
25
+ ```
26
+
27
+ In this format, `<class-index>` is the index of the class for the object, and `<x1> <y1> <x2> <y2> ... <xn> <yn>` are the bounding coordinates of the object's segmentation mask. The coordinates are separated by spaces.
28
+
29
+ Here is an example of the YOLO dataset format for a single image with two objects made up of a 3-point segment and a 5-point segment.
30
+
31
+ ```
32
+ 0 0.681 0.485 0.670 0.487 0.676 0.487
33
+ 1 0.504 0.000 0.501 0.004 0.498 0.004 0.493 0.010 0.492 0.0104
34
+ ```
35
+
36
+ !!! tip "Tip"
37
+
38
+ - The length of each row does **not** have to be equal.
39
+ - Each segmentation label must have a **minimum of 3 xy points**: `<class-index> <x1> <y1> <x2> <y2> <x3> <y3>`
40
+
41
+ ### Dataset YAML format
42
+
43
+ The Ultralytics framework uses a YAML file format to define the dataset and model configuration for training Detection Models. Here is an example of the YAML format used for defining a detection dataset:
44
+
45
+ ```yaml
46
+ # Train/val/test sets as 1) dir: path/to/imgs, 2) file: path/to/imgs.txt, or 3) list: [path/to/imgs1, path/to/imgs2, ..]
47
+ path: ../datasets/coco8-seg # dataset root dir
48
+ train: images/train # train images (relative to 'path') 4 images
49
+ val: images/val # val images (relative to 'path') 4 images
50
+ test: # test images (optional)
51
+
52
+ # Classes (80 COCO classes)
53
+ names:
54
+ 0: person
55
+ 1: bicycle
56
+ 2: car
57
+ ...
58
+ 77: teddy bear
59
+ 78: hair drier
60
+ 79: toothbrush
61
+ ```
62
+
63
+ The `train` and `val` fields specify the paths to the directories containing the training and validation images, respectively.
64
+
65
+ `names` is a dictionary of class names. The order of the names should match the order of the object class indices in the YOLO dataset files.
66
+
67
+ ## Usage
68
+
69
+ !!! example ""
70
+
71
+ === "Python"
72
+
73
+ ```python
74
+ from ultralytics import YOLO
75
+
76
+ # Load a model
77
+ model = YOLO('yolov8n-seg.pt') # load a pretrained model (recommended for training)
78
+
79
+ # Train the model
80
+ results = model.train(data='coco128-seg.yaml', epochs=100, imgsz=640)
81
+ ```
82
+ === "CLI"
83
+
84
+ ```bash
85
+ # Start training from a pretrained *.pt model
86
+ yolo detect train data=coco128-seg.yaml model=yolov8n-seg.pt epochs=100 imgsz=640
87
+ ```
88
+
89
+ ## Supported Datasets
90
+
91
+ * [COCO](coco.md): A large-scale dataset designed for object detection, segmentation, and captioning tasks with over 200K labeled images.
92
+ * [COCO8-seg](coco8-seg.md): A smaller dataset for instance segmentation tasks, containing a subset of 8 COCO images with segmentation annotations.
93
+
94
+ ### Adding your own dataset
95
+
96
+ If you have your own dataset and would like to use it for training segmentation models with Ultralytics YOLO format, ensure that it follows the format specified above under "Ultralytics YOLO format". Convert your annotations to the required format and specify the paths, number of classes, and class names in the YAML configuration file.
97
+
98
+ ## Port or Convert Label Formats
99
+
100
+ ### COCO Dataset Format to YOLO Format
101
+
102
+ You can easily convert labels from the popular COCO dataset format to the YOLO format using the following code snippet:
103
+
104
+ !!! example ""
105
+
106
+ === "Python"
107
+
108
+ ```python
109
+ from ultralytics.data.converter import convert_coco
110
+
111
+ convert_coco(labels_dir='path/to/coco/annotations/', use_segments=True)
112
+ ```
113
+
114
+ This conversion tool can be used to convert the COCO dataset or any dataset in the COCO format to the Ultralytics YOLO format.
115
+
116
+ Remember to double-check if the dataset you want to use is compatible with your model and follows the necessary format conventions. Properly formatted datasets are crucial for training successful object detection models.
117
+
118
+ ## Auto-Annotation
119
+
120
+ Auto-annotation is an essential feature that allows you to generate a segmentation dataset using a pre-trained detection model. It enables you to quickly and accurately annotate a large number of images without the need for manual labeling, saving time and effort.
121
+
122
+ ### Generate Segmentation Dataset Using a Detection Model
123
+
124
+ To auto-annotate your dataset using the Ultralytics framework, you can use the `auto_annotate` function as shown below:
125
+
126
+ !!! example ""
127
+
128
+ === "Python"
129
+
130
+ ```python
131
+ from ultralytics.data.annotator import auto_annotate
132
+
133
+ auto_annotate(data="path/to/images", det_model="yolov8x.pt", sam_model='sam_b.pt')
134
+ ```
135
+
136
+ Certainly, here is the table updated with code snippets:
137
+
138
+ | Argument | Type | Description | Default |
139
+ |--------------|-------------------------|-------------------------------------------------------------------------------------------------------------|----------------|
140
+ | `data` | `str` | Path to a folder containing images to be annotated. | `None` |
141
+ | `det_model` | `str, optional` | Pre-trained YOLO detection model. Defaults to `'yolov8x.pt'`. | `'yolov8x.pt'` |
142
+ | `sam_model` | `str, optional` | Pre-trained SAM segmentation model. Defaults to `'sam_b.pt'`. | `'sam_b.pt'` |
143
+ | `device` | `str, optional` | Device to run the models on. Defaults to an empty string (CPU or GPU, if available). | `''` |
144
+ | `output_dir` | `str or None, optional` | Directory to save the annotated results. Defaults to a `'labels'` folder in the same directory as `'data'`. | `None` |
145
+
146
+ The `auto_annotate` function takes the path to your images, along with optional arguments for specifying the pre-trained detection and [SAM segmentation models](https://docs.ultralytics.com/models/sam), the device to run the models on, and the output directory for saving the annotated results.
147
+
148
+ By leveraging the power of pre-trained models, auto-annotation can significantly reduce the time and effort required for creating high-quality segmentation datasets. This feature is particularly useful for researchers and developers working with large image collections, as it allows them to focus on model development and evaluation rather than manual annotation.
yolov8-to/docs/datasets/track/index.md ADDED
@@ -0,0 +1,30 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: Understand multi-object tracking datasets, upcoming features and how to use them with YOLO in Python and CLI. Dive in now!.
4
+ keywords: Ultralytics, YOLO, multi-object tracking, datasets, detection, segmentation, pose models, Python, CLI
5
+ ---
6
+
7
+ # Multi-object Tracking Datasets Overview
8
+
9
+ ## Dataset Format (Coming Soon)
10
+
11
+ Multi-Object Detector doesn't need standalone training and directly supports pre-trained detection, segmentation or Pose models.
12
+ Support for training trackers alone is coming soon
13
+
14
+ ## Usage
15
+
16
+ !!! example ""
17
+
18
+ === "Python"
19
+
20
+ ```python
21
+ from ultralytics import YOLO
22
+
23
+ model = YOLO('yolov8n.pt')
24
+ results = model.track(source="https://youtu.be/Zgi9g1ksQHc", conf=0.3, iou=0.5, show=True)
25
+ ```
26
+ === "CLI"
27
+
28
+ ```bash
29
+ yolo track model=yolov8n.pt source="https://youtu.be/Zgi9g1ksQHc" conf=0.3, iou=0.5 show
30
+ ```
yolov8-to/docs/guides/hyperparameter-tuning.md ADDED
@@ -0,0 +1,96 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ comments: true
3
+ description: Dive into hyperparameter tuning in Ultralytics YOLO models. Learn how to optimize performance using the Tuner class and genetic evolution.
4
+ keywords: Ultralytics, YOLO, Hyperparameter Tuning, Tuner Class, Genetic Evolution, Optimization
5
+ ---
6
+
7
+ # Ultralytics YOLO Hyperparameter Tuning Guide
8
+
9
+ ## Introduction
10
+
11
+ Hyperparameter tuning is not just a one-time set-up but an iterative process aimed at optimizing the machine learning model's performance metrics, such as accuracy, precision, and recall. In the context of Ultralytics YOLO, these hyperparameters could range from learning rate to architectural details, such as the number of layers or types of activation functions used.
12
+
13
+ ### What are Hyperparameters?
14
+
15
+ Hyperparameters are high-level, structural settings for the algorithm. They are set prior to the training phase and remain constant during it. Here are some commonly tuned hyperparameters in Ultralytics YOLO:
16
+
17
+ - **Learning Rate**: Determines the step size at each iteration while moving towards a minimum in the loss function.
18
+ - **Batch Size**: Number of training samples utilized in one iteration.
19
+ - **Number of Epochs**: An epoch is one complete forward and backward pass of all the training examples.
20
+ - **Architecture Specifics**: Such as anchor box sizes, number of layers, types of activation functions, etc.
21
+
22
+ <p align="center">
23
+ <img width="1000" src="https://user-images.githubusercontent.com/26833433/263858934-4f109a2f-82d9-4d08-8bd6-6fd1ff520bcd.png" alt="Hyperparameter Tuning Visual">
24
+ </p>
25
+
26
+ For a full list of augmentation hyperparameters used in YOLOv8 please refer to https://docs.ultralytics.com/usage/cfg/#augmentation.
27
+
28
+ ### Genetic Evolution and Mutation
29
+
30
+ Ultralytics YOLO uses genetic algorithms to optimize hyperparameters. Genetic algorithms are inspired by the mechanism of natural selection and genetics.
31
+
32
+ - **Mutation**: In the context of Ultralytics YOLO, mutation helps in locally searching the hyperparameter space by applying small, random changes to existing hyperparameters, producing new candidates for evaluation.
33
+ - **Crossover**: Although crossover is a popular genetic algorithm technique, it is not currently used in Ultralytics YOLO for hyperparameter tuning. The focus is mainly on mutation for generating new hyperparameter sets.
34
+
35
+ ## Preparing for Hyperparameter Tuning
36
+
37
+ Before you begin the tuning process, it's important to:
38
+
39
+ 1. **Identify the Metrics**: Determine the metrics you will use to evaluate the model's performance. This could be AP50, F1-score, or others.
40
+ 2. **Set the Tuning Budget**: Define how much computational resources you're willing to allocate. Hyperparameter tuning can be computationally intensive.
41
+
42
+ ## Steps Involved
43
+
44
+ ### Initialize Hyperparameters
45
+
46
+ Start with a reasonable set of initial hyperparameters. This could either be the default hyperparameters set by Ultralytics YOLO or something based on your domain knowledge or previous experiments.
47
+
48
+ ### Mutate Hyperparameters
49
+
50
+ Use the `_mutate` method to produce a new set of hyperparameters based on the existing set.
51
+
52
+ ### Train Model
53
+
54
+ Training is performed using the mutated set of hyperparameters. The training performance is then assessed.
55
+
56
+ ### Evaluate Model
57
+
58
+ Use metrics like AP50, F1-score, or custom metrics to evaluate the model's performance.
59
+
60
+ ### Log Results
61
+
62
+ It's crucial to log both the performance metrics and the corresponding hyperparameters for future reference.
63
+
64
+ ### Repeat
65
+
66
+ The process is repeated until either the set number of iterations is reached or the performance metric is satisfactory.
67
+
68
+ ## Usage Example
69
+
70
+ Here's how to use the `model.tune()` method to utilize the `Tuner` class for hyperparameter tuning:
71
+
72
+ !!! example ""
73
+
74
+ === "Python"
75
+
76
+ ```python
77
+ from ultralytics import YOLO
78
+
79
+ # Initialize the YOLO model
80
+ model = YOLO('yolov8n.pt')
81
+
82
+ # Perform hyperparameter tuning
83
+ model.tune(data='coco8.yaml', imgsz=640, epochs=30, iterations=300)
84
+ ```
85
+
86
+ ## Conclusion
87
+
88
+ The hyperparameter tuning process in Ultralytics YOLO is simplified yet powerful, thanks to its genetic algorithm-based approach focused on mutation. Following the steps outlined in this guide will assist you in systematically tuning your model to achieve better performance.
89
+
90
+ ### Further Reading
91
+
92
+ 1. [Hyperparameter Optimization in Wikipedia](https://en.wikipedia.org/wiki/Hyperparameter_optimization)
93
+ 2. [YOLOv5 Hyperparameter Evolution Guide](https://docs.ultralytics.com/yolov5/tutorials/hyperparameter_evolution/)
94
+ 3. [Efficient Hyperparameter Tuning with Ray Tune and YOLOv8](https://docs.ultralytics.com/integrations/ray-tune/)
95
+
96
+ For deeper insights, you can explore the `Tuner` class source code and accompanying documentation. Should you have any questions, feature requests, or need further assistance, feel free to reach out to our support team.