Skip to content

NodeOverrides

Source code in docs_src/capo_batch/types/node_overrides.py
class NodeOverrides(TypedDict, closed=True):
    num_nodes: NotRequired["capo_batch.types.integer.Integer"]
    """<p>The number of nodes to use with a multi-node parallel job. This value overrides the number of nodes that are specified in the job definition. To use this override, you must meet the following conditions:</p> <ul> <li> <p>There must be at least one node range in your job definition that has an open upper boundary, such as <code>:</code> or <code>n:</code>.</p> </li> <li> <p>The lower boundary of the node range that's specified in the job definition must be fewer than the number of nodes specified in the override.</p> </li> <li> <p>The main node index that's specified in the job definition must be fewer than the number of nodes specified in the override.</p> </li> </ul>"""
    node_property_overrides: NotRequired[
        "capo_batch.types.node_property_overrides.NodePropertyOverrides"
    ]
    """<p>The node property overrides for the job.</p>"""

node_property_overrides instance-attribute

node_property_overrides: NotRequired[NodePropertyOverrides]

The node property overrides for the job.

num_nodes instance-attribute

num_nodes: NotRequired[Integer]

The number of nodes to use with a multi-node parallel job. This value overrides the number of nodes that are specified in the job definition. To use this override, you must meet the following conditions:

  • There must be at least one node range in your job definition that has an open upper boundary, such as : or n:.

  • The lower boundary of the node range that's specified in the job definition must be fewer than the number of nodes specified in the override.

  • The main node index that's specified in the job definition must be fewer than the number of nodes specified in the override.