Create, list and delete user algorithm versions on disk.
Functions
create(name: str, kind: str, code: str, version: str='1.0.0', description: Optional[str]=None, force: bool=False) -> Dict[str, Any]
Persist, validate, and register a new user algorithm.
Parameters
name
str
Algorithm name; must be a valid Python identifier. Used as the directory name under
USER_ALGS_DIR.
kind
str
Either
'classifier' or 'regressor' (case-insensitive). Must match the base class of the decorated class in code.
code
str
Full Python source defining one
@classifier/@regressor class.
version
str
= "1.0.0"
Semver version (MAJOR.MINOR.PATCH).
description
str
Human-readable description; defaults to the class docstring's first line.
force
bool
= False
Overwrite an existing
name/version on disk.
Returns
result
Dict[str, Any]
On success: keys
status, registered_as (list of aliases), name, class_name, kind, version, source_hash, path, and usage_hint. On failure: keys status, error_type, error (and path for AlreadyExists).
list_all() -> Dict[str, Any]
List every user-authored algorithm on disk.
Returns
result
Dict[str, Any]
Keys
status, algorithms (list of dicts with name, class_name, kind, version, description, source_hash, path, versioned_alias), and count (or root when the directory does not exist yet).
delete(name: str, version: Optional[str]=None) -> Dict[str, Any]
Delete one version (or every version when version is None).
Parameters
name
str
Algorithm name (directory under
USER_ALGS_DIR).
version
str
Specific semver version to delete. When None, every version and the parent directory are removed.
Returns
result
Dict[str, Any]
On success: keys
status, name, removed_versions (list of version strings), and note. On failure: keys status, error_type, error.