Starter templates for new user algorithms.

Functions

Func

skeleton

Line 93
skeleton(kind: str, class_name: str='MyAlgorithm', version: str='1.0.0', description: str='Describe what your algorithm does.') -> Dict[str, Any]

Return a ready-to-fill template for a new algorithm.

Parameters

kind
str
Either 'classifier' or 'regressor' (case-insensitive).
class_name
str = "MyAlgorithm"
Name of the generated class.
version
str = "1.0.0"
Semver version baked into the decorator.
description
str = "Describe what your algorithm does."
One-line description used as the module and class docstring.

Returns

result
Dict[str, Any]
On success: keys status, kind, class_name, version, code (the filled-in template source), and notes. On failure: keys status, error_type, error.