CIkomiaRegistry

class ikomia.dataprocess.pydataprocess.CIkomiaRegistry

Algorithms registry of the Ikomia platform.

Class that enables to instanciate every algorithm from its name. CIkomiaRegistry objects communicate automatically with the Ikomia HUB to download algorithm package if necessary. It also include dedicated function to register new algorithms

Note

A pure Python derived class is also implemented to add higher level features. See IkomiaRegistry for more information.

Import

from ikomia.dataprocess import CIkomiaRegistry

Methods

__init__(arg1)	__init__( (object)self) -> None :
create_instance(self, name)	Instanciate algorithm of the Ikomia registry from its name with default parameters.
get_algorithms(self))	Get all available algorithms from the Ikomia registry.
get_algorithm_info(self, name)	Get algorithm informations such as description, authors, documentation link...
get_plugins_directory(self)	Get the current Ikomia plugins directory.
is_all_loaded(self)	Return true if all locally installed algorithms have been loaded at least once.
load_algorithms(self)	Load locally installed algorithms in the registry.
load_cpp_algorithm(self, path)	Load C++ algorithm to Ikomia registry.
load_cpp_algorithms(self)	Load locally installed C++ algorithms in the registry.
load_python_algorithm(self, path)	Load Python algorithm to Ikomia registry.
load_python_algorithms(self)	Load locally installed Python algorithms in the registry.
register_io(self, factory)	Add new input/output factory to Ikomia registry.
register_task(self, factory)	Add new algorithm factory to Ikomia registry.
set_plugins_directory(self, directory)	Set directory where Ikomia plugins are stored.

Details

__init__((object)arg1) → None

__init__( (object)self) -> None :

Default constructor

create_instance((CIkomiaRegistry)self, (str)name) → CWorkflowTask :

Instanciate algorithm of the Ikomia registry from its name with default parameters.

The full list of available algorithms can be retrieved using get_algorithms().

Args:

algorithm name(str): unique name

Returns:

CWorkflowTask or derived: algorithm instance

create_instance( (CIkomiaRegistry)self, (str)name, (CWorkflowTaskParam)parameters) -> CWorkflowTask :

Instanciate algorithm of the Ikomia registry from its name with the given parameters. The full list of available algorithms can be retrieved using get_algorithms().

Args:

algorithm name(str): unique name

parameters object(CWorkflowTaskParam): associated parameters

Returns:

CWorkflowTask or derived: algorithm instance

get_algorithms((CIkomiaRegistry)self)) → object :

Get all available algorithms from the Ikomia registry. Before using an algorithm, you must instanciate it from its name using create_instance().You can only instanciate algorithms whose name is in the returned list.

Returns:

list of algorithm names

Return type:

string

get_algorithm_info((CIkomiaRegistry)self, (str)name) → CTaskInfo :

Get algorithm informations such as description, authors, documentation link…

Parameters:

name (str) – algorithm name

Returns:

algorithm information

Return type:

CTaskInfo

get_plugins_directory((CIkomiaRegistry)self) → str :

Get the current Ikomia plugins directory.

Returns:

full path to Ikomia plugins directory

Return type:

str

is_all_loaded((CIkomiaRegistry)self) → bool :

Return true if all locally installed algorithms have been loaded at least once.

Returns:

True or False

Return type:

bool

load_algorithms((CIkomiaRegistry)self) → None :

Load locally installed algorithms in the registry. After that, algorithms can be instanciated from their unique names.

load_cpp_algorithm((CIkomiaRegistry)self, (str)path) → None :

Load C++ algorithm to Ikomia registry.

Parameters:

path (str) – path to shared library of the plugin

load_cpp_algorithms((CIkomiaRegistry)self) → None :

Load locally installed C++ algorithms in the registry. After that, C++ algorithms can be instanciated from their unique names.

load_python_algorithm((CIkomiaRegistry)self, (str)path) → None :

Load Python algorithm to Ikomia registry.

Parameters:

path (str) – path module directory of the algorithm

load_python_algorithms((CIkomiaRegistry)self) → None :

Load locally installed Python algorithms in the registry. After that, Python algorithms can be instanciated from their unique names.

register_io((CIkomiaRegistry)self, (CWorkflowTaskIOFactory)factory) → None :

Add new input/output factory to Ikomia registry. Once registered, you are able to instanciate input or ouput and use it inside a task.

Parameters:

factory (CTaskIOFactory based object) – I/O factory

register_task((CIkomiaRegistry)self, (CTaskFactory)factory) → None :

Add new algorithm factory to Ikomia registry. Once registered, you are able to instanciate algorithm object and use it inside a workflow.

Parameters:

factory (CTaskFactory based object) – task factory

set_plugins_directory((CIkomiaRegistry)self, (str)directory) → None :

Set directory where Ikomia plugins are stored.

Parameters:

directory (str)