Skip to content

Commit

Permalink
minor comments
Browse files Browse the repository at this point in the history
  • Loading branch information
broskoTT committed Dec 9, 2024
1 parent f9643e7 commit fb73258
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
16 changes: 10 additions & 6 deletions device/api/umd/device/cluster.h
Original file line number Diff line number Diff line change
Expand Up @@ -662,7 +662,8 @@ class Cluster : public tt_device {
* @param skip_driver_allocs
* @param clean_system_resource Specifies if host state from previous runs needs to be cleaned up.
* @param perform_harvesting Allow the driver to modify the SOC descriptors per chip.
* @param simulated_harvesting_masks
* @param simulated_harvesting_masks Manually specify additional harvesting masks for the devices in the cluster.
* The ones defined by the devices itself have to be used, they will be merged with the ones passed here.
*/
Cluster(
const uint32_t& num_host_mem_ch_per_mmio_device = 1,
Expand All @@ -673,14 +674,15 @@ class Cluster : public tt_device {

/**
* Cluster constructor.
* This constructor can be used to target specific devices on the system.
* This constructor can be used to target only specific devices on the system.
*
* @param target_devices Devices to target.
* @param num_host_mem_ch_per_mmio_device Requested number of host channels (hugepages).
* @param skip_driver_allocs
* @param clean_system_resource Specifies if host state from previous runs needs to be cleaned up.
* @param perform_harvesting Allow the driver to modify the SOC descriptors per chip.
* @param simulated_harvesting_masks
* @param simulated_harvesting_masks Manually specify additional harvesting masks for the devices in the cluster.
* The ones defined by the devices itself have to be used, they will be merged with the ones passed here.
*/
Cluster(
const std::set<chip_id_t>& target_devices,
Expand All @@ -694,14 +696,16 @@ class Cluster : public tt_device {
* Cluster constructor.
* This constructor can be used with custom soc descriptors for the devices on the system.
*
* @param sdesc_path SOC descriptor yaml path specifying single chip. This represents default architecture and will
* be harvested according to the devices present in the cluster.
* @param sdesc_path SOC descriptor yaml path specifying single chip. The passed soc descriptor will be used as a
* default device description for devices in the cluster, but each chip will be harvested according to the
* harvesting info of the devices in the cluster.
* @param target_devices Devices to target.
* @param num_host_mem_ch_per_mmio_device Requested number of host channels (hugepages).
* @param skip_driver_allocs
* @param clean_system_resource Specifies if host state from previous runs needs to be cleaned up.
* @param perform_harvesting Allow the driver to modify the SOC descriptors per chip.
* @param simulated_harvesting_masks
* @param simulated_harvesting_masks Manually specify additional harvesting masks for the devices in the cluster.
* The ones defined by the devices itself have to be used, they will be merged with the ones passed here.
*/
Cluster(
const std::string& sdesc_path,
Expand Down
2 changes: 1 addition & 1 deletion tests/api/test_cluster.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ TEST(ApiClusterTest, DifferentConstructors) {

std::unique_ptr<Cluster> umd_cluster;

// 1. Simplest constructor. Creates Cluster with all the chips available
// 1. Simplest constructor. Creates Cluster with all the chips available.
umd_cluster = std::make_unique<Cluster>();
umd_cluster = nullptr;

Expand Down

0 comments on commit fb73258

Please sign in to comment.