From 6bb8cc1c4cd0c4d8eb52244e7c88b27e63c725bb Mon Sep 17 00:00:00 2001 From: Brian Beggs Date: Fri, 22 Nov 2024 12:17:18 -0800 Subject: [PATCH 1/2] Update host_api.hpp Added context and link to GitHub for CreateBuffer APIs. --- tt_metal/host_api.hpp | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/tt_metal/host_api.hpp b/tt_metal/host_api.hpp index 53a85dd7e97..e25e116d7da 100644 --- a/tt_metal/host_api.hpp +++ b/tt_metal/host_api.hpp @@ -283,7 +283,7 @@ std::unique_ptr CreateGlobalSemaphore( Device *device, CoreRangeSet &&cores, uint32_t initial_value, BufferType buffer_type = BufferType::L1); /** -* Creates a pre-allocated interleaved DRAM or L1 buffer with the global allocator on device +* Creates a pre-allocated interleaved DRAM or L1 buffer with the global allocator on the device. Interleaved buffers allow for frequent attribute access, improving performance by storing data locally. For more information about buffers visit the Tenstorrent GitHub: [Buffers info on GitHub](https://github.com/tenstorrent/tt-metal/tree/main/tt_metal/impl/buffers). * * Return value: std::shared_ptr * @@ -294,7 +294,7 @@ std::unique_ptr CreateGlobalSemaphore( std::shared_ptr CreateBuffer(const InterleavedBufferConfig &config); /** -* Creates a pre-allocated interleaved DRAM or L1 buffer with the global allocator on device +* Creates a pre-allocated interleaved DRAM or L1 buffer with the global allocator on the device. Interleaved buffers allow for frequent attribute access, improving performance by storing data locally. For more information about buffers visit the Tenstorrent GitHub: [Buffers info on GitHub](https://github.com/tenstorrent/tt-metal/tree/main/tt_metal/impl/buffers). * * Return value: std::shared_ptr * @@ -306,7 +306,7 @@ std::shared_ptr CreateBuffer(const InterleavedBufferConfig &config); std::shared_ptr CreateBuffer(const InterleavedBufferConfig &config, DeviceAddr address); /** -* Creates a pre-allocated interleaved DRAM or L1 buffer on device +* Creates a pre-allocated interleaved DRAM or L1 buffer with the global allocator on the device. Interleaved buffers allow for frequent attribute access, improving performance by storing data locally. For more information about buffers visit the Tenstorrent GitHub: [Buffers info on GitHub](https://github.com/tenstorrent/tt-metal/tree/main/tt_metal/impl/buffers). * * Return value: std::shared_ptr * @@ -318,7 +318,7 @@ std::shared_ptr CreateBuffer(const InterleavedBufferConfig &config, Devi std::shared_ptr CreateBuffer(const InterleavedBufferConfig &config, SubDeviceId sub_device_id); /** -* Creates a pre-allocated sharded DRAM or L1 buffer with the global allocator on device +* Creates a pre-allocated sharded DRAM or L1 buffer with the global allocator on the device. Sharded buffers use parallel processing to allow independent access to different data sets. For more information about buffers visit the Tenstorrent GitHub: [Buffers info on GitHub](https://github.com/tenstorrent/tt-metal/tree/main/tt_metal/impl/buffers). * * Return value: std::shared_ptr * @@ -329,7 +329,7 @@ std::shared_ptr CreateBuffer(const InterleavedBufferConfig &config, SubD std::shared_ptr CreateBuffer(const ShardedBufferConfig &config); /** -* Creates a pre-allocated sharded DRAM or L1 buffer with the global allocator on device +* Creates a pre-allocated sharded DRAM or L1 buffer with the global allocator on the device. Sharded buffers use parallel processing to allow independent access to different data sets. For more information about buffers visit the Tenstorrent GitHub: [Buffers info on GitHub](https://github.com/tenstorrent/tt-metal/tree/main/tt_metal/impl/buffers). * * Return value: std::shared_ptr * @@ -341,7 +341,7 @@ std::shared_ptr CreateBuffer(const ShardedBufferConfig &config); std::shared_ptr CreateBuffer(const ShardedBufferConfig &config, DeviceAddr address); /** -* Creates a pre-allocated sharded DRAM or L1 buffer on device +* Creates a pre-allocated sharded DRAM or L1 buffer with the global allocator on the device. Sharded buffers use parallel processing to allow independent access to different data sets. For more information about buffers visit the Tenstorrent GitHub: [Buffers info on GitHub](https://github.com/tenstorrent/tt-metal/tree/main/tt_metal/impl/buffers). * * Return value: std::shared_ptr * From ce0be15bf4141a506ff99d7995f753fa196d08a8 Mon Sep 17 00:00:00 2001 From: Brian Beggs Date: Wed, 27 Nov 2024 13:43:30 -0800 Subject: [PATCH 2/2] Update host_api.hpp CreateBuffer API description updated. --- tt_metal/host_api.hpp | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/tt_metal/host_api.hpp b/tt_metal/host_api.hpp index 94f3ccaf5f0..d2095be32e4 100644 --- a/tt_metal/host_api.hpp +++ b/tt_metal/host_api.hpp @@ -314,7 +314,7 @@ std::unique_ptr CreateGlobalSemaphore( // clang-format off /** -* Creates a pre-allocated interleaved DRAM or L1 buffer with the global allocator on the device. Interleaved buffers allow for frequent attribute access, improving performance by storing data locally. For more information about buffers visit the Tenstorrent GitHub: [Buffers info on GitHub](https://github.com/tenstorrent/tt-metal/tree/main/tt_metal/impl/buffers). +* Creates a pre-allocated interleaved DRAM or L1 buffer with the global allocator on the device. For more information about buffers visit the Tenstorrent GitHub: [Buffers info on GitHub](https://github.com/tenstorrent/tt-metal/tree/main/tt_metal/impl/buffers). * * Return value: std::shared_ptr * @@ -327,7 +327,7 @@ std::shared_ptr CreateBuffer(const InterleavedBufferConfig& config); // clang-format off /** -* Creates a pre-allocated interleaved DRAM or L1 buffer with the global allocator on the device. Interleaved buffers allow for frequent attribute access, improving performance by storing data locally. For more information about buffers visit the Tenstorrent GitHub: [Buffers info on GitHub](https://github.com/tenstorrent/tt-metal/tree/main/tt_metal/impl/buffers). +* Creates a pre-allocated interleaved DRAM or L1 buffer with the global allocator on the device. For more information about buffers visit the Tenstorrent GitHub: [Buffers info on GitHub](https://github.com/tenstorrent/tt-metal/tree/main/tt_metal/impl/buffers). * * Return value: std::shared_ptr * @@ -341,7 +341,7 @@ std::shared_ptr CreateBuffer(const InterleavedBufferConfig& config, Devi // clang-format off /** -* Creates a pre-allocated interleaved DRAM or L1 buffer with the global allocator on the device. Interleaved buffers allow for frequent attribute access, improving performance by storing data locally. For more information about buffers visit the Tenstorrent GitHub: [Buffers info on GitHub](https://github.com/tenstorrent/tt-metal/tree/main/tt_metal/impl/buffers). +* Creates a pre-allocated interleaved DRAM or L1 buffer with the global allocator on the device. IFor more information about buffers visit the Tenstorrent GitHub: [Buffers info on GitHub](https://github.com/tenstorrent/tt-metal/tree/main/tt_metal/impl/buffers). * * Return value: std::shared_ptr * @@ -355,7 +355,7 @@ std::shared_ptr CreateBuffer(const InterleavedBufferConfig& config, SubD // clang-format off /** -* Creates a pre-allocated sharded DRAM or L1 buffer with the global allocator on the device. Sharded buffers use parallel processing to allow independent access to different data sets. For more information about buffers visit the Tenstorrent GitHub: [Buffers info on GitHub](https://github.com/tenstorrent/tt-metal/tree/main/tt_metal/impl/buffers). +* Creates a pre-allocated sharded DRAM or L1 buffer with the global allocator on the device. For more information about buffers visit the Tenstorrent GitHub: [Buffers info on GitHub](https://github.com/tenstorrent/tt-metal/tree/main/tt_metal/impl/buffers). * * Return value: std::shared_ptr * @@ -368,7 +368,7 @@ std::shared_ptr CreateBuffer(const ShardedBufferConfig& config); // clang-format off /** -* Creates a pre-allocated sharded DRAM or L1 buffer with the global allocator on the device. Sharded buffers use parallel processing to allow independent access to different data sets. For more information about buffers visit the Tenstorrent GitHub: [Buffers info on GitHub](https://github.com/tenstorrent/tt-metal/tree/main/tt_metal/impl/buffers). +* Creates a pre-allocated sharded DRAM or L1 buffer with the global allocator on the device. For more information about buffers visit the Tenstorrent GitHub: [Buffers info on GitHub](https://github.com/tenstorrent/tt-metal/tree/main/tt_metal/impl/buffers). * * Return value: std::shared_ptr * @@ -382,7 +382,7 @@ std::shared_ptr CreateBuffer(const ShardedBufferConfig& config, DeviceAd // clang-format off /** -* Creates a pre-allocated sharded DRAM or L1 buffer with the global allocator on the device. Sharded buffers use parallel processing to allow independent access to different data sets. For more information about buffers visit the Tenstorrent GitHub: [Buffers info on GitHub](https://github.com/tenstorrent/tt-metal/tree/main/tt_metal/impl/buffers). +* Creates a pre-allocated sharded DRAM or L1 buffer with the global allocator on the device. For more information about buffers visit the Tenstorrent GitHub: [Buffers info on GitHub](https://github.com/tenstorrent/tt-metal/tree/main/tt_metal/impl/buffers). * * Return value: std::shared_ptr *