API Reference / agent / tools / authoring /

skeleton.py

Starter template for a new algorithm.

Functions

Func

execute_algorithm_skeleton

Line 8
execute_algorithm_skeleton(**kwargs) -> Dict[str, Any]

Return a starter code skeleton for a new user algorithm.

Backs the tuiml_get_skeleton tool; delegates to tuiml.agent.user_algorithms.skeleton.

Parameters

kind
str = 'classifier'
Kind of algorithm to scaffold (e.g. 'classifier' or 'regressor'). Arrives via **kwargs, like all parameters below.
class_name
str = 'MyAlgorithm'
Name of the generated class.
version
str = '1.0.0'
Initial version string embedded in the skeleton.
description
str = 'Describe what your algorithm does.'
One-line description embedded in the skeleton docstring.

Returns

result
dict
Result dict from user_algorithms.skeleton with status and the generated skeleton code.