Class Progress

Declaration

Documentation

On creation we provide a set of keys or futures that interest us as well as
a scheduler.  We traverse through the scheduler's dependencies to find all
relevant keys on which our keys depend.  We then plug into the scheduler to
learn when our keys become available in memory at which point we record
their completion.

State
-----
keys: set
    Set of keys that are not yet computed
all_keys: set
    Set of all keys that we track

This class performs no visualization.  However it is used by other classes,
notably TextProgressBar and ProgressWidget, which do perform visualization.

Methods

• ▶ def __init__(self, keys, scheduler, minimum=0, dt=0.1, complete=False)

  source link

  Overrides

  This method is overriden in:

  • distributed.diagnostics.progress.MultiProgress
• ▶ def restart(self, scheduler) override

  inherited doc Run when the scheduler restarts itself

  source link

  This method overrides distributed.diagnostics.plugin.SchedulerPlugin.restart.

• ▷ def stop(self, exception=None, key=None)

  source link
• ▶ def transition(self, key, start, finish, *args, **kwargs) override

  inherited doc Run whenever a task changes state

  source link

  This method overrides distributed.diagnostics.plugin.SchedulerPlugin.transition.

  Parameters

  • key : string
  • start : string
    

    Start state of the transition.
    One of released, waiting, processing, memory, error.

  • finish : string
    

    Final state of the transition.

  • *args, **kwargs : More options passed when transitioning
    

    This may include worker ID, compute time, etc.

  Overrides

  This method is overriden in:

  • distributed.diagnostics.progress.MultiProgress

Inherited methods

• Methods inherited from distributed.diagnostics.plugin.SchedulerPlugin:
  add_client, add_worker, remove_client, remove_worker, update_graph

Subclasses

• distributed.diagnostics.progress.MultiProgress

Reexports

• Imported in distributed.diagnostics.progressbar.
• Imported in distributed.diagnostics.tests.test_progress.

Generated by nedoc v0.9 at 2020-12-29 14:05