The watcher.api.controllers.v1.scoring_engine Module¶

A Scoring Engine is an executable that has a well-defined input, a well-defined output, and performs a purely mathematical task. That is, the calculation does not depend on the environment in which it is running - it would produce the same result anywhere.

Because there might be multiple algorithms used to build a particular data model (and therefore a scoring engine), the usage of scoring engine might vary. A metainfo field is supposed to contain any information which might be needed by the user of a given scoring engine.

class watcher.api.controllers.v1.scoring_engine.ScoringEngine(**kwargs)[source]¶

Bases: watcher.api.controllers.base.APIBase

API representation of a scoring engine.

This class enforces type checking and value constraints, and converts between the internal object model and the API representation of a scoring engine.

classmethod convert_with_links(scoring_engine, expand=True)[source]¶

classmethod sample(expand=True)[source]¶

class watcher.api.controllers.v1.scoring_engine.ScoringEngineCollection(**kwargs)[source]¶

Bases: watcher.api.controllers.v1.collection.Collection

API representation of a collection of scoring engines.

static convert_with_links(scoring_engines, limit, url=None, expand=False, **kwargs)[source]¶

classmethod sample()[source]¶

class watcher.api.controllers.v1.scoring_engine.ScoringEngineController[source]¶

Bases: pecan.rest.RestController

REST controller for Scoring Engines.

detail(*args, **kwargs)[source]¶

Retrieve a list of Scoring Engines with detail.

Parameters:	marker – pagination marker for large data sets. limit – maximum number of resources to return in a single result. sort_key – column to sort results by. Default: name. sort_dir – direction to sort. “asc” or “desc”. Default: asc.

get_all(*args, **kwargs)[source]¶

Retrieve a list of Scoring Engines.

Parameters:	marker – pagination marker for large data sets. limit – maximum number of resources to return in a single result. sort_key – column to sort results by. Default: name. sort_dir – direction to sort. “asc” or “desc”. Default: asc.

get_one(*args, **kwargs)[source]¶

Retrieve information about the given Scoring Engine.

Parameters:	scoring_engine_name – The name of the Scoring Engine.