.. _omni_graph_tutorials_CpuGpuBundlesPy_1:

.. _omni_graph_tutorials_CpuGpuBundlesPy:

.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================

:orphan:

.. meta::
    :title: Tutorial Python Node: CPU/GPU Bundles
    :keywords: lang-en omnigraph node tutorials tutorials cpu-gpu-bundles-py


Tutorial Python Node: CPU/GPU Bundles
=====================================

.. <description>

This is a tutorial node. It exercises functionality for accessing data in bundles that are on the GPU as well as bundles whose CPU/GPU location is decided at runtime. The compute looks for bundled attributes named 'points' and, if they are found, computes the dot products. If the bundle on the output contains an integer array type named 'dotProducts' then the results are placed there, otherwise a new attribute of that name and type is created on the output bundle to hold the results. This node is identical to OgnTutorialCpuGpuBundles.ogn, except is is implemented in Python.

.. </description>


Installation
------------

To use this node enable :ref:`omni.graph.tutorials<ext_omni_graph_tutorials>` in the Extension Manager.


Inputs
------
.. csv-table::
    :header: "Name", "Type", "Descripton", "Default"
    :widths: 20, 20, 50, 10

    "CPU Input Bundle (*inputs:cpuBundle*)", "``bundle``", "Input bundle whose data always lives on the CPU", "None"
    "Results To GPU (*inputs:gpu*)", "``bool``", "If true then copy gpuBundle onto the output, otherwise copy cpuBundle", "False"
    "GPU Input Bundle (*inputs:gpuBundle*)", "``bundle``", "Input bundle whose data always lives on the GPU", "None"


Outputs
-------
.. csv-table::
    :header: "Name", "Type", "Descripton", "Default"
    :widths: 20, 20, 50, 10

    "Constructed Bundle (*outputs:cpuGpuBundle*)", "``bundle``", "This is the bundle with the merged data. If the 'gpu' attribute is set to true then this bundle's contents will be entirely on the GPU, otherwise it will be on the CPU.", "None"


Metadata
--------
.. csv-table::
    :header: "Name", "Value"
    :widths: 30,70

    "Unique ID", "omni.graph.tutorials.CpuGpuBundlesPy"
    "Version", "1"
    "Extension", "omni.graph.tutorials"
    "Icon", "ogn/icons/omni.graph.tutorials.CpuGpuBundlesPy.svg"
    "Has State?", "False"
    "Implementation Language", "Python"
    "Default Memory Type", "cpu"
    "Generated Code Exclusions", "None"
    "tags", "tutorial,bundle,gpu"
    "uiName", "Tutorial Python Node: CPU/GPU Bundles"
    "__tokens", "[""points"", ""dotProducts""]"
    "Categories", "tutorials"
    "Generated Class Name", "OgnTutorialCpuGpuBundlesPyDatabase"
    "Python Module", "omni.graph.tutorials"

