Metadata-Version: 2.4
Name: mindyolo
Version: 0.5.0
Summary: A toolbox of vision models and algorithms based on MindSpore.
Home-page: https://github.com/mindspore-lab/mindyolo
Author: MindSpore Ecosystem
Author-email: mindspore-ecosystem@example.com
License: Apache Software License 2.0
Project-URL: Sources, https://github.com/mindspore-lab/mindyolo
Project-URL: Issue Tracker, https://github.com/mindspore-lab/mindyolo/issues
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: pybind11>=2.10.4
Requires-Dist: numpy>=1.17.0
Requires-Dist: PyYAML>=5.3
Requires-Dist: tqdm
Requires-Dist: opencv-python>=4.7.0.68
Requires-Dist: opencv-python-headless>=4.7.0.68
Requires-Dist: albumentations>=1.0.3
Requires-Dist: pycocotools>=2.0.2
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# MindYOLO

<p align="left">
    <a href="https://github.com/mindspore-lab/mindyolo/blob/master/README.md">
        <img alt="docs" src="https://img.shields.io/badge/docs-latest-blue">
    </a>
    <a href="https://github.com/mindspore-lab/mindyolo/blob/master/LICENSE">
        <img alt="GitHub" src="https://img.shields.io/github/license/mindspore-lab/mindcv.svg">
    </a>
    <a href="https://github.com/mindspore-lab/mindyolo/pulls">
        <img alt="PRs Welcome" src="https://img.shields.io/badge/PRs-welcome-pink.svg">
    </a>
</p>

MindYOLO implements state-of-the-art YOLO series algorithms based on MindSpore.
The following is the corresponding `mindyolo` versions and supported `mindspore` versions.

| mindyolo |  mindspore  |
| :------: | :---------: |
|  master  |   master    |
|   0.5    |    2.5.0    |
|   0.4    | 2.3.0/2.3.1 |
|   0.3    |   2.2.10    |
|   0.2    |     2.0     |
|   0.1    |     1.8     |

<img src="https://raw.githubusercontent.com/mindspore-lab/mindyolo/master/.github/000000137950.jpg" />

## Benchmark and Model Zoo

See [Benchmark Results](benchmark_results.md).

## supported model list
- [x] [YOLOv11](configs/yolov11)
- [x] [YOLOv10](configs/yolov10)
- [x] [YOLOv9](configs/yolov9)
- [x] [YOLOv8](configs/yolov8)
- [x] [YOLOv7](configs/yolov7)
- [x] [YOLOX](configs/yolox)
- [x] [YOLOv5](configs/yolov5)
- [x] [YOLOv4](configs/yolov4)
- [x] [YOLOv3](configs/yolov3)

## Installation

See [INSTALLATION](docs/en/installation.md) for details.

## Getting Started

See [GETTING STARTED](GETTING_STARTED.md) for details.

## Custom dataset examples

See [examples](examples)

## Notes

⚠️ The current version is based on the [static shape of GRAPH](https://mindspore.cn/docs/en/r2.0/note/static_graph_syntax_support.html). 
The dynamic shape of verision will be supported later. Please look forward to it.

### How to Contribute

We appreciate all contributions including issues and PRs to make MindYOLO better. 

Please refer to [CONTRIBUTING.md](CONTRIBUTING.md) for the contributing guideline.

### License

MindYOLO is released under the [Apache License 2.0](LICENSE.md).

### Acknowledgement

MindYOLO is an open source project that welcome any contribution and feedback. We wish that the toolbox and benchmark could support the growing research community, reimplement existing methods, and develop their own new real-time object detection methods by providing a flexible and standardized toolkit.

### Citation

If you find this project useful in your research, please consider cite:

```latex
@misc{MindSpore Object Detection YOLO 2023,
    title={{MindSpore Object Detection YOLO}:MindSpore Object Detection YOLO Toolbox and Benchmark},
    author={MindSpore YOLO Contributors},
    howpublished = {\url{https://github.com/mindspore-lab/mindyolo}},
    year={2023}
}
```
