modalities.logging_broker package

Subpackages

• modalities.logging_broker.subscriber_impl package
  • Submodules
  • modalities.logging_broker.subscriber_impl.progress_subscriber module
    • DummyProgressSubscriber
      • DummyProgressSubscriber.consume_dict()
      • DummyProgressSubscriber.consume_message()
    • RichProgressSubscriber
      • RichProgressSubscriber.consume_dict()
      • RichProgressSubscriber.consume_message()
      • RichProgressSubscriber.register_live_display()
  • modalities.logging_broker.subscriber_impl.results_subscriber module
    • DummyResultSubscriber
      • DummyResultSubscriber.consume_dict()
      • DummyResultSubscriber.consume_message()
    • EvaluationResultToDiscSubscriber
      • EvaluationResultToDiscSubscriber.consume_dict()
      • EvaluationResultToDiscSubscriber.consume_message()
    • RichResultSubscriber
      • RichResultSubscriber.consume_dict()
      • RichResultSubscriber.consume_message()
    • WandBEvaluationResultSubscriber
      • WandBEvaluationResultSubscriber.consume_dict()
      • WandBEvaluationResultSubscriber.consume_message()
  • modalities.logging_broker.subscriber_impl.subscriber_factory module
    • ProgressSubscriberFactory
      • ProgressSubscriberFactory.get_dummy_progress_subscriber()
      • ProgressSubscriberFactory.get_rich_progress_subscriber()
    • ResultsSubscriberFactory
      • ResultsSubscriberFactory.get_dummy_result_subscriber()
      • ResultsSubscriberFactory.get_evaluation_result_to_disc_subscriber()
      • ResultsSubscriberFactory.get_rich_result_subscriber()
      • ResultsSubscriberFactory.get_wandb_result_subscriber()
  • Module contents

Submodules

modalities.logging_broker.message_broker module

class modalities.logging_broker.message_broker.MessageBroker

Bases: MessageBrokerIF

The MessageBroker sends notifications to its subscribers.

add_subscriber(subscription, subscriber)

Adds a single subscriber.

Parameters:

• subscription (MessageTypes)

• subscriber (MessageSubscriberIF)

distribute_message(message)

Distributes message to all subscribers.

Parameters:

message (Message)

class modalities.logging_broker.message_broker.MessageBrokerIF

Bases: ABC

Interface for message broker objects.

abstractmethod add_subscriber(subscription, subscriber)

Parameters:

• subscription (MessageTypes)

• subscriber (MessageSubscriberIF)

abstractmethod distribute_message(message)

Parameters:

message (Message)

modalities.logging_broker.messages module

class modalities.logging_broker.messages.ExperimentStatus(value)

Bases: Enum

EVALUATION = 'EVALUATION'

TRAIN = 'TRAIN'

class modalities.logging_broker.messages.Message(message_type, payload, global_rank=0, local_rank=0)

Bases: Generic[T]

An object representing a message.

Parameters:

• message_type (MessageTypes)

• payload (T)

• global_rank (int)

• local_rank (int)

global_rank: int = 0

local_rank: int = 0

message_type: MessageTypes = <dataclasses._MISSING_TYPE object>

payload: TypeVar(T) = <dataclasses._MISSING_TYPE object>

class modalities.logging_broker.messages.MessageTypes(value)

Bases: Enum

BATCH_PROGRESS_UPDATE = 'PROGRESS_UPDATE'

ERROR_MESSAGE = 'ERROR_MESSAGE'

EVALUATION_RESULT = 'EVALUATION_RESULT'

HIGH_LEVEL_PROGRESS_UPDATE = 'HIGH_LEVEL_PROGRESS_UPDATE'

class modalities.logging_broker.messages.ProgressUpdate(num_steps_done, experiment_status, dataloader_tag)

Bases: object

Object holding the state of the current batch / step computation progress.

Parameters:

• num_steps_done (int)

• experiment_status (ExperimentStatus)

• dataloader_tag (str)

dataloader_tag: str = <dataclasses._MISSING_TYPE object>

experiment_status: ExperimentStatus = <dataclasses._MISSING_TYPE object>

num_steps_done: int = <dataclasses._MISSING_TYPE object>

modalities.logging_broker.publisher module

class modalities.logging_broker.publisher.MessagePublisher(message_broker, global_rank, local_rank)

Bases: MessagePublisherIF[T]

The MessagePublisher sends messages through a message broker.

Parameters:

• message_broker (MessageBroker)

• global_rank (int)

• local_rank (int)

publish_message(payload, message_type)

Publish a message through the message broker.

Parameters:

• payload (T)

• message_type (MessageTypes)

class modalities.logging_broker.publisher.MessagePublisherIF

Bases: ABC, Generic[T]

abstractmethod publish_message(payload, message_type)

Parameters:

• payload (T)

• message_type (MessageTypes)

modalities.logging_broker.subscriber module

class modalities.logging_broker.subscriber.MessageSubscriberIF

Bases: ABC, Generic[T]

Interface for message subscribers.

abstractmethod consume_dict(message_dict)

Parameters:

message_dict (dict[str, Any])

abstractmethod consume_message(message)

Parameters:

message (Message[T])

Module contents