nvneural::IOnnxGenerationGraphNode Class Reference

Tool-provided interface representing a NodeProto in an ONNX graph. More...

#include <nvneural/OnnxTypes.h>

Inheritance diagram for nvneural::IOnnxGenerationGraphNode:

Public Member Functions
virtual NeuralResult	addInput (const char *pName) noexcept=0
	Adds an input reference to the node. More...
virtual NeuralResult	addOutput (const char *pName) noexcept=0
	Adds an output reference to the node. More...
virtual NeuralResult	createAttribute (IOnnxGenerationGraphAttribute **ppAttrOut) noexcept=0
	Creates a new attribute for this node and returns it. More...
virtual NeuralResult	setDocString (const char *pDocString) noexcept=0
	Assigns a human-readable documentation string to the node. More...
virtual NeuralResult	setName (const char *pName) noexcept=0
	Sets the name of the node. More...
virtual NeuralResult	setOperatorSetDomain (const char *pDomain) noexcept=0
	Sets the operator set domain used by this node. More...
virtual NeuralResult	setOperatorType (const char *pOpType) noexcept=0
	Sets the operator type of the node. More...
Public Member Functions inherited from nvneural::IRefObject
virtual RefCount	addRef () const noexcept=0
	Increments the object's reference count. More...
virtual const void *	queryInterface (TypeId interface) const noexcept=0
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
virtual void *	queryInterface (TypeId interface) noexcept=0
	Retrieves a new object interface pointer. More...
virtual RefCount	release () const noexcept=0
	Decrements the object's reference count and destroy the object if the reference count reaches zero. More...

Static Public Attributes
static const IRefObject::TypeId	typeID = 0x9e2ed4d9912fa1aeul
	Interface TypeId for InterfaceOf purposes.
Static Public Attributes inherited from nvneural::IRefObject
static const TypeId	typeID = 0x14ecc3f9de638e1dul
	Interface TypeId for InterfaceOf purposes.

Additional Inherited Members
Public Types inherited from nvneural::IRefObject
using	RefCount = std::uint32_t
	Typedef used to track the number of active references to an object.
using	TypeId = std::uint64_t
	Every interface must define a unique TypeId. This should be randomized.
Protected Member Functions inherited from nvneural::IRefObject
virtual	~IRefObject ()=default
	A protected destructor prevents accidental stack-allocation of IRefObjects or use with other smart pointer classes like std::unique_ptr.

Detailed Description

Tool-provided interface representing a NodeProto in an ONNX graph.

Member Function Documentation

addInput()

virtual NeuralResult nvneural::IOnnxGenerationGraphNode::addInput ( const char *  pName )

pure virtualnoexcept

Adds an input reference to the node.

Names should come from the IOnnxGenerationHost::getLayerOutputName namespace. To represent a missing input, pass the empty string ("").

Parameters

pName

Name to reference.

addOutput()

virtual NeuralResult nvneural::IOnnxGenerationGraphNode::addOutput ( const char *  pName )

pure virtualnoexcept

Adds an output reference to the node.

Names should come from the IOnnxGenerationHost::getLayerOutputName namespace. To represent a missing output, pass the empty string ("").

With few exceptions, all layers should emit a node output with the same name as that returned by IOnnxGenerationHost::getLayerOutputName(this).

Parameters

pName

Name to define.

createAttribute()

virtual NeuralResult nvneural::IOnnxGenerationGraphNode::createAttribute ( IOnnxGenerationGraphAttribute **  ppAttrOut )

pure virtualnoexcept

Creates a new attribute for this node and returns it.

Parameters

ppAttrOut

Pointer receiving a new reference to an IOnnxGenerationGraphAttribute.

setDocString()

virtual NeuralResult nvneural::IOnnxGenerationGraphNode::setDocString ( const char *  pDocString )

pure virtualnoexcept

Assigns a human-readable documentation string to the node.

This function is optional.

Parameters

pDocString

New documentation string. Markdown is allowed.

setName()

virtual NeuralResult nvneural::IOnnxGenerationGraphNode::setName ( const char *  pName )

pure virtualnoexcept

Sets the name of the node.

This is optional in the current ONNX revision.

Parameters

pName

Node name. This is typically a name derived from ILayer::name.

setOperatorSetDomain()

virtual NeuralResult nvneural::IOnnxGenerationGraphNode::setOperatorSetDomain ( const char *  pDomain )

pure virtualnoexcept

Sets the operator set domain used by this node.

This is typically unnecessary; new nodes are initialized to a domain of "" (the onnx.ai default set).

Parameters

pDomain

Operator set domain to assign.

setOperatorType()

virtual NeuralResult nvneural::IOnnxGenerationGraphNode::setOperatorType ( const char *  pOpType )

pure virtualnoexcept

Sets the operator type of the node.

This is mandatory.

Parameters

pOpType

Operator type string.

---

The documentation for this class was generated from the following file:

• Core/Inc/nvneural/OnnxTypes.h