Skip to content

Commit 3762c5e

Browse files
Improve README (#66)
* Improve README * Update README.md --------- Co-authored-by: Glenn Jocher <[email protected]>
1 parent a7538f3 commit 3762c5e

File tree

1 file changed

+22
-18
lines changed

1 file changed

+22
-18
lines changed

README.md

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,44 @@
1-
<br><img src="https://raw.githubusercontent.com/ultralytics/assets/main/logo/Ultralytics_Logotype_Original.svg" width="350">
1+
<br>
2+
<img src="https://raw.githubusercontent.com/ultralytics/assets/main/logo/Ultralytics_Logotype_Original.svg" width="320">
3+
4+
# 🚀 Introduction
5+
6+
Welcome to the [COCO2YOLO](https://github.com/ultralytics/COCO2YOLO) repository! This toolkit is designed to help you convert datasets in JSON format, following the COCO (Common Objects in Context) standards, into YOLO (You Only Look Once) format, which is widely recognized for its efficiency in real-time object detection tasks.
27

3-
# Introduction
8+
This process is essential for machine learning practitioners looking to train object detection models using the Darknet framework. Our code is flexible and can be utilized across various platforms including Linux, MacOS, and Windows.
49

5-
The https://github.com/ultralytics/COCO2YOLO repo contains code to convert JSON datasets into YOLO (darknet) format. The code works on Linux, MacOS and Windows.
10+
# ⚙️ Requirements
611

7-
# Requirements
12+
To get started with COCO2YOLO, you'll need a Python environment running version 3.8 or later. Additionally, you'll need to install all the necessary dependencies listed in our [requirements.txt](https://github.com/ultralytics/JSON2YOLO/blob/master/requirements.txt) file. You can install these dependencies using the following pip command in your terminal:
813

9-
Python 3.8 or later with all [requirements.txt](https://github.com/ultralytics/JSON2YOLO/blob/master/requirements.txt) dependencies installed. To install run:
1014
```bash
11-
$ pip install -r requirements.txt
15+
$ pip install -r requirements.txt # Installs all the required packages
1216
```
1317

14-
# Citation
18+
# 📚 Citation
1519

16-
[![DOI](https://zenodo.org/badge/186122711.svg)](https://zenodo.org/badge/latestdoi/186122711)
20+
If you find our tool useful for your research or development, please consider citing it:
1721

18-
# Contribute
22+
[![DOI](https://zenodo.org/badge/186122711.svg)](https://zenodo.org/badge/latestdoi/186122711)
1923

20-
We love your input! Ultralytics open-source efforts 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!
24+
# 🤝 Contribute
2125

22-
<!-- SVG image from https://opencollective.com/ultralytics/contributors.svg?width=990 -->
26+
We welcome contributions from the community! Whether you're fixing bugs, adding new features, or improving documentation, your input is invaluable. Take a look at our [Contributing Guide](https://docs.ultralytics.com/help/contributing) to get started. Also, we'd love to hear about your experience with Ultralytics products. Please consider filling out our [Survey](https://ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey). A huge 🙏 and thank you to all of our contributors!
2327

28+
<!-- Ultralytics contributors -->
2429
<a href="https://github.com/ultralytics/yolov5/graphs/contributors">
2530
<img width="100%" src="https://github.com/ultralytics/assets/raw/main/im/image-contributors.png" alt="Ultralytics open-source contributors"></a>
2631

27-
# License
32+
# ©️ License
2833

29-
Ultralytics offers two licensing options to accommodate diverse use cases:
34+
Ultralytics is excited to offer two different licensing options to meet your needs:
3035

31-
- **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.
32-
- **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).
36+
- **AGPL-3.0 License**: Perfect for students and hobbyists, this [OSI-approved](https://opensource.org/licenses/) open-source license encourages collaborative learning and knowledge sharing. Please refer to the [LICENSE](https://github.com/ultralytics/ultralytics/blob/main/LICENSE) file for detailed terms.
37+
- **Enterprise License**: Ideal for commercial use, this license allows for the integration of Ultralytics software and AI models into commercial products without the open-source requirements of AGPL-3.0. For use cases that involve commercial applications, please contact us via [Ultralytics Licensing](https://ultralytics.com/license).
3338

34-
# Contact
39+
# 📬 Contact Us
3540

36-
For Ultralytics bug reports and feature requests please visit [GitHub Issues](https://github.com/ultralytics/JSON2YOLO/issues), and join our [Discord](https://ultralytics.com/discord) community for questions and discussions!
41+
For bug reports, feature requests, and contributions, head to [GitHub Issues](https://github.com/ultralytics/JSON2YOLO/issues). For questions and discussions about this project and other Ultralytics endeavors, join us on [Discord](https://ultralytics.com/discord)!
3742

3843
<br>
3944
<div align="center">
@@ -51,4 +56,3 @@ For Ultralytics bug reports and feature requests please visit [GitHub Issues](ht
5156
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space">
5257
<a href="https://ultralytics.com/discord"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-discord.png" width="3%" alt="Ultralytics Discord"></a>
5358
</div>
54-

0 commit comments

Comments
 (0)