PyroEngine: Wildfire detection on edge devices
PyroEngine provides a high-level interface to use Deep learning models in production while being connected to the alert API.
Quick Tour
Running your engine locally
You can use the library like any other python package to detect wildfires as follows:
from pyroengine.core import Engine
from PIL import Image
engine = Engine("pyronear/rexnet1_3x")
im = Image.open("path/to/your/image.jpg").convert('RGB')
prediction = engine.predict(image)
Setup
Python 3.6 (or higher) and pip/conda are required to install PyroVision.
Stable release
You can install the last stable release of the package using pypi as follows:
pip install pyroengine
Developer installation
Alternatively, if you wish to use the latest features of the project that haven't made their way to a release yet, you can install the package from source:
git clone https://github.com/pyronear/pyro-engine.git
pip install -e pyro-engine/.
Full docker orchestration
Finally, you will need a .env file to enable camera & Alert API interactions. Your file should include a few mandatory entries:
API_URL=http://my-api.myhost.com
LAT=48.88
LON=2.38
CAM_USER=my_dummy_login
CAM_PWD=my_dummy_pwd
Additionally, you'll need a ./data folder which contains:
credentials.json: a dictionary with the IP address of your cameras as key, and dictionary with entrieslogin&passwordfor their Alert API credentialsmodel.onnx: optional, will overrides the model weights download from HuggingFace Hubconfig.json: optional, will overrides the model config download from HuggingFace Hub
Documentation
The full package documentation is available here for detailed specifications.
Contributing
Please refer to CONTRIBUTING if you wish to contribute to this project.
Credits
This project is developed and maintained by the repo owner and volunteers from Data for Good.
License
Distributed under the Apache 2 License. See LICENSE for more information.
Metadata
Release files for pyroengine 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pyroengine-0.2.0.tar.gz | 19.2 kB | Without provenance | Details for pyroengine-0.2.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pyroengine-0.2.0-py3-none-any.whl | Python 3 | none | any | Details for pyroengine-0.2.0-py3-none-any.whl |
Total release size: 35.9 kB
Release files / pyroengine-0.2.0.tar.gz
| Download URL | pyroengine-0.2.0.tar.gz |
|---|---|
| Size | 19.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
818429c1f3f92700529812b4baf2e271bc8a1f4d61f773b620b9998f92559760
|
|
BLAKE2b-256 checksum How to use checksums |
b7bd1f16a150c26ccb4af7231fab149c3e55cf925dab6b8a94bbbe527d154659
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.8.13
|
Release files / pyroengine-0.2.0-py3-none-any.whl
| Download URL | pyroengine-0.2.0-py3-none-any.whl |
|---|---|
| Size | 16.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
962111e14b538bdd76da5ff0c43f95f526e37fa8bf051c40c58aa35dcc3cafbc
|
|
BLAKE2b-256 checksum How to use checksums |
5739e9850c2079dd8f6b9adeaf2e0ee88bfe96a0a3a2158533384b4500cf2f5c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.8.13
|
Security for pyroengine 0.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.