StageBudget#

class scikitplot.corpus.StageBudget(max_calls=None, max_seconds=None)[source]#

Deterministic limits on the retrieve stage.

Parameters:

max_callsint or None, default=None

Queries retrieve may start (one index.search call each). None is no limit.

max_secondsfloat or None, default=None

Seconds after which retrieve starts no further query. A running call is not interrupted: its time is reported, and an overrun is in the stage’s details. None is no limit.

Raises:

TypeError

If a limit has the wrong type (bool included).

ValueError

If a limit is not positive (or not finite).

Parameters:

• max_calls (int | None)

• max_seconds (float | None)

max_calls: int | None = None#

max_seconds: float | None = None#

to_dict()[source]#

Return a JSON-compatible mapping.

Return type:

dict[str, Any]