Commit deae83d7 authored by Adam Rogowiec's avatar Adam Rogowiec Committed by arogowie-intel

Add more doc to ActivationFunction.

parent 714fc13a
...@@ -17,6 +17,7 @@ ...@@ -17,6 +17,7 @@
#include <cmath> #include <cmath>
#include <functional> #include <functional>
#include <iterator> #include <iterator>
#include <memory>
#include <unordered_map> #include <unordered_map>
#include "activation_functions.hpp" #include "activation_functions.hpp"
......
...@@ -73,6 +73,9 @@ namespace ngraph ...@@ -73,6 +73,9 @@ namespace ngraph
float, float,
float); float);
///
/// \brief Class representing activation function used in RNN cells.
///
class ActivationFunction class ActivationFunction
{ {
public: public:
...@@ -80,13 +83,19 @@ namespace ngraph ...@@ -80,13 +83,19 @@ namespace ngraph
ActivationFunction(ActivationFunctionType f, float alpha); ActivationFunction(ActivationFunctionType f, float alpha);
ActivationFunction(ActivationFunctionType f); ActivationFunction(ActivationFunctionType f);
///
/// \brief Calls stored activation function with provided node argument.
///
std::shared_ptr<Node> operator()(const std::shared_ptr<Node>& arg) const; std::shared_ptr<Node> operator()(const std::shared_ptr<Node>& arg) const;
void set_alpha(float alpha) { m_alpha = alpha; } void set_alpha(float alpha) { m_alpha = alpha; }
void set_beta(float beta) { m_beta = beta; } void set_beta(float beta) { m_beta = beta; }
private: private:
/// \brief Activation function wrapper.
ActivationFunctionType m_function; ActivationFunctionType m_function;
/// \brief Activation function alpha parameter (may be unused).
float m_alpha; float m_alpha;
/// \brief Activation function beta parameter (may be unused).
float m_beta; float m_beta;
}; };
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment