從流構建 tensordicts

作者：Vincent Moens

在許多實際應用中，資料是連續生成的，並且頻率各不相同。

例如，來自 IoT 裝置、金融交易或社交媒體更新的感測器讀數都可以產生需要即時處理和分析的資料流。

在處理此類資料流時，通常需要將傳入資料“分桶”成離散塊，以便進行高效處理和分析。然而，當處理頻率或格式不同的資料流時，這可能會很困難。

在本教程中，我們將探討如何使用 TensorDict 來構建和操作資料流。我們將學習如何建立張量的惰性堆疊，處理非同步資料流，以及使我們的資料密集化以便高效儲存和處理。

在本教程中，您將學習： - 如何讀取資料流並在 tensordict 內以固定間隔寫入； - 如何構建可以堆疊具有異構形狀的張量的 TensorDict； - 如果需要，如何使用 nested_tensor 在單個儲存中使這些張量密集化。

堆疊異構 tensordicts

在許多實際場景中，資料以不同定義頻率的流形式到來。

本教程的目標是將即將到來的資料“分桶”，以便以給定的較慢頻率讀取和處理。此場景中的挑戰在於，資料可能無法表示為規則的“矩形”格式（即，其中張量的每個維度都被很好地定義），但可能會出現一種情況是，一個數據塊比另一個數據塊包含更多元素，在這種情況下，我們無法簡單地將它們堆疊在一起。通常，考慮第一和第二個資料塊如下的情況

import torch
from tensordict import TensorDict

bucket0 = TensorDict(stream0=torch.randn(5), stream1=torch.randn(4))
bucket1 = TensorDict(stream0=torch.randn(4), stream1=torch.randn(5))

原則上，我們無法在記憶體中連續堆疊這兩個 tensordict，因為兩個流的形狀不同。幸運的是，TensorDict 提供了一種工具來將具有異構張量形狀的例項分組在一起：LazyStackedTensorDict。要建立惰性堆疊，只需呼叫 lazy_stack()

data = TensorDict.lazy_stack([bucket0, bucket1], dim=0)
print(data)

LazyStackedTensorDict(
    fields={
        stream0: Tensor(shape=torch.Size([2, -1]), device=cpu, dtype=torch.float32, is_shared=False),
        stream1: Tensor(shape=torch.Size([2, -1]), device=cpu, dtype=torch.float32, is_shared=False)},
    exclusive_fields={
    },
    batch_size=torch.Size([2]),
    device=None,
    is_shared=False,
    stack_dim=0)

生成的資料只是對兩個 tensordicts 的表示，就好像它們已沿維度 0 堆疊在一起一樣。LazyStackedTensorDict 支援 TensorDictBase 類的最常見操作，以下是一些示例

data_select = data.select("stream0")
data_plus_1 = data + 1
data_apply = data.apply(lambda x: x + 1)

此外，對其進行索引將返回我們用來建立堆疊的原始資料

assert data[0] is bucket0

儘管如此，在某些情況下，您可能希望獲得底層資料的連續表示。為此，TensorDictBase 提供了一個 densify() 方法，該方法將堆疊可以堆疊的張量，並嘗試將其餘張量表示為 nested_tensor 例項

data_cont = data.densify()

非同步資料流

現在讓我們切換到一個更具體的例子，我們在其中建立一個以給定頻率流式傳輸資料（在這種情況下，只是在每次迭代中遞增 1 的整數）的函式。

為了線上程之間傳遞資料，該函式將使用接收到的佇列作為輸入

import asyncio
from typing import List


async def generate_numbers(frequency: float, queue: asyncio.Queue) -> None:
    i = 0
    while True:
        await asyncio.sleep(1 / frequency)
        await queue.put(i)
        i += 1

該 collect_data 函式從佇列中讀取資料，直到 timeout 時間過去，然後返回

async def collect_data(queue: asyncio.Queue, timeout: float) -> List[int]:
    values = []

    # We create a nested `collect` async function in order to be able to stop it as
    #  soon as timeout is passed (see wait_for below).
    async def collect():
        nonlocal values
        while True:
            value = await queue.get()
            values.append(value)

    task = asyncio.create_task(collect())
    try:
        await asyncio.wait_for(task, timeout=timeout)
    except asyncio.TimeoutError:
        task.cancel()
    return values

該 wait7hz 函式從佇列中讀取資料，直到給定時間過去。

async def wait7hz() -> None:
    queue = asyncio.Queue()
    generate_task = asyncio.create_task(generate_numbers(7, queue))
    collect_data_task = asyncio.create_task(collect_data(queue, timeout=1))
    values = await collect_data_task
    # The ``generate_task`` has not been terminated
    generate_task.cancel()
    print(values)


asyncio.run(wait7hz())

from typing import Callable, Dict

[0, 1, 2, 3, 4, 5]

我們現在可以設計一個繼承自 LazyStackedTensorDict 的類，該類讀取來自不同流的資料，並將它們註冊在單獨的 tensordicts 中。 LazyStackedTensorDict 的一個優點是它可以增量構建，這樣我們就可以透過擴充套件惰性堆疊來簡單地註冊新進來的資料，直到我們收集到足夠的資料。這是這個 StreamedTensorDict 類的實現

from tensordict import LazyStackedTensorDict, NestedKey, TensorDictBase


class StreamedTensorDict(LazyStackedTensorDict):
    """A lazy stack class that can be built from a dictionary of streams."""

    @classmethod
    async def from_streams(
        cls,
        streams: Dict[NestedKey, Callable],
        timeout: float,
        batch_size: int,
        densify: bool = True,
    ) -> TensorDictBase:
        td = cls(stack_dim=0)

        # We construct a queue for each stream
        queues = [asyncio.Queue() for _ in range(len(streams))]
        tasks = []
        for stream, queue in zip(streams.values(), queues):
            task = asyncio.create_task(stream(queue))
            tasks.append(task)
        for _ in range(batch_size):
            values_tasks = []
            for queue in queues:
                values_task = asyncio.create_task(collect_data(queue, timeout))
                values_tasks.append(values_task)
            values = await asyncio.gather(*values_tasks)
            td.append(TensorDict(dict(zip(streams.keys(), values))))

        # Cancel the generator tasks
        for task in tasks:
            task.cancel()
        if densify:
            return td.densify(layout=torch.strided)
        return td

最後，main 函式將組合流函式 stream0 和 stream1，並將它們傳遞給 StreamedTensorDict.from_streams 方法，該方法將收集 batch_size 批資料，每批持續 timeout=1 秒

async def main() -> TensorDictBase:
    def stream0(queue):
        return generate_numbers(frequency=7, queue=queue)

    def stream1(queue):
        return generate_numbers(frequency=3, queue=queue)

    # Running this should take about 10 seconds
    return await StreamedTensorDict.from_streams(
        {"bucket0": stream0, "bucket1": stream1}, timeout=1, batch_size=10
    )


td = asyncio.run(main())

print("TensorDict from stream", td)

TensorDict from stream TensorDict(
    fields={
        bucket0: Tensor(shape=torch.Size([10, -1]), device=cpu, dtype=torch.int64, is_shared=False),
        bucket1: Tensor(shape=torch.Size([10, -1]), device=cpu, dtype=torch.int64, is_shared=False)},
    batch_size=torch.Size([10]),
    device=None,
    is_shared=False)

讓我們表示來自兩個流的資料 - 應該等於 torch.arange()，數量為 batch_size * timeout * Hz

<=> 1 * 10 秒 * 3 或 7

print("bucket0 (7Hz, around 70 values)", td["bucket0"].values())
print("bucket1 (3Hz, around 30 values)", td["bucket1"].values())
print("shapes of bucket0 (7Hz, around 70 values)", td["bucket0"]._nested_tensor_size())

bucket0 (7Hz, around 70 values) tensor([ 0,  1,  2,  3,  4,  5,  6,  7,  8,  9, 10, 11, 12, 13, 14, 15, 16, 17,
        18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35,
        36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53,
        54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68])
bucket1 (3Hz, around 30 values) tensor([ 0,  1,  2,  3,  4,  5,  6,  7,  8,  9, 10, 11, 12, 13, 14, 15, 16, 17,
        18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28])
shapes of bucket0 (7Hz, around 70 values) tensor([[6],
        [7],
        [7],
        [7],
        [7],
        [7],
        [7],
        [7],
        [7],
        [7]])

結論

在本教程中，我們探討了使用 TensorDict 和非同步資料流的基礎知識。我們學習瞭如何建立張量的惰性堆疊，使用 asyncio 處理非同步資料流，以及如何使資料密集化以實現高效儲存和處理。

我們還看到了 TensorDict 和 LazyStackedTensorDict 如何用於簡化複雜的資料處理任務，例如對具有不同頻率的資料流進行分桶。透過利用 TensorDict 和 asyncio 的強大功能，您可以構建可擴充套件且高效的資料處理管道，以處理最苛刻的實際應用。

感謝您跟隨本教程！希望您覺得它有所幫助且內容豐富。