reference/generated/torchrl.services.Service

Run in Google Colab

Colab

Download Notebook

Notebook

View on GitHub

GitHub

Service

class torchrl.services.Service(*args, **kwargs)

Owner-side contract for a long-lived TorchRL service.

A service owns lifecycle and heavy resources. client() returns the lightweight capability that may be passed to worker processes or actors; that client intentionally has no start or shutdown methods.

Examples

>>> from torchrl.record.loggers import CSVLogger
>>> logger = CSVLogger(exp_name="example", log_dir="/tmp")
>>> _ = logger.start()
>>> logger.client() is logger
True
>>> logger.shutdown()

client() → ClientT

Return a cheap, picklable, capability-restricted client.

property is_alive: bool

Whether the owned service is running.

shutdown(timeout: float | None = None) → None

Stop the owned service and release its resources.

start() → Self

Start the owned service and return self.