|On this page|
This node provides a variety of ways to partition work items based on their attributes.
Use Dynamic Partitioning
When on, the partitioner waits for all input work items to be generated before partitioning them. If the input work items are dynamic, then the partitioner has to wait for and depends on the parent(s) of those items.
Merge Input Attributes
When on, the partitioner merges the attributes of the work items in each partition and exports them to the partition itself.
Determines how to create partitions from the Attribute conditions.
A partition is created for each distinct attribute name in the upstream work items. All work item that have that attribute are put into the partition.
When the Partition Attributes Independently toggle is off, a single partition is created for work items that have all of the specified attributes.
Specific Attribute Values
The same as Attribute Name, but the rather than simply having the attribute the work items in the partition must also have a specific value for the attribute. The value is specified using the Value parameter in each of the conditions.
When the Partition Attributes Independently toggle is off, a single partition is created for work items that have all of the specified attribute values.
Distinct Attribute Values
A partition is created for each distinct value of the specified attribute in the list upstream work items. For example if the distinct attribute is an integer, all the work items that have a value of 0 will be placed in the same partition, all the items with a value of 1 in a different partition, etc. The values do no need to begin with zero or be consecutive.
When the Partition Attributes Independently toggle is off, the values are placed into a tuple and a partition is created for each unique tuple.
Similar to Attribute Name, except rather than using a multiparm the attributes are specified using an attribute pattern. One partition is created for each attribute name that matches the partition The partitions are ordered alphabetically by attribute name.
When the Partition Attributes Independently toggle is off, a single partition is created that contains all work items that have at least one attribute that matches the pattern.
Only available when Partition By is set to Distinct Attribute Values,or Attribute Pattern. When partitioning by values this parameter whether partitions are indexed in ascending or descending order based on their attribute values. When partitioning by pattern it determines if the matching attribute names should from sorted from A to Z or from Z to A.
Partition Attributes Independently
Determines if the Attribute conditions should be considered individually or as a collective, single condition.
Create Partition for Unmatched Items
When this toggle is enabled an extra partition will be created that contains all work items that failed to match the other Attribute conditions.
When Partition By is set to Attribute Pattern this parameter is used to determine which attributes should be used during the partitioning step. For example, using a pattern of
* ^foo would create a partition for each attribute, except for an attribute named
The number of attribute conditions.
The name of the attribute.
The type of the attribute, either Float, Integer, or String.
This parameter determines the attribute index that the condition should check.
When partitioning by Specific Attribute Value this parameter determines the attribute value that condition should check.
These are advanced parameters that provide finer control over the behavior of the partitioner.
Auto Remove Stale Dependencies
When on, the partitioner removes old dependencies when recooking the node if the partitioning scheme changes as a result of the cook.
Force Re-Evaluation on Cook
When on, forces the partitioner to re-evaluate the partitioning scheme even if all of the work items are already cooked and no new work items have been added.
Determines when a partition is dirtied and the effects on child items when that occurs. This is particularity useful for working around some of the limitations of using dynamic partitioning.
A given partition is dirtied when any of the work items in the partition are dirtied. In the case of dynamic partitioning, if any ancestor of a dynamic work item in a partition is dirtied, then all partitions are dirtied.
When a partition is dirtied, all of its children are deleted.
The same dirtying behavior as Standard, except when a partition is dirtied, its children are dirtied instead of deleted.
A given partition is only dirtied if an item in the partition is dirtied or if the partition’s contents change as a result of a recook. When the partition is dirtied, any child work items are deleted.
The same dirtying behavior as Mapping Standard, except when a partition is dirtied, its children are dirtied instead of deleted.
Split by Attribute
When on, the node splits input work items by the specified attribute before partitioning them. The partitioning logic is evaluated on the list of work items for each distinct attribute value. Work items with different attribute values are always put into different partitions.
Determines how the node handles work items that are missing the split attribute.
This parameter is only available when Split by Attribute is on.
Ignore Work Item
Work items that are missing the split attribute are not put into any of the partitions.
Partitioner Defines Behavior
The partitioner node determines what happens to work items that are missing the split attribute. Typically a partitioner node that exposes this option will rename this menu entry to describe the actual operation it performs.
Add Work Item to All Partitions
Work items that are missing the split attribute are put into all of the partitions.
Sort Contents By
Determines the order that work items are sorted in when accessing the partitions on this node. This also affects the sort order of output files on the partition.
No sorting is applied. The work items in the partition are handled in no particular order.
Work Item Index
Work items in the partition are sorted based on their index.
Input Node Order
Work items in the partition are sorted based on the order of input nodes wired into this node. If two work items are from the same input, they are then sorted by index.
Work items in the partition are sorted based on the attribute specified in the Sort Attribute field parameter.
Determines whether the work items in this node’s partitions are sorted in ascending or descending order.
Specifies the name of the attribute to sort by.
This parameter is only available when Sort Contents By is set to Attribute.
Determines when the partitioning step is performed on the input work items.
This parameter is only available when Use Dynamic Partitioning is on.
Input Items Are Generated
Inputs are partitioned once all of them have been generated.
Input Items Are Cooked
Inputs are partitioned once all of them are cooked. This is required when the partitioning scheme is based on the results of the work items' execution.
This makes this partitioner behave like a Wait for All node except that it may create multiple partitions.
Specifies the target TOP node for the partition. The partition scheme is applied to the work items in the target TOP node instead of this node’s input work items. The target TOP node must be a processor in the same graph above this node, and there cannot be any other mappers or partitioners between this node and the target.
This parameter is only available when Use Dynamic Partitioning is on.