easydetect 0.1.0__tar.gz

easydetect-0.1.0/.gitignore

@@ -0,0 +1,20 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+.venv/
+venv/
+.pytest_cache/
+.ruff_cache/
+runs/
+mirror/
+weights/
+easydetect-platform/
+*.onnx
+*.pth
+*.xml
+*.bin
+*.pt
+!tests/**/*.xml
+.DS_Store

easydetect-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 easydetect contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

easydetect-0.1.0/NOTICE

@@ -0,0 +1,28 @@
+easydetect
+Copyright 2026 easydetect contributors
+
+This product includes software adapted from the following projects, each
+licensed under the Apache License, Version 2.0:
+
+* D-FINE (https://github.com/Peterande/D-FINE), Copyright (c) 2024 The D-FINE
+  Authors. The detector under easydetect/nn/ (HGNetv2 backbone, hybrid encoder,
+  D-FINE decoder with fine-grained distribution refinement, denoising queries)
+  and the training loss in easydetect/utils/loss.py are adapted from it, with
+  module names and numerics kept so the D-FINE COCO checkpoints load unchanged.
+  The pretrained weights easydetect downloads are those COCO checkpoints,
+  converted without retraining.
+
+* RT-DETR (https://github.com/lyuwenyu/RT-DETR), Copyright (c) 2023 lyuwenyu,
+  from which D-FINE itself is modified.
+
+* PaddleDetection (https://github.com/PaddlePaddle/PaddleDetection), Copyright
+  (c) PaddlePaddle Authors — the PP-HGNetV2 backbone design.
+
+* DETR (https://github.com/facebookresearch/detr), Copyright (c) Facebook, Inc.
+  and its affiliates — box utilities.
+
+The packaging, API, trainer, validator, exporter, predictor, CLI and the web
+platform are this project's own.
+
+No code or weights from AGPL-licensed projects are included. Only D-FINE's
+COCO-trained checkpoints are used; checkpoints pretrained on Objects365 are not.

easydetect-0.1.0/PKG-INFO

@@ -0,0 +1,250 @@
+Metadata-Version: 2.5
+Name: easydetect
+Version: 0.1.0
+Summary: Easy real-time object detection you can ship: D-FINE with PyTorch training, OpenVINO inference on CPU/GPU/NPU, and a browser app to label and train. Apache-2.0 throughout.
+Project-URL: Homepage, https://github.com/themakerrobot/easydetect
+Project-URL: Source, https://github.com/themakerrobot/easydetect
+Project-URL: Documentation, https://github.com/themakerrobot/easydetect/blob/main/docs/usage.md
+Project-URL: Issues, https://github.com/themakerrobot/easydetect/issues
+Author-email: leeyunjai <leeyunjai1982@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: annotation,apache-2.0,computer-vision,d-fine,detr,easydetect,edge-ai,education,labeling,npu,object-detection,openvino,pytorch,real-time,rt-detr,transformer,yolo-alternative
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Scientific/Engineering :: Image Recognition
+Requires-Python: >=3.10
+Requires-Dist: numpy>=1.23
+Requires-Dist: opencv-python>=4.6
+Requires-Dist: openvino>=2024.0
+Requires-Dist: pyyaml>=5.4
+Provides-Extra: dev
+Requires-Dist: httpx>=0.24; extra == 'dev'
+Requires-Dist: pillow>=9.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Provides-Extra: train
+Requires-Dist: onnx>=1.14; extra == 'train'
+Requires-Dist: scipy>=1.9; extra == 'train'
+Requires-Dist: torch>=2.1; extra == 'train'
+Requires-Dist: torchvision>=0.16; extra == 'train'
+Description-Content-Type: text/markdown
+
+<div align="center">
+
+# easydetect
+
+**Easy real-time object detection you can actually ship.**
+Train in PyTorch, run anywhere with OpenVINO — CPU, GPU or NPU — and label,
+train and test in a browser. Apache-2.0 from the code to the model you export.
+
+[![PyPI](https://img.shields.io/pypi/v/easydetect?color=2b7489)](https://pypi.org/project/easydetect/)
+[![Python](https://img.shields.io/pypi/pyversions/easydetect)](https://pypi.org/project/easydetect/)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue)](https://github.com/themakerrobot/easydetect/blob/main/LICENSE)
+[![CI](https://github.com/themakerrobot/easydetect/actions/workflows/ci.yml/badge.svg)](https://github.com/themakerrobot/easydetect/actions/workflows/ci.yml)
+
+![detections on a street scene](https://raw.githubusercontent.com/themakerrobot/easydetect/main/docs/assets/demo.jpg)
+
+</div>
+
+## Why
+
+* **Three lines to a detector.** `Detector("dfine-s")`, point it at a picture,
+  read the boxes. The same object trains, validates and exports.
+* **One licence, all the way down.** Apache-2.0 code, Apache-2.0 COCO weights,
+  Apache-2.0 exports — nothing to clear with legal before it goes into a
+  product or a classroom.
+* **Accurate for its size.** The detector is
+  [D-FINE](https://github.com/Peterande/D-FINE), a real-time DETR: D-FINE-S
+  scores 48.5 COCO mAP with 10M parameters.
+* **Runs on the machine you have.** OpenVINO runs the model on a CPU, an Intel
+  GPU or an Intel NPU; no CUDA needed to deploy. A GPU makes training quick.
+* **No NMS.** One box per object, so there is no IoU threshold to tune and
+  latency does not climb with a crowded frame.
+
+## Install
+
+```bash
+pip install easydetect              # inference
+pip install "easydetect[train]"     # + training
+```
+
+## Detect
+
+```python
+from easydetect import Detector
+
+model = Detector("dfine-s")           # COCO weights, downloaded on first use
+r = model("photo.jpg", conf=0.5)[0]
+
+r.boxes.xyxy, r.boxes.conf, r.boxes.cls   # plain numpy
+r.names[int(r.boxes.cls[0])]              # "person"
+r.plot(); r.save(); r.show()
+```
+
+Point it at an image, a folder, a glob, a video, an RTSP stream, a webcam index,
+or a numpy array. Long sources stream, so memory stays flat:
+
+```python
+for r in model.predict(0, stream=True, show=True):   # webcam, q or Esc quits
+    print(r.boxes.xyxyn)
+
+model.track("clip.mp4")        # adds r.boxes.id
+model = Detector("dfine-s", device="NPU")            # AUTO, CPU, GPU, NPU
+```
+
+A webcam viewer with an FPS counter is in [`examples/webcam.py`](https://github.com/themakerrobot/easydetect/blob/main/examples/webcam.py)
+— `python examples/webcam.py --track`.
+
+## Train
+
+```python
+model = Detector("dfine-s")
+model.train(data="data.yaml", epochs=50, imgsz=640, batch=16, device=0)
+model.val(data="data.yaml").box.map50
+model.export(format="openvino")       # best.xml + best.bin + labels.txt
+```
+
+```yaml
+# data.yaml
+path: /data/cans
+train: images/train
+val: images/val
+names: {0: can, 1: bottle}
+```
+
+Labels are one `.txt` per image, `cls cx cy w h` normalised — the layout every
+labelling tool already exports. A YOLO-format download (Roboflow's included)
+trains as it comes; [training.md](https://github.com/themakerrobot/easydetect/blob/main/docs/training.md#datasets-from-elsewhere)
+lists the variations it accepts. Training starts from the COCO weights and saves
+an average of the weights (EMA) as the checkpoint; `freeze="backbone"` trains
+faster on a small set, and `resume=True` picks a killed run back up.
+
+## Label, train and watch it in a browser
+
+`platform/` is a web app on top of this package: drop images in, label them (the
+model drafts the boxes, you correct them), queue a training run, watch the curve,
+then run the result over a folder, a video or your webcam — on one machine, with
+nothing leaving it. A finished run hands you copy-ready code and a Hugging Face
+folder whose model card is written from the run.
+
+```bash
+pip install -r platform/requirements.txt
+python platform/run.py          # http://<this machine>:8080
+```
+
+![the platform](https://raw.githubusercontent.com/themakerrobot/easydetect/main/docs/assets/platform.jpg)
+
+## Models
+
+| name | backbone | params | COCO mAP50-95 |
+| --- | --- | --- | --- |
+| `dfine-n` | HGNetv2-B0 | 4M | 42.8 |
+| `dfine-s` | HGNetv2-B0 | 10M | 48.5 — the default |
+| `dfine-m` | HGNetv2-B2 | 19M | 52.3 |
+| `dfine-l` | HGNetv2-B4 | 31M | 54.0 |
+| `dfine-x` | HGNetv2-B5 | 62M | 55.8 |
+
+COCO numbers are D-FINE's own for these checkpoints (640 px, val2017).
+
+## Speed
+
+`dfine-s` at 640 on one desktop — a Core Ultra 5 250K Plus with an RTX 5090 —
+network only, median of 30 runs:
+
+| `device=` | latency | FPS |
+| --- | --- | --- |
+| `"CPU"` | 34 ms | 29 |
+| `"NPU"` | 37 ms | 27 — and the CPU stays free |
+| `"GPU"` (the RTX 5090 through OpenCL) | 13 ms | 74 |
+
+Every device returns the same boxes as PyTorch (the NPU to a mean IoU of 0.98).
+[performance.md](https://github.com/themakerrobot/easydetect/blob/main/docs/performance.md)
+covers measuring your own machine and what makes it faster.
+
+## Compared with YOLO
+
+Published COCO val2017 numbers at 640 px, as each project reports them — not
+re-measured here:
+
+| model | params | COCO mAP50-95 | NMS | license |
+| --- | --- | --- | --- | --- |
+| D-FINE n / s / m / l / x | 4M / 10M / 19M / 31M / 62M | 42.8 / 48.5 / 52.3 / 54.0 / 55.8 | none | Apache-2.0 |
+| YOLO11 n / s / m / l / x | 2.6M / 9.4M / 20.1M / 25.3M / 56.9M | 39.5 / 47.0 / 51.5 / 53.4 / 54.7 | needed | AGPL-3.0 |
+
+Read it plainly:
+
+* **At each size D-FINE scores a little higher on COCO**, with a similar
+  parameter count (YOLO11-n and -l are the lighter ones).
+* **The license is the difference that usually decides.** Ultralytics YOLO is
+  AGPL-3.0: a product that ships it, or serves it over a network, must publish
+  its source or buy a commercial license. Everything here is Apache-2.0 — code
+  and weights — so it goes into closed products as it is.
+* **Where YOLO fits better:** segmentation and pose in the same tool, and a far
+  larger ecosystem.
+
+COCO is a guide, not your answer. Fine-tune both on your own data, then compare
+mAP on the same validation images and latency on the same device, NMS included.
+
+## Command line
+
+```bash
+easydetect predict model=dfine-s source=photo.jpg conf=0.5
+easydetect train   model=dfine-s data=data.yaml epochs=50
+easydetect val     model=best.pt data=data.yaml
+easydetect export  model=best.pt format=openvino half=true
+```
+
+## Docs
+
+* [Using the model](https://github.com/themakerrobot/easydetect/blob/main/docs/usage.md) — sources, results, tracking, saving
+* [Training](https://github.com/themakerrobot/easydetect/blob/main/docs/training.md) — datasets, validation, export, CLI
+* [Platform](https://github.com/themakerrobot/easydetect/blob/main/platform/README.md) — the browser app: labelling, jobs, sharing
+* [Weights](https://github.com/themakerrobot/easydetect/blob/main/docs/weights.md) — the mirror, building it, offline use
+* [Performance](https://github.com/themakerrobot/easydetect/blob/main/docs/performance.md) — measuring speed and improving it
+* [Design](https://github.com/themakerrobot/easydetect/blob/main/docs/design.md) — architecture and provenance
+* [Development](https://github.com/themakerrobot/easydetect/blob/main/docs/contributing.md) — tests, releases
+
+## What it does not do
+
+Boxes only — no segmentation, pose or classification. One training process, one
+machine; multi-GPU and distributed training are out of scope. Inference targets
+OpenVINO, so a CUDA deployment means exporting to ONNX and taking it from there.
+
+## 한국어
+
+```python
+from easydetect import Detector
+
+model = Detector("dfine-s")                # COCO 사전학습 가중치 자동 다운로드
+model("photo.jpg", conf=0.5)[0].save()     # 결과 이미지 저장
+model.train(data="data.yaml", epochs=50)   # 내 데이터로 학습
+model.export(format="openvino")            # 배포용 IR + labels.txt
+```
+
+세 줄이면 물체 검출이 됩니다. 모델은 D-FINE(실시간 DETR)이고, 코드와 가중치가
+모두 Apache-2.0이라 상용 제품이나 교육 현장에 그대로 쓸 수 있습니다. CPU만으로도
+돌고, Intel NPU·GPU에서도 같은 결과가 나옵니다. 라벨링부터 학습·추론까지
+브라우저로 하려면 `python platform/run.py`. 가중치 캐시는 `~/.easydetect/`, 사내
+미러는 `EASYDETECT_ASSETS_URL` 환경변수로 지정합니다.
+
+## Credits
+
+The detector and its COCO weights come from
+[D-FINE](https://github.com/Peterande/D-FINE) (Apache-2.0,
+[arXiv:2410.13842](https://arxiv.org/abs/2410.13842)), which builds on
+[RT-DETR](https://github.com/lyuwenyu/RT-DETR). This package adapts that network
+and loss, and adds its own training loop, inference stack and tooling — see
+[NOTICE](https://github.com/themakerrobot/easydetect/blob/main/NOTICE).
+
+## License
+
+Apache-2.0 — see [LICENSE](https://github.com/themakerrobot/easydetect/blob/main/LICENSE) and [NOTICE](https://github.com/themakerrobot/easydetect/blob/main/NOTICE).