Graph Composer User Guide

Graph Composer

• Acronyms and Terms
• Introduction
  • Graph Composer Ecosystem
  • Contents of the release
• Getting Started
  • Overview
  • Installation
    • System Requirements
    • Installing the Composer
    • Installing the Composer on Windows
  • Getting Started with the Composer
  • Loading and Running an existing Graph
    • Loading an existing Graph
    • Running a Graph
  • Creating a Graph

• Graph Specification
  • Concepts
  • Graph File Format

Workflows

• Application Workflow
  • Launch Composer
  • Sync Extensions
  • Load Graph
  • Deploy Graph
• Development Workflow
  • Sync Extensions
    • Using commandline
    • Using Composer UI
  • Develop New Extension
    • Using commandline
      • Generating a non-DeepStream (GStreamer) extension
      • Generating a DeepStream (GStreamer) extension
    • Using Composer UI
  • Create and test graph

Tools

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
    • 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
    • WebSocket streaming
    • WebRTC streaming
  • Restrictions
  • Trouble Shooting

• Graph Execution Engine

• 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 Overview

GXF

• Overview
  • GXF Core
  • GXF Extensions
• The GXF Scheduler
  • Greedy Scheduler
    • Greedy Scheduler Configuration
  • Multithread Scheduler
    • Multithread Scheduler Configuration
  • Epoch Scheduler
  • SchedulingTerms
    • PeriodicSchedulingTerm
    • CountSchedulingTerm
    • MessageAvailableSchedulingTerm
    • MultiMessageAvailableSchedulingTerm
    • BooleanSchedulingTerm
    • AsynchronousSchedulingTerm
    • DownsteamReceptiveSchedulingTerm
    • TargetTimeSchedulingTerm
    • ExpiringMessageAvailableSchedulingTerm
    • AND Combined
    • BTSchedulingTerm
• Behavior Trees
  • General Concept
  • Behavior Tree Codelets
    • Constant Behavior
    • Parallel Behavior
    • Repeat Behavior
    • Selector Behavior
    • Sequence Behavior
    • Switch Behavior
    • Timer Behavior
• Python Codelets
  • General Concepts
  • Implenting a Python Codelet
    • Implementing Class
    • Adding Python Codelet to the Graph
    • Accessing Parameters

Core APIs

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

Extensions Manual

• CudaExtension
  • Components
    • nvidia::gxf::CudaStream
    • nvidia::gxf::CudaStreamId
    • nvidia::gxf::CudaEvent
    • nvidia::gxf::CudaStreamPool
    • nvidia::gxf::CudaStreamSync
• DeepStream to Codelet Bridge
  • DeepStream to Codelet Bridge - NvDsToGxfBridge
  • Codelet to DeepStream Bridge - NvGxfToDsBridge
  • Translators - The INvDsGxfDataTranslator interface
  • Standard Translators
    • NvDsGxfObjectDataTranslator
    • NvDsGxfAudioClassificationDataTranslator
    • NvDsGxfOpticalFlowDataTranslator
    • NvDsGxfSegmentationDataTranslator
    • NvDsGxfInferTensorDataTranslator
• MultimediaExtension
  • Components
    • nvidia::gxf::AudioBuffer
    • nvidia::gxf::VideoBuffer
• NetworkExtension
  • Interfaces
  • Components
    • nvidia::gxf::TcpClient
    • nvidia::gxf::TcpServer
• NvCvTensorOpsExtension
  • Components
    • nvidia::cvcore::tensor_ops::Resize
    • nvidia::cvcore::tensor_ops::CropAndResize
    • nvidia::cvcore::tensor_ops::Normalize
    • nvidia::cvcore::tensor_ops::InterleavedToPlanar
    • nvidia::cvcore::tensor_ops::ConvertColorFormat
    • nvidia::cvcore::tensor_ops::Reshape
• NvDsActionRecognitionExt
  • Components
    • nvidia::deepstream::NvDsActionRecognition2D
    • nvidia::deepstream::NvDsActionRecognition3D
• NvDsAnalyticsExt
  • Components
    • nvidia::deepstream::NvDsAnalytics
• NvDsBaseExt
  • Interfaces
    • nvidia::deepstream::INvDsKeyboardInput
  • Components
    • nvidia::deepstream::NvDsStaticOutput
    • nvidia::deepstream::NvDsDynamicOutput
    • nvidia::deepstream::NvDsOnRequestOutput
    • nvidia::deepstream::NvDsStaticInput
    • nvidia::deepstream::NvDsOnRequestInput
    • nvidia::deepstream::NvDsMultiOutput
    • nvidia::deepstream::NvDsProbeConnector
    • nvidia::deepstream::NvDsProbe
    • nvidia::deepstream::NvDsConnection
    • nvidia::deepstream::NvDsMultiSrcConnection
    • nvidia::deepstream::NvDsKeyboardInput
    • nvidia::deepstream::NvDsScheduler
    • nvidia::deepstream::NvDsToGxfBridge
    • nvidia::deepstream::NvGxfToDsBridge
    • nvidia::deepstream::NvDsGxfObjectDataTranslator
    • nvidia::deepstream::NvDsGxfAudioClassificationDataTranslator
    • nvidia::deepstream::NvDsGxfOpticalFlowDataTranslator
    • nvidia::deepstream::NvDsGxfSegmentationDataTranslator
    • nvidia::deepstream::NvDsGxfInferTensorDataTranslator
    • nvidia::deepstream::NvDsQueue
    • nvidia::deepstream::NvDsTee
    • nvidia::deepstream::NvDsBufferSync
• NvDsCloudMsgExt
  • Components
    • nvidia::deepstream::NvDsMessage
    • nvidia::deepstream::NvDsMsgRelayTransmitter
    • nvidia::deepstream::NvDsMsgRelayReceiver
    • nvidia::deepstream::NvDsMsgBrokerC2DReceiver
    • nvidia::deepstream::NvDsMsgBrokerD2CTransmitter
    • nvidia::deepstream::NvDsMsgRelay
    • nvidia::deepstream::NvDsMsgBroker
    • nvidia::deepstream::NvDsMsgConverter
    • nvidia::deepstream::NvDsMsgConvBroker
• NvDsConverterExt
  • Components
    • nvidia::deepstream::NvDsVideoConvert
    • nvidia::deepstream::AudioConvert
    • nvidia::deepstream::AudioResample
• NvDsDewarperExt
  • Components
    • nvidia::deepstream::NvDsAisleFilter
    • nvidia::deepstream::NvDsBBoxFilter
    • nvidia::deepstream::NvDsDewarper
    • nvidia::deepstream::NvDsSpotChangeSignal
    • nvidia::deepstream::NvDsSpot
• NvDsInferenceExt
  • Components
    • nvidia::deepstream::NvDsModelUpdatedSignal
    • nvidia::deepstream::NvDsInferVideoPropertyController
    • nvidia::deepstream::NvDsInferVideo
    • nvidia::deepstream::NvDsAsr
    • nvidia::deepstream::NvDsInferAudio
    • nvidia::deepstream::NvDsPreProcess
• NvDsInferenceUtilsExt
  • Components
    • nvidia::deepstream::NvDsKittiDump
    • nvidia::deepstream::NvDsFpsMeasurement
    • nvidia::deepstream::NvDsLatencyMeasurement
    • nvidia::deepstream::NvDsAudioClassificationPrint
    • nvidia::deepstream::NvDsPerClassObjectCounting
    • nvidia::deepstream::NvDsModelEngineWatchOTFTrigger
    • nvidia::deepstream::NvDsRoiClassificationResultParse
    • nvidia::deepstream::NvDsMetaDeserialize
    • nvidia::deepstream::NvDsMetaSerialize
• NvDsInterfaceExt
  • Interfaces
    • nvidia::deepstream::INvDsElement
    • nvidia::deepstream::INvDsIO
    • nvidia::deepstream::INvDsInput
    • nvidia::deepstream::INvDsOutput
    • nvidia::deepstream::INvDsProbe
    • nvidia::deepstream::INvDsConnection
    • nvidia::deepstream::INvDsComponent
    • nvidia::deepstream::INvDsInPlaceDataHandler
    • nvidia::deepstream::INvDsAction
    • nvidia::deepstream::INvDsSignal
    • nvidia::deepstream::INvDsPropertyController
    • nvidia::deepstream::INvDsAudioTemplatePluginConfigComponent
    • nvidia::deepstream::INvDsVideoTemplatePluginConfigComponent
    • nvidia::deepstream::INvDsInferModelConfigComponent
    • nvidia::deepstream::INvDsGxfDataTranslator
  • Components
    • nvidia::deepstream::NvBufSurfaceHandle
    • nvidia::deepstream::NvBufAudioHandle
    • nvidia::deepstream::NvDsBatchMetaHandle
    • nvidia::deepstream::GstBufferHandle
• NvDsMuxDemuxExt
  • Components
    • nvidia::deepstream::NvDsStreamDemux
    • nvidia::deepstream::NvDsStreamMux
    • nvidia::deepstream::NvDsStreamDemuxNew
    • nvidia::deepstream::NvDsStreamMuxNew
• NvDsOutputSinkExt
  • Components
    • nvidia::deepstream::NvDsFakeSink
    • nvidia::deepstream::NvDsFileOut
    • nvidia::deepstream::NvDsVideoRendererPropertyController
    • nvidia::deepstream::NvDsVideoRenderer
    • nvidia::deepstream::NvDsRtspOut
    • nvidia::deepstream::XvImageSink
    • nvidia::deepstream::AlsaAudioRenderer
• NvDsOpticalFlowExt
  • Components
    • nvidia::deepstream::NvDsOpticalFlow
    • nvidia::deepstream::NvDsOpticalFlowVisual
• NvDsSampleExt
  • Components
    • nvidia::deepstream::NvDsSampleProbeMessageMetaCreation
    • nvidia::deepstream::NvDsSampleSourceManipulator
    • nvidia::deepstream::NvDsSampleVideoTemplateLib
    • nvidia::deepstream::NvDsSampleAudioTemplateLib
    • nvidia::deepstream::NvDsSampleC2DSmartRecordTrigger
    • nvidia::deepstream::NvDsSampleD2C_SRMsgGenerator
• NvDsSampleModelsExt
  • Components
    • nvidia::deepstream::NvDsResnet10_4ClassDetectorModel
    • nvidia::deepstream::NvDsSecondaryCarColorClassifierModel
    • nvidia::deepstream::NvDsSecondaryCarMakeClassifierModel
    • nvidia::deepstream::NvDsSecondaryVehicleTypeClassifierModel
    • nvidia::deepstream::NvDsSonyCAudioClassifierModel
    • nvidia::deepstream::NvDsCarDetector360dModel
• NvDsSourceExt
  • Components
    • nvidia::deepstream::NvDsSourceInfoLoader
    • nvidia::deepstream::NvDsStartSrAction
    • nvidia::deepstream::NvDsStopSrAction
    • nvidia::deepstream::NvDsSrDoneSignal
    • nvidia::deepstream::NvDsSingleSrcInput
    • nvidia::deepstream::NvDsSourceManipulationAction
    • nvidia::deepstream::NvDsMultiSourceSmartRecordAction
    • nvidia::deepstream::NvDsMultiSrcInput
    • nvidia::deepstream::NvDsMultiSrcWarpedInput
    • nvidia::deepstream::NvDsRecordAction
    • nvidia::deepstream::NvDsMultiSrcInputWithRecord
    • nvidia::deepstream::NvDsCameraSrcInput
    • nvidia::deepstream::VideoTestSrc
    • nvidia::deepstream::AudioTestSrc
    • nvidia::deepstream::AlsaAudioInput
• NvDsTemplateExt
  • Components
    • nvidia::deepstream::NvDsAudioTemplate
    • nvidia::deepstream::NvDsVideoTemplate
• NvDsTrackerExt
  • Components
    • nvidia::deepstream::NvDsTracker
• NvDsTranscodeExt
  • Components
    • nvidia::deepstream::NvDsJpegDecoder
    • nvidia::deepstream::NvDsVideoDecoder
    • nvidia::deepstream::NvDsH264Encoder
    • nvidia::deepstream::NvDsH265Encoder
• NvDsTritonExt
  • Components
    • nvidia::deepstream::NvDsTriton
• NvDsVisualizationExt
  • Components
    • nvidia::deepstream::NvDsOSDPropertyController
    • nvidia::deepstream::NvDsOSD
    • nvidia::deepstream::NvDsTiler
    • nvidia::deepstream::NvDsSegVisual
    • nvidia::deepstream::NvDsBlender
    • nvidia::deepstream::NvDsTilerEventHandler
• 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
• 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
• NvDsBodyPose2D
  • Components
    • nvidia::BodyPose2D::PostProcess
    • nvidia::BodyPose2D::BodyPose2dModel
    • nvidia::BodyPose2D::NvDsGxfBodypose2dDataTranslator
• NvDsEmotionExt
  • Components
    • nvidia::Emotion::NvDsEmotionTemplateLib
• NvDsFacialLandmarks
  • Components
    • nvidia::FacialLandmarks::PostProcess
    • nvidia::FacialLandmarks::PreProcess
    • nvidia::FacialLandmarks::FacialLandmarksPgieModel
    • nvidia::FacialLandmarks::FacialLandmarksSgieModel
    • nvidia::FacialLandmarks::FacialLandmarksSgieModelV2
    • nvidia::FacialLandmarks::NvDsGxfFacialLandmarksTranslator
• NvDsGazeExt
  • Components
    • nvidia::Gaze::NvDsGazeTemplateLib
    • nvidia::Gaze::NvDsGxfGazeDataTranslator
• NvDsGesture
  • Components
    • nvidia::Gesture::PreProcess
    • nvidia::Gesture::GestureModel
• NvDsHeartRateExt
  • Components
    • nvidia::HeartRate::NvDsHeartRateTemplateLib
    • nvidia::HeartRate::NvDsGxfHeartRateDataTranslator
• NvDs3dProcessingExt
  • Components
    • nvidia::deepstream::NvDs3dSrc
    • nvidia::deepstream::NvDs3dSink
    • nvidia::deepstream::NvDs3dFilter
    • nvidia::deepstream::NvDs3dDataDepthInfoLogger
    • nvidia::deepstream::NvDs3dDataColorInfoLogger
    • nvidia::deepstream::NvDs3dDataPointCloudInfoLogger
• NvDsUcxExt
  • Components
    • nvidia::deepstream::NvDsUcxClientSink
    • nvidia::deepstream::NvDsUcxClientSrc
    • nvidia::deepstream::NvDsUcxServerSink
    • nvidia::deepstream::NvDsUcxServerSrc
• NvDsUdpExt
  • Components
    • nvidia::deepstream::NvDsUdpSink
    • nvidia::deepstream::NvDsUdpSrc
• TensorRTExtension
  • Components
    • nvidia::gxf::TensorRtInference

FAQ Guide

FAQ Guide

• FAQ
  • General
  • Registry
  • Container Builder
  • Composer

Legal

Legal

• Graph Composer Legal Information
  • Notice
  • Trademarks
  • Copyright

Feedback

• Feedback form
  • Request Documentation Fix