Graph Composer User Guide

Introduction

• Acronyms and Terms
• Overview
  • Concepts
    • GXF (Graph eXecution Format)
    • Graph
    • Node
    • Components
    • Codelets
    • Subgraph
    • System
    • Edges / Connection
    • Messages
    • Extension
    • Graph eXecution Engine
  • Tools
    • Graph Composer
    • Registry
    • Container Builder
    • GXF CLI
  • Workflow

Platforms

• Ubuntu 20.04 LTS (x86_64)
  • Features Supported
  • System Requirements
  • Install
• Ubuntu 20.04 LTS (ARM64 Jetson)
  • Features Supported
  • System Requirements
  • Install
• Windows 10 (x86_64)
  • Features Supported
  • System Requirements

Getting Started

• Application Workflow
  • Launch Graph Composer
  • Sync Extensions
  • Create a Graph
  • Run Graph from Graph Composer
    • Local System
    • Remote System
  • Run Graph from Command line
  • Create Container Image from Graph Composer
    • Local System
    • Remote System
  • DeepStream Application
• Development Workflow
  • Sync Extensions
    • Using commandline
    • Using Composer UI
  • Develop New Extension
    • Using commandline
      • Generate an extension for GXF Codelet
      • Generate an extension for GXF wrapper of GstElement
    • Using Composer UI
  • Create and test graph

Graph eXecution Format

• Overview
  • GXF Core
  • GXF Extensions
• GXF Development Guide
  • Application Development Guide
    • LifeCycle of a Codelet
    • The GXF Scheduler
      • Greedy Scheduler
        • Greedy Scheduler Configuration
      • Multithread Scheduler
      • Epoch Scheduler
    • SchedulingTerms
      • PeriodicSchedulingTerm
      • CountSchedulingTerm
      • MessageAvailableSchedulingTerm
      • MultiMessageAvailableSchedulingTerm
      • BooleanSchedulingTerm
      • AsynchronousSchedulingTerm
      • DownstreamReceptiveSchedulingTerm
      • TargetTimeSchedulingTerm
      • ExpiringMessageAvailableSchedulingTerm
      • AND Combined
      • BTSchedulingTerm
    • Messages
      • Transmitter
      • Receiver
      • Transmitter Example
      • Receiver Example
    • Memory Management
  • Extensions Development Guide
    • Sample GXF Extension

Graph eXecution Engine

• Graph Execution Engine

GXF Core APIs

• GXF Core C APIs
  • Context
    • Create context
    • Create a context from a shared context
    • Destroy context
  • Extensions
    • Load Extensions from a file
    • Load Extension libraries
    • Load Metadata files
    • Register component
  • Graph Execution
    • Loads a list of entities from YAML file
    • Set the root folder for searching YAML files during loading
    • Loads a list of entities from YAML text
    • Activate all system components
    • Deactivate all System components
    • Starts the execution of the graph asynchronously
    • Interrupt the execution of the graph
    • Waits for the graph to complete execution
    • Runs all System components and waits for their completion
  • Entities
    • Create an entity
    • Activate an entity
    • Deactivate an entity
    • Destroy an entity
    • Find an entity
    • Find all entities
    • Increase reference count of an entity
    • Decrease reference count of an entity
    • Get status of an entity
    • Get state of an entity
    • Notify entity of an event
  • Components
    • Get component type identifier
    • Get component type name
    • Get component name
    • Get unique identifier of the entity of given component
    • Add a new component
    • Add component to entity interface
    • Find a component in an entity
    • Get type identifier for a component
    • Gets pointer to component
  • Primitive Parameters
    • 64-bit floating point
    • 64-bit signed integer
    • 64-bit unsigned integer
    • 32-bit signed integer
    • String parameter
    • Boolean
    • Handle
  • Vector Parameters
    • Set 1-D Vetor Parameters
    • Set 2-D Vetor Parameters
    • Get 1-D Vetor Parameters
    • Get 2-D Vetor Parameters
  • Information Queries
    • Get Meta Data about the GXF Runtime
    • Get description and list of components in loaded Extension
    • Get description and list of parameters of Component
    • Get parameter type description
    • Get flag type description
    • Get parameter description
    • Redirect logs to a file
  • Miscellaneous
    • Get string description of error
• GXF Python APIs
  • Context
    • Create context
    • Destroy context
  • Extensions
    • Load Extensions from a file
  • Graph
    • Loads a list of entities from YAML file
    • Activate all system components
    • Deactivate all System components
    • Starts the execution of the graph asynchronously
    • Waits for the graph to complete execution
    • Runs all System components and waits for their completion
  • Entities
    • Find an entity
    • Get status of an entity
  • Components
    • Find a component in an entity
  • Primitive Parameters
    • 64-bit floating point
    • 64-bit signed integer
    • 64-bit unsigned integer
    • 32-bit signed integer
    • String parameter
    • Boolean
    • Handle
  • Vector Parameters
    • Set 1-D Vetor Parameters
    • Set 2-D Vetor Parameters
    • Get 1-D Vetor Parameters
    • Get 2-D Vetor Parameters

Extensions Manual

• CudaExtension
  • Components
    • nvidia::gxf::CudaStream
    • nvidia::gxf::CudaStreamId
    • nvidia::gxf::CudaEvent
    • nvidia::gxf::CudaStreamPool
    • nvidia::gxf::CudaStreamSync
• GXF Stream Sync
  • Signaler
  • Waiter
  • GxfStreamExtension
    • Components
  • GXF Stream Sync Workflow
    • At the Signaler codelet
    • At the Waiter Codelet
    • Example
• StandardExtension
  • Interfaces
    • nvidia::gxf::Codelet
    • nvidia::gxf::Clock
    • nvidia::gxf::System
    • nvidia::gxf::Queue
    • nvidia::gxf::Router
    • nvidia::gxf::Transmitter
    • nvidia::gxf::Receiver
    • nvidia::gxf::Scheduler
    • nvidia::gxf::SchedulingTerm
    • nvidia::gxf::Allocator
    • nvidia::gxf::Monitor
  • Components
    • nvidia::gxf::RealtimeClock
    • nvidia::gxf::ManualClock
    • nvidia::gxf::SystemGroup
    • nvidia::gxf::MessageRouter
    • nvidia::gxf::RouterGroup
    • nvidia::gxf::DoubleBufferTransmitter
    • nvidia::gxf::DoubleBufferReceiver
    • nvidia::gxf::Connection
    • nvidia::gxf::PeriodicSchedulingTerm
    • nvidia::gxf::CountSchedulingTerm
    • nvidia::gxf::TargetTimeSchedulingTerm
    • nvidia::gxf::DownstreamReceptiveSchedulingTerm
    • nvidia::gxf::MessageAvailableSchedulingTerm
    • nvidia::gxf::MultiMessageAvailableSchedulingTerm
    • nvidia::gxf::ExpiringMessageAvailableSchedulingTerm
    • nvidia::gxf::BooleanSchedulingTerm
    • nvidia::gxf::AsynchronousSchedulingTerm
    • nvidia::gxf::GreedyScheduler
    • nvidia::gxf::MultiThreadScheduler
    • nvidia::gxf::BlockMemoryPool
    • nvidia::gxf::UnboundedAllocator
    • nvidia::gxf::Tensor
    • nvidia::gxf::Timestamp
    • nvidia::gxf::Metric
    • nvidia::gxf::JobStatistics
    • nvidia::gxf::Broadcast
    • nvidia::gxf::Gather
    • nvidia::gxf::TensorCopier
    • nvidia::gxf::TimedThrottler
    • nvidia::gxf::Vault
    • nvidia::gxf::Subgraph
    • nvidia::gxf::EndOfStream
    • nvidia::gxf::Synchronization
    • signed char
    • unsigned char
    • short int
    • short unsigned int
    • int
    • unsigned int
    • long int
    • long unsigned int
    • float
    • double
    • bool
  • Python Bindings
    • Clock
    • Receiver
    • Transmitter
    • PrimitiveType
    • Shape
    • MemoryStorageType
    • Tensor
    • Allocator
• Python Codelets
  • General Concepts
  • Implenting a Python Codelet
    • Implementing Class
    • Adding Python Codelet to the Graph
    • Accessing Parameters
    • Accessing other Components
• NetworkExtension
  • Interfaces
  • Components
    • nvidia::gxf::TcpClient
    • nvidia::gxf::TcpServer
• NvTritonExt
  • Components
    • nvidia::triton::TritonServer
    • nvidia::triton::TritonInferencerInterface
    • nvidia::triton::TritonInferencerImpl
    • nvidia::triton::TritonInferenceRequest
    • nvidia::triton::TritonInferenceResponse
    • nvidia::triton::TritonOptions
    • nvidia::triton::TritonRequestReceptiveSchedulingTerm
• SerializationExtension
  • Interfaces
    • nvidia::gxf::ComponentSerializer
  • Components
    • nvidia::gxf::EntityRecorder
    • nvidia::gxf::EntityReplayer
    • nvidia::gxf::StdComponentSerializer
• MultimediaExtension
  • Components
    • nvidia::gxf::AudioBuffer
    • nvidia::gxf::VideoBuffer
• VideoEncoderExtension
  • Components
    • nvidia::gxf::VideoEncoder
• VideoDecoderExtension
  • Components
    • nvidia::gxf::VideoDecoder
• Behavior Trees
  • General Concept
  • Behavior Tree Codelets
    • Constant Behavior
    • Parallel Behavior
    • Repeat Behavior
    • Selector Behavior
    • Sequence Behavior
    • Switch Behavior
    • Timer Behavior

Tools

• Registry
  • Repository Manager
    • NVIDIA Cloud Repository
    • Local Workspace
  • Cache
  • Extension Registration
  • Installing graphs for deployment
• Registry Command Line Interface
  • cache
  • repo
    • repo clean
    • repo list
    • repo info
    • repo sync
  • extn
    • extn add
    • extn sync
    • extn import
    • extn list
    • extn info
    • extn versions
    • extn variants
    • extn dependencies
  • comp
    • comp list
    • comp info
  • graph
    • graph install
• Composer
  • User Interface
    • Menu Bar
    • Context Menu
    • Toolbar
    • Component List
  • Create New Application
  • Open and Save Application Graphs
  • Compose an Application Graph
    • Finding the right component
    • Creating a Component Instance
    • Understanding the Component Handles
    • Linking and Unlinking components
    • Entity Node
    • Setting up a Connection from an Input to an Output
    • Changing the Component Properties
    • Editor Features
    • Subgraph
    • Backdrop
  • Run Graph
    • Options
  • Build Container Image
    • Options
  • Generate Gstreamer Extension
    • Options
  • Remote Access
    • Comparison of available options
  • Omniverse Streaming Client
    • Installation and Usage
    • Configuration
    • Server
    • Client
  • WebRTC streaming
    • Current Limitations:
  • Restrictions
  • Trouble Shooting
• Container Builder
  • Prerequisites
  • Container Builder Features
  • Container Builder Tool Usage
  • Run Container Builder
  • Container Builder Configuration
  • A Basic Example of Container Builder Configuration
  • A Multi-Stage Example
  • Container builder main control section specification
  • Container dockerfile stage section specification
• GXF Command Line Interface
  • stat
  • config
  • dump

FAQ Guide

• FAQ
  • General
  • Registry
  • Container Builder
  • Composer

Legal

• Graph Composer Legal Information
  • Notice
  • Trademarks
  • Copyright

Feedback

• Feedback form
  • Request Documentation Fix