NetworkTypes.h

Go to the documentation of this file.

/*
* SPDX-FileCopyrightText: Copyright (c) 2020-2021 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
* SPDX-License-Identifier: MIT
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*/
 
#ifndef NVNEURAL_NETWORKTYPES_H
#define NVNEURAL_NETWORKTYPES_H
 
#include <nvneural/CoreTypes.h>
 
namespace nvneural {
 
#define NVNEURAL_INETWORK_OBJECTCLASS "com.nvidia.network"
 
    class ILayer;         // forward declaration
 
    class INetworkDebugger : public IRefObject
    {
    public:
        static const IRefObject::TypeId typeID = 0x44b2d2279e4abca9ul;
 
        virtual NeuralResult beginPass(ILayer** ppInferenceLayers, size_t layerCount) noexcept = 0;
 
        virtual NeuralResult beginNetwork(INetworkRuntime* pNetworkRuntime, ILayer* pModelLayer, ILayerList* pExternLayerList) noexcept = 0;
 
        virtual NeuralResult beginLayer(ILayer* pLayer) noexcept = 0;
 
        virtual NeuralResult skipLayer(ILayer* pLayer) noexcept = 0;
 
        virtual NeuralResult endLayer(ILayer* pLayer) noexcept = 0;
 
        virtual NeuralResult endNetwork(INetworkRuntime* pNetworkRuntime, ILayer* pModelLayer, ILayerList* pExternLayerList) noexcept = 0;
 
        virtual NeuralResult endPass() noexcept = 0;
    };
 
    class INetworkReshapeDebugger : public IRefObject
    {
    public:
        static const IRefObject::TypeId typeID = 0x6e2cb6b746e5f2dul;
 
        virtual NeuralResult beginReshapeLayer(ILayer* pLayer) noexcept = 0;
 
        virtual NeuralResult endReshapeLayer(ILayer* pLayer, NeuralResult reshapeStatus) noexcept = 0;
    };
 
    class INetwork : public INetworkRuntime
    {
    public:
        static const IRefObject::TypeId typeID = 0x9ce8f71bf65288e9ul;
 
        virtual NeuralResult attachNetworkDebugger(INetworkDebugger* pDebugger) noexcept = 0;
 
        virtual NeuralResult detachNetworkDebugger(const INetworkDebugger* pDebugger) noexcept = 0;
 
        virtual NeuralResult detachAllNetworkDebuggers() noexcept = 0;
 
        virtual NeuralResult getNetworkDebuggers(INetworkDebuggerList** ppListOut) const noexcept = 0;
 
        virtual NeuralResult attachReshapeDebugger(INetworkReshapeDebugger* pDebugger) noexcept = 0;
 
        virtual NeuralResult detachReshapeDebugger(const INetworkReshapeDebugger* pDebugger) noexcept = 0;
 
        virtual NeuralResult detachAllReshapeDebuggers() noexcept = 0;
 
        virtual NeuralResult unload() noexcept = 0;
 
        virtual NeuralResult clearLayers() noexcept = 0;
 
 
        virtual NeuralResult attachBackend(INetworkBackend* pBackend) noexcept = 0;
 
        virtual NeuralResult setDefaultBackendId(NetworkBackendId backendId) noexcept = 0;
 
        virtual NeuralResult setDefaultTensorFormat(const TensorFormat& tensorFormat) noexcept = 0;
 
        virtual NeuralResult setNetworkName(const char* pName) noexcept = 0;
 
        virtual NeuralResult setOptimizationFlag(NetworkBackendId backendId, INetworkBackend::OptimizationCapability capability, bool enabled) noexcept = 0;
 
        virtual bool isOptimizationFlagEnabled(NetworkBackendId backendId, INetworkBackend::OptimizationCapability capability) const noexcept = 0;
 
        virtual NeuralResult setWeightsLoader(IWeightsLoader* pWeightsLoader) noexcept = 0;
 
        virtual NeuralResult pushLayer(ILayer* pLayer) noexcept = 0;
 
        virtual NeuralResult pushLayerAlias(const char* pAliasName, ILayer* pLayer) noexcept = 0;
 
 
        virtual NeuralResult synchronize() noexcept = 0;
 
        virtual NeuralResult bindCurrentThread() noexcept = 0;
 
        virtual NeuralResult clearLoadedWeights() noexcept = 0;
 
 
        virtual NeuralResult reshapeAll() noexcept = 0;
 
        virtual NeuralResult reshape(ILayerList* pMarkedLayers) noexcept = 0;
 
 
 
        virtual NeuralResult inferenceSubgraph(ILayerList* pInputs, ILayerList* pOutputs) noexcept = 0;
 
        virtual NeuralResult inference() noexcept = 0;
 
 
        virtual NeuralResult copyTensor(const ILayer* pSourceLayer, ILayer* pDestinationLayer) noexcept = 0;
 
        virtual NeuralResult setClassRegistry(const IClassRegistry* pRegistry) noexcept = 0;
 
        virtual const IClassRegistry* getClassRegistry() const noexcept = 0;
 
        virtual NeuralResult getWeightsNamesForLayer(IStringList** ppListOut, const ILayer* pLayer) const noexcept = 0;
 
        virtual IActivationFunction* defaultForwardActivationFunction(const ILayer* pLayer) const noexcept = 0;
 
        virtual NeuralResult getProcessedLayerInputList(const ILayer* pLayer, ILayerList** ppProcessedInputLayerList) const noexcept = 0;
    };
 
    class INetwork2 : public INetwork
    {
    public:
        static const IRefObject::TypeId typeID = 0x18ab6a1edda6c965ul;
 
        using INetwork::pushLayer;
 
        virtual NeuralResult pushLayer(ILayer* pLayer, const char* pTemplateParentName) noexcept = 0;
    };
 
    class INetwork3 : public INetwork2
    {
    public:
        static const IRefObject::TypeId typeID = 0xe1edc460da161c87ul;
 
        virtual void setBuildMode(bool enable) noexcept = 0;
 
        virtual bool buildModeRestrictionViolated() const noexcept = 0;
 
        virtual const char* getLastBuildModeViolationMessage() const noexcept = 0;
    };
}
#endif // NVNEURAL_NETWORKTYPES_H