RoutingPolicy#

class scikitplot.corpus.RoutingPolicy(rules=())[source]#

An ordered set of RoutingRule, one per shape.

Parameters:
rulesiterable of RoutingRule

Rules with unique shapes; shapes are reported in this order.

Raises:
TypeError

If a rule is not a RoutingRule.

ValueError

If two rules name one shape.

Parameters:

rules (tuple[RoutingRule, ...])

See also

route

Uses a policy to choose evidence paths.

Examples

>>> from scikitplot.corpus import DEFAULT_ROUTING_POLICY
>>> DEFAULT_ROUTING_POLICY.detect("How many sections are not about X?")
('aggregation', 'negation', 'hierarchy')
detect(query)[source]#

Return the shapes of query, in rule order.

Parameters:
querystr

The query text.

Returns:
tuple of str

Each detected shape once; empty for a plain query.

Parameters:

query (str)

Return type:

tuple[str, …]

legs_for(shapes)[source]#

Return the legs the given shapes need, each once, in rule order.

Parameters:

shapes (Iterable[str])

Return type:

tuple[LegKind, …]

rules: tuple[RoutingRule, ...] = ()#
property shapes: tuple[str, ...]#

Every shape this policy can report, in order.

with_rules(*rules, replace=False)[source]#

Return a policy with rules added.

Parameters:
*rulesRoutingRule

New rules, appended in order.

replacebool, default=False

Replace an existing rule of the same shape (keeping its position) instead of refusing it.

Returns:
RoutingPolicy
Raises:
ValueError

If a shape is already present and replace is false.

Parameters:
Return type:

RoutingPolicy