infer_yolo_v8

infer_yolo_v8

About

1.0.3
AGPL-3.0

Inference with YOLOv8 models

Task: Object detection
YOLO
object
detection
ultralytics
real-time

Run YOLOv8 object detection models.

Desk object detection

🚀 Use with Ikomia API

1. Install Ikomia API

We strongly recommend using a virtual environment. If you're not sure where to start, we offer a tutorial here.

pip install ikomia

2. Create your workflow

from ikomia.dataprocess.workflow import Workflow
from ikomia.utils.displayIO import display

# Init your workflow
wf = Workflow()

# Add algorithm
algo = wf.add_task(name="infer_yolo_v8", auto_connect=True)

# Run on your image
wf.run_on(url="https://raw.githubusercontent.com/Ikomia-dev/notebooks/main/examples/img/img_work.jpg")

# Inpect your result
display(algo.get_image_with_graphics())

☀️ Use with Ikomia Studio

Ikomia Studio offers a friendly UI with the same features as the API.

  • If you haven't started using Ikomia Studio yet, download and install it from this page.

  • For additional guidance on getting started with Ikomia Studio, check out this blog post.

📝 Set algorithm parameters

  • model_name (str) - default 'yolov8m': Name of the YOLOv8 pre-trained model. Other model available:

    • yolov8n
    • yolov8s
    • yolov8l
    • yolov8x
  • input_size (int) - default '640': Size of the input image.

  • conf_thres (float) default '0.25': Box threshold for the prediction [0,1].

  • iou_thres (float) - default '0.7': Intersection over Union, degree of overlap between two boxes [0,1].

  • cuda (bool): If True, CUDA-based inference (GPU). If False, run on CPU.

  • model_weight_file (str, optional): Path to model weights file .pt.

Parameters should be in strings format when added to the dictionary.

from ikomia.dataprocess.workflow import Workflow
from ikomia.utils.displayIO import display

# Init your workflow
wf = Workflow()

# Add algorithm
algo = wf.add_task(name="infer_yolo_v8", auto_connect=True)

algo.set_parameters({
"model_name": "yolov8m",
"conf_thres": "0.5",
"input_size": "640",
"iou_thres": "0.5",
"cuda": "True"
})

# Run on your image
wf.run_on(url="https://raw.githubusercontent.com/Ikomia-dev/notebooks/main/examples/img/img_work.jpg")

# Inpect your result
display(algo.get_image_with_graphics())

🔍 Explore algorithm outputs

Every algorithm produces specific outputs, yet they can be explored them the same way using the Ikomia API. For a more in-depth understanding of managing algorithm outputs, please refer to the documentation.

import ikomia
from ikomia.dataprocess.workflow import Workflow

# Init your workflow
wf = Workflow()

# Add algorithm
algo = wf.add_task(name="infer_yolo_v8", auto_connect=True)

# Run on your image
wf.run_on(url="https://raw.githubusercontent.com/Ikomia-dev/notebooks/main/examples/img/img_work.jpg")

# Iterate over outputs
for output in algo.get_outputs():
# Print information
print(output)
# Export it to JSON
output.to_json()

Developer

  • Ikomia
    Ikomia

License

GNU Affero General Public License v3.0
Read license full text

Permissions of this strongest copyleft license are conditioned on making available complete source code of licensed works and modifications, which include larger works using a licensed work, under the same license. Copyright and license notices must be preserved. Contributors provide an express grant of patent rights. When a modified version is used to provide a service over a network, the complete source code of the modified version must be made available.

PermissionsConditionsLimitations

Commercial use

License and copyright notice

Liability

Modification

State changes

Warranty

Distribution

Disclose source

Patent use

Network use is distribution

Private use

Same license

This is not legal advice: this description is for informational purposes only and does not constitute the license itself. Provided by choosealicense.com.