Installation

ultralytics-inference requires Python 3.10 or later; see see python.org/downloads.

Poetry is required

ultralytics-inference is built using Poetry. To install ultralytics-inference from source or development, you will need to have Poetry installed. Installation instructions for Poetry can be found in the Poetry documentation.

Installing from source

To install ultralytics-inference from source, you can run the following commands to install the package in the current environment:

# cd ultralytics-inference/
pip install .

Installing for development

To install ultralytics-inference for development, you can run the following commands to install the package in editable mode with development dependencies:

# cd ultralytics-inference/
poetry install

This will install the package in editable mode with development dependencies into a virtual environment managed by Poetry. This environment allows you to make changes to the source code and test them without having to reinstall the package.

You can run the following command to create a subshell with the virtual environment activated:

poetry shell