Metadata-Version: 2.4
Name: auspex-rt
Version: 0.1.1
Summary: Bounding-box object detection, trained from scratch on your own data
Author: Md. Sohanur Islam Shuvo
License: AUSPEX END-USER LICENSE AGREEMENT (EULA)
        
        Copyright (c) 2026 Md. Sohanur Islam Shuvo (github.com/sohanurislamshuvo)
        ("Licensor"). All rights reserved.
        
        This End-User License Agreement governs use of the Auspex software, including
        its binary distributions, source code, model architecture, configuration
        files, documentation, and tools (the "Software"). By installing or using the
        Software you agree to these terms.
        
        1. LICENSE GRANT. Subject to this Agreement, Licensor grants you ("Licensee")
           a limited, non-exclusive, non-transferable, revocable license to:
           a) install and run the Software, in the binary form provided to you, on
              systems under your control;
           b) train, fine-tune, validate, and run models with the Software using
              Licensee's own data; and
           c) use the resulting model weights and predictions for Licensee's own
              internal business purposes.
        
        2. OWNERSHIP. The Software, its architecture, and all intellectual property
           therein remain the exclusive property of Licensor. Model weights that
           Licensee trains with the Software on Licensee's own data belong to
           Licensee; this does not transfer any rights in the Software itself.
        
        3. RESTRICTIONS. Except with Licensor's prior written permission, Licensee
           shall NOT:
           a) copy (other than as required to install and run), redistribute, sell,
              rent, lease, sublicense, or otherwise make the Software available to
              any third party;
           b) modify, adapt, translate, or create derivative works of the Software;
           c) decompile, disassemble, reverse engineer, or otherwise attempt to
              derive the source code, architecture details, or algorithms of the
              Software, except to the extent such restriction is prohibited by
              applicable law;
           d) use the Software or knowledge gained from it to develop a competing
              product or service; or
           e) remove or alter any copyright or proprietary notices.
        
        4. TERMINATION. This license terminates automatically if Licensee breaches
           this Agreement. Upon termination, Licensee must cease use and destroy all
           copies of the Software; Sections 2, 5, and 6 survive termination, and
           Licensee's rights under Section 1(c) to weights already trained on
           Licensee's own data survive any termination not caused by breach.
        
        5. NO WARRANTY. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
           KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
           MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
        
        6. LIMITATION OF LIABILITY. IN NO EVENT SHALL LICENSOR BE LIABLE FOR ANY
           CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
           OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
           THE USE OR OTHER DEALINGS IN THE SOFTWARE.
        
        For licensing inquiries, contact the copyright holder.
        
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: torch>=2.3
Requires-Dist: torchvision>=0.18
Requires-Dist: numpy>=1.26
Requires-Dist: opencv-python>=4.9
Requires-Dist: PyYAML>=6.0
Dynamic: license-file

# Auspex RT

**Bounding-box object detection.** Train on your own boxes, detect boxes.

Trained from random initialisation — no pretrained weights are downloaded and
none are required, so the detector you train carries nothing of anyone else's.

## Install

```bash
pip install auspex-rt        # import name: auspex_rt
```

Wheels for Linux x86_64, Windows and macOS Apple Silicon, Python 3.10–3.13.
An NVIDIA GPU is recommended for training; CPU is fine for inference.

## Use

```python
from auspex_rt import Auspex

model = Auspex(labelspace="labelspace.yaml")
model.train(data="data.yaml", epochs=150)
results = model.predict("images/", save=True)

model = Auspex(weights="best.pt")     # checkpoints are self-contained
model.val(data="data.yaml")
```

Or the console command: `auspex-rt train --data data.yaml --labelspace
labelspace.yaml`.

Reads **YOLO/Roboflow text, COCO JSON, CVAT-for-images 1.1 XML and Pascal
VOC**, mixed freely in one run. Polygon annotations train a box model — the box
is taken from the annotation's extent, and the conversion is reported rather
than done silently. Predictions export back to CVAT or COCO for pre-labelling.

## Trial and licensing

**Training is free for 30 days, in full** — no key, no sign-up. The clock starts
on your first training run.

**Prediction, validation, calibration and export are never gated.** They keep
working afterwards, on any model you have already trained, forever.

After 30 days, training needs a credential:

```bash
export AUSPEX_RT_LICENSE=AUSPEXRT-...   # or write it to ~/.auspex-rt/license.key
```

Verified **offline** against a public key compiled into the wheel — nothing
phones home, so training works on air-gapped machines. The trade is that a
credential cannot be withdrawn before it expires, so they are dated.

Get one: **<https://heliontechltd.com/license>**

## License

Proprietary, under an End-User License Agreement: licensed users may install
and run it and train models on their own data (the resulting weights are
theirs); copying, redistribution, modification and reverse engineering are
prohibited. Full terms: <https://heliontechltd.com/license>
