retire_workers(self, comm=None, workers=None, remove=True, close_workers=False, names=None, lock=True, **kwargs) -> dict

Parameters

workers: list (optional) :

List of worker addresses to retire. If not provided we call workers_to_close which finds a good set

names: list (optional) :

List of worker names to retire.

remove: bool (defaults to True) :

Whether or not to remove the worker metadata immediately or else wait for the worker to contact us

close_workers: bool (defaults to False) :

Whether or not to actually close the worker explicitly from here. Otherwise we expect some external job scheduler to finish off the worker.

**kwargs: dict :

Extra options to pass to workers_to_close to determine which workers we should drop

Returns

Dictionary mapping worker ID/address to dictionary of information about

that worker for each retired worker.

Gracefully retire workers from cluster

See Also

Scheduler.workers_to_close

Examples

See :

Back References

The following pages refer to to this document either explicitly or contain code examples using this.

distributed.scheduler.Scheduler.workers_to_close

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them

---

File: /distributed/scheduler.py#6664
type: <class 'function'>
Commit: