Skip to content

Latest commit

 

History

History
62 lines (42 loc) · 4.13 KB

README.md

File metadata and controls

62 lines (42 loc) · 4.13 KB

LuxonisML

License PyBadge PyPI PyPI - Downloads

CI codecov

Ruff Docformatter Black

This library includes a collection of helper functions and utilities for the Luxonis MLOps stack. This includes the following submodules:

  • Dataset Management: Creating computer vision datasets focused around Luxonis hardware and to be used with our LuxonisTrain framework. Additional documentation can be found here.
  • Embeddings: Methods to compute image embeddings.
  • Tracking: Our implementation of a logger for use with PyTorch Lightning or in LuxonisTrain
  • Utils: Miscellaneous utils for developers.

NOTE: The project is in a beta state, it might be missing certain features or contain bugs - please report any feedback!

Table of Contents

Installation

The luxonis_ml package is hosted on PyPI, so you can install it with pip.

We offer several versions of the package:

  • luxonis-ml[data]: installs necessary dependencies for using luxonis_ml.data module
  • luxonis-ml[utils]: installs necessary dependencies for using luxonis_ml.utils module
  • luxonis-ml[embedd]: installs necessary dependencies for using luxonis_ml.embeddings module
  • luxonis-ml[tracker]: installs necessary dependencies for using luxonis_ml.tracker module
  • luxonis-ml[all]: installs all dependencies
  • luxonis-ml[dev]: installs all dependencies, including development dependencies

To install the package with all dependencies, run:

pip install luxonis-ml[all]

CLI

The luxonis-ml package comes with a CLI that can be used to interact with the library.

To see the available commands, run:

luxonis_ml --help

Contributing

If you want to contribute to this project, read the instructions in CONTRIBUTING.md