https://github.com/ikomia-dev/create_ikomia_algorithm
https://github.com/ikomia-dev/create_ikomia_algorithm
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ikomia-dev/create_ikomia_algorithm
- Owner: Ikomia-dev
- License: apache-2.0
- Created: 2022-10-04T08:23:38.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-10-04T13:29:13.000Z (almost 4 years ago)
- Last Synced: 2025-04-12T04:30:08.479Z (over 1 year ago)
- Language: Python
- Size: 10.7 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# create_ikomia_algorithm
Python script to create skeleton code of an Ikomia algorithm. It produces minimal code to ensure Ikomia format conformity of the future algorithm. When completed, the new algorithm can be used in **Ikomia Studio** or **Ikomia API**. Then, you have to integrate your own algorithm code, the main entry point being the *run()* function of the Python process file. Please read the [documentation](https://ikomia-dev.github.io/python-api-documentation/) for details.
## Usage
Python >= 3.7
python create_ikomia_algorithm.py name [--process_base algo_base_class] [--qt Qt framework]
where:
- **name** (mandatory): algorithm name (must be unique). Please consult the naming convention [here](https://ikomia-dev.github.io/python-api-documentation/naming.html).
- **--process_base** (optional): Ikomia API base class from which the algorithm is derived. **Default: CWorkflowTask**. List of possible base classes [here](https://ikomia-dev.github.io/python-api-documentation/_autosummary/ikomia.dataprocess.pydataprocess.html).
- **--qt** (optional): name of the Python Qt framework. Possible values are **pyqt** (recommended) or **pyside**.