Metadata-Version: 2.4
Name: embedl-hub
Version: 2025.11.0.dev1
Summary: The official Embedl Hub Python client library.
Author-email: Embedl AB <support@embedl.com>
Project-URL: Homepage, https://hub.embedl.com
Project-URL: Documentation, https://hub.embedl.com/docs
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Developers
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Embedded Systems
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Requires-Dist: aimet-torch>=2.14.0
Requires-Dist: ai-edge-torch==0.4.0
Requires-Dist: Jinja2>=3.1.5
Requires-Dist: mergedeep>=1.3.4
Requires-Dist: onnx>=1.17
Requires-Dist: onnxruntime>=1.18
Requires-Dist: platformdirs>=4.5
Requires-Dist: pydantic>=2.8.2
Requires-Dist: PyYAML~=6.0.2
Requires-Dist: qai-hub>=0.28.0
Requires-Dist: requests>=2.32.3
Requires-Dist: rich>=13.7
Requires-Dist: tabulate>=0.9.0
Requires-Dist: torch>=2.6.0
Requires-Dist: torchvision>=0.21.0
Requires-Dist: typer[all]>=0.12.0
Provides-Extra: dev
Requires-Dist: mkdocs; extra == "dev"
Requires-Dist: mkdocs-material; extra == "dev"
Requires-Dist: mkdocstrings[python]; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Dynamic: license-file

# Embedl Hub Python library

Optimize and deploy your model on any edge device with the Embedl Hub Python library:

- **Quantize** your model for lower latency and memory usage.
- **Compile** your model for execution on CPU, GPU, NPU or other AI accelerators on your target devices.
- **Benchmark** your model's latency and memory usage on real edge devices in the cloud.

The library logs your metrics, parameters, and benchmarks on the [Embedl Hub](https://hub.embedl.com)
website, allowing you to inspect, compare, and reproduce your results.

[Create a free Embedl Hub account](https://hub.embedl.com/docs/setup)
to get started with the `embedl-hub` library.

## Installation

The simplest way to install `embedl-hub` is through `pip`:

```shell
pip install embedl-hub
```

## Quickstart

We recommend using our end-to-end workflow CLI to quickly get started building your edge AI application:

```shell
 Usage: embedl-hub [OPTIONS] COMMAND [ARGS]...

 embedl-hub end-to-end Edge-AI workflow CLI


╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --version             -V               Print embedl-hub version and exit.                                                                                           │
│ --verbose             -v      INTEGER  Increase verbosity (-v, -vv, -vvv).                                                                                          │
│ --install-completion                   Install completion for the current shell.                                                                                    │
│ --show-completion                      Show completion for the current shell, to copy it or customize the installation.                                             │
│ --help                                 Show this message and exit.                                                                                                  │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ auth           Store the API key for embedl-hub CLI.                                                                                                                │
│ init           Configure persistent CLI context.                                                                                                                    │
│ show           Print active project/experiment IDs and names.                                                                                                       │
│ compile        Compile a model into a device ready binary using Qualcomm AI Hub.                                                                                    │
│                Qualcomm AI Hub may return a zip file containing multiple files.                                                                                     │
│ quantize       Quantize an ONNX model using Qualcomm AI Hub.                                                                                                        │
│                Qualcomm AI Hub may return a zip file containing multiple files.                                                                                     │
│ benchmark      Benchmark compiled model on device and measure it's performance.                                                                                     │
│ list-devices   List all available target devices.                                                                                                                   │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
```

## License

Copyright (C) 2025 Embedl AB

This software is subject to the [Embedl Hub Software License Agreement](https://hub.embedl.com/embedl-hub-sla.txt).

<!-- Copyright (C) 2025 Embedl AB -->
