Russell Bryant
e489ad7a21
- **Add SPDX license headers to python source files** - **Check for SPDX headers using pre-commit** commit 9d7ef44c3cfb72ca4c32e1c677d99259d10d4745 Author: Russell Bryant <rbryant@redhat.com> Date: Fri Jan 31 14:18:24 2025 -0500 Add SPDX license headers to python source files This commit adds SPDX license headers to python source files as recommended to the project by the Linux Foundation. These headers provide a concise way that is both human and machine readable for communicating license information for each source file. It helps avoid any ambiguity about the license of the code and can also be easily used by tools to help manage license compliance. The Linux Foundation runs license scans against the codebase to help ensure we are in compliance with the licenses of the code we use, including dependencies. Having these headers in place helps that tool do its job. More information can be found on the SPDX site: - https://spdx.dev/learn/handling-license-info/ Signed-off-by: Russell Bryant <rbryant@redhat.com> commit 5a1cf1cb3b80759131c73f6a9dddebccac039dea Author: Russell Bryant <rbryant@redhat.com> Date: Fri Jan 31 14:36:32 2025 -0500 Check for SPDX headers using pre-commit Signed-off-by: Russell Bryant <rbryant@redhat.com> --------- Signed-off-by: Russell Bryant <rbryant@redhat.com>
67 lines
2.0 KiB
Python
67 lines
2.0 KiB
Python
# SPDX-License-Identifier: Apache-2.0
|
|
"""
|
|
This file defines an interface `KVPipeBase`
|
|
that provides an abstraction for sending and receiving tensors, or None, via
|
|
distributed communications.
|
|
|
|
All classes instantiated from this interface are assumed to be a FIFO pipe.
|
|
|
|
If your distributed communication platform already supports key-value lookup,
|
|
you can bypass this interface and directly start from `kv_lookup_buffer`.
|
|
"""
|
|
|
|
from abc import ABC, abstractmethod
|
|
from typing import Optional
|
|
|
|
import torch
|
|
|
|
|
|
class KVPipeBase(ABC):
|
|
"""
|
|
This class provides an interface for sending and receiving tensors, or
|
|
None, by distributed communications.
|
|
"""
|
|
|
|
@abstractmethod
|
|
def send_tensor(self, tensor: Optional[torch.Tensor]) -> None:
|
|
"""Send a tensor, or None, via the pipe.
|
|
|
|
Need to support sending None -- important for error handling.
|
|
|
|
TODO: add a `key` argument so that we can use traditional
|
|
key-value database as the distributed communication mechanism behind
|
|
the pipe.
|
|
|
|
Args:
|
|
tensor (Optional[torch.Tensor]): The tensor to be sent. Can be None.
|
|
|
|
Raises:
|
|
NotImplementedError: This method must be implemented in subclasses.
|
|
"""
|
|
raise NotImplementedError
|
|
|
|
@abstractmethod
|
|
def recv_tensor(self) -> Optional[torch.Tensor]:
|
|
"""Receive a tensor (can be None) from the pipeline.
|
|
|
|
Returns:
|
|
Optional[torch.Tensor]: The tensor received from the pipeline. Can
|
|
be None.
|
|
|
|
Raises:
|
|
NotImplementedError: This method must be implemented in subclasses.
|
|
"""
|
|
raise NotImplementedError
|
|
|
|
@abstractmethod
|
|
def close(self) -> None:
|
|
"""Close the pipeline and release resources.
|
|
|
|
This method is responsible for closing the communication pipeline
|
|
and releasing any resources associated with it.
|
|
|
|
Raises:
|
|
NotImplementedError: This method must be implemented in subclasses.
|
|
"""
|
|
raise NotImplementedError
|