NonLinearity.hpp

Go to the documentation of this file.

// Copyright (c) 2016 Graphcore Ltd. All rights reserved.
#ifndef popnn_NonLinearity_hpp
#define popnn_NonLinearity_hpp
 
#include <popnn/NonLinearityDef.hpp>
 
#ifndef __POPC__
#include <poplar/Graph.hpp>
#include <poplar/Program.hpp>
 
namespace popnn {
 
#define DEF_NONLINEARITY_INPLACE(fn, nlType)                                   \
  inline void fn##InPlace(poplar::Graph &graph, poplar::Tensor t,              \
                          poplar::program::Sequence &prog,                     \
                          const poplar::DebugContext &debugContext = {}) {     \
    nonLinearityInPlace(graph, nlType, t, prog, debugContext);                 \
  }                                                                            \
  inline void fn##InPlace(poplar::Graph &graph, poplar::Tensor t,              \
                          float &nonLinearityScaling,                          \
                          poplar::program::Sequence &prog,                     \
                          const poplar::DebugContext &debugContext = {}) {     \
    nonLinearityInPlace(graph, nlType, t, nonLinearityScaling, prog,           \
                        debugContext);                                         \
  }
 
#define DEF_NONLINEARITY_(fn, nlType)                                          \
  inline poplar::Tensor fn(poplar::Graph &graph, poplar::Tensor t,             \
                           poplar::program::Sequence &prog,                    \
                           const poplar::DebugContext &debugContext = {}) {    \
    return nonLinearity(graph, nlType, t, prog, debugContext);                 \
  }                                                                            \
  inline poplar::Tensor fn(poplar::Graph &graph, poplar::Tensor t,             \
                           float &nonLinearityScaling,                         \
                           poplar::program::Sequence &prog,                    \
                           const poplar::DebugContext &debugContext = {}) {    \
    return nonLinearity(graph, nlType, t, nonLinearityScaling, prog,           \
                        debugContext);                                         \
  }
 
#define DEF_NONLINEARITY(fn, nlType)                                           \
  DEF_NONLINEARITY_INPLACE(fn, nlType)                                         \
  DEF_NONLINEARITY_(fn, nlType)
 
void nonLinearityInPlace(poplar::Graph &graph,
                         NonLinearityType nonLinearityType, poplar::Tensor t,
                         poplar::program::Sequence &prog,
                         const poplar::DebugContext &debugContext = {});
 
void nonLinearityInPlace(poplar::Graph &graph,
                         NonLinearityType nonLinearityType, poplar::Tensor t,
                         poplar::ComputeSet &cs,
                         const poplar::DebugContext &debugContext = {});
 
void nonLinearityInPlace(poplar::Graph &graph,
                         NonLinearityType nonLinearityType, poplar::Tensor t,
                         float &nonLinearityScaling,
                         poplar::program::Sequence &prog,
                         const poplar::DebugContext &debugContext = {});
 
void nonLinearityInPlace(poplar::Graph &graph,
                         NonLinearityType nonLinearityType, poplar::Tensor t,
                         float &nonLinearityScaling, poplar::ComputeSet &cs,
                         const poplar::DebugContext &debugContext = {});
 
poplar::Tensor nonLinearity(poplar::Graph &graph,
                            NonLinearityType nonLinearityType, poplar::Tensor t,
                            poplar::program::Sequence &prog,
                            const poplar::DebugContext &debugContext = {});
 
poplar::Tensor nonLinearity(poplar::Graph &graph,
                            NonLinearityType nonLinearityType, poplar::Tensor t,
                            float &nonLinearityScaling,
                            poplar::program::Sequence &prog,
                            const poplar::DebugContext &debugContext = {});
 
DEF_NONLINEARITY(sigmoid, NonLinearityType::SIGMOID)
DEF_NONLINEARITY(relu, NonLinearityType::RELU)
DEF_NONLINEARITY(tanh, NonLinearityType::TANH)
DEF_NONLINEARITY(gelu, NonLinearityType::GELU)
DEF_NONLINEARITY(swish, NonLinearityType::SWISH)
DEF_NONLINEARITY(softmax, NonLinearityType::SOFTMAX)
DEF_NONLINEARITY(softmaxStable, NonLinearityType::SOFTMAX_STABLE)
DEF_NONLINEARITY(scaledSoftmaxStable, NonLinearityType::SOFTMAX_SCALED)
 
 
poplar::Tensor
nonLinearityInputGradient(poplar::Graph &graph,
                          NonLinearityType nonLinearityType, poplar::Tensor act,
                          poplar::Tensor outGradient, poplar::ComputeSet &cs,
                          const poplar::DebugContext &debugContext = {});
 
poplar::Tensor nonLinearityInputGradient(
    poplar::Graph &graph, NonLinearityType nonLinearityType, poplar::Tensor act,
    poplar::Tensor outGradient, poplar::program::Sequence &prog,
    const poplar::DebugContext &debugContext = {});
 
} // end namespace popnn
 
#endif // !__POPC__
 
#endif // popnn_NonLinearity_hpp