shark::TanhSigmoidModel Class Reference
scaled Tanh sigmoid function More...
#include <shark/Models/SigmoidModel.h>
Inheritance diagram for shark::TanhSigmoidModel:
Public Member Functions | |
| SHARK_EXPORT_SYMBOL | TanhSigmoidModel (bool transform_for_unconstrained=true) |
| SHARK_EXPORT_SYMBOL double | sigmoid (double a) const |
| activation function \(g_{output}(x)\) More... | |
| SHARK_EXPORT_SYMBOL double | sigmoidDerivative (double ga) const |
| Computes the derivative of the activation function \(g_{output}(x)\) for the output given the last response of the model gx=g(x) More... | |
| std::string | name () const |
| From INameable: return the class name. More... | |
| Public Member Functions inherited from shark::SigmoidModel | |
| SHARK_EXPORT_SYMBOL | SigmoidModel (bool transform_for_unconstrained=true) |
| SHARK_EXPORT_SYMBOL RealVector | parameterVector () const |
| Return the parameter vector. More... | |
| SHARK_EXPORT_SYMBOL void | setParameterVector (RealVector const &newParameters) |
| std::size_t | numberOfParameters () const |
| Return the number of parameters. More... | |
| SHARK_EXPORT_SYMBOL void | setOffsetActivity (bool enable_offset) |
| bool | hasOffset () const |
| bool | slopeIsExpEncoded () const |
| boost::shared_ptr< State > | createState () const |
| Creates an internal state of the model. More... | |
| SHARK_EXPORT_SYMBOL void | eval (BatchInputType const &pattern, BatchOutputType &output, State &state) const |
| Standard interface for evaluating the response of the model to a batch of patterns. More... | |
| SHARK_EXPORT_SYMBOL void | eval (BatchInputType const &pattern, BatchOutputType &output) const |
| Standard interface for evaluating the response of the model to a batch of patterns. More... | |
| SHARK_EXPORT_SYMBOL void | weightedParameterDerivative (BatchInputType const &pattern, BatchOutputType const &coefficients, State const &state, RealVector &gradient) const |
| calculates the weighted sum of derivatives w.r.t the parameters. More... | |
| SHARK_EXPORT_SYMBOL void | weightedInputDerivative (BatchInputType const &pattern, BatchOutputType const &coefficients, State const &state, BatchInputType &derivative) const |
| calculates the weighted sum of derivatives w.r.t the inputs More... | |
| std::size_t | inputSize () const |
| std::size_t | outputSize () const |
| void | setMinLogValue (double logvalue=-230.0) |
| void | read (InArchive &archive) |
| From ISerializable, reads a model from an archive. More... | |
| void | write (OutArchive &archive) const |
| From ISerializable, writes a model to an archive. More... | |
| Public Member Functions inherited from shark::AbstractModel< RealVector, RealVector > | |
| AbstractModel () | |
| virtual | ~AbstractModel () |
| const Features & | features () const |
| virtual void | updateFeatures () |
| bool | hasFirstParameterDerivative () const |
| Returns true when the first parameter derivative is implemented. More... | |
| bool | hasSecondParameterDerivative () const |
| Returns true when the second parameter derivative is implemented. More... | |
| bool | hasFirstInputDerivative () const |
| Returns true when the first input derivative is implemented. More... | |
| bool | hasSecondInputDerivative () const |
| Returns true when the second parameter derivative is implemented. More... | |
| bool | isSequential () const |
| virtual void | eval (InputType const &pattern, OutputType &output) const |
| Standard interface for evaluating the response of the model to a single pattern. More... | |
| Data< OutputType > | operator() (Data< InputType > const &patterns) const |
| Model evaluation as an operator for a whole dataset. This is a convenience function. More... | |
| OutputType | operator() (InputType const &pattern) const |
| Model evaluation as an operator for a single pattern. This is a convenience function. More... | |
| BatchOutputType | operator() (BatchInputType const &patterns) const |
| Model evaluation as an operator for a single pattern. This is a convenience function. More... | |
| virtual void | weightedParameterDerivative (BatchInputType const &pattern, BatchOutputType const &coefficients, Batch< RealMatrix >::type const &errorHessian, State const &state, RealVector &derivative, RealMatrix &hessian) const |
| calculates the weighted sum of derivatives w.r.t the parameters More... | |
| virtual void | weightedInputDerivative (BatchInputType const &pattern, BatchOutputType const &coefficients, typename Batch< RealMatrix >::type const &errorHessian, State const &state, RealMatrix &derivative, Batch< RealMatrix >::type &hessian) const |
| calculates the weighted sum of derivatives w.r.t the inputs More... | |
| virtual void | weightedDerivatives (BatchInputType const &patterns, BatchOutputType const &coefficients, State const &state, RealVector ¶meterDerivative, BatchInputType &inputDerivative) const |
| calculates weighted input and parameter derivative at the same time More... | |
| Public Member Functions inherited from shark::IParameterizable | |
| virtual | ~IParameterizable () |
| Public Member Functions inherited from shark::INameable | |
| virtual | ~INameable () |
| Public Member Functions inherited from shark::ISerializable | |
| virtual | ~ISerializable () |
| Virtual d'tor. More... | |
| void | load (InArchive &archive, unsigned int version) |
| Versioned loading of components, calls read(...). More... | |
| void | save (OutArchive &archive, unsigned int version) const |
| Versioned storing of components, calls write(...). More... | |
| BOOST_SERIALIZATION_SPLIT_MEMBER () | |
Additional Inherited Members | |
| Public Types inherited from shark::AbstractModel< RealVector, RealVector > | |
| enum | Feature |
| typedef RealVector | InputType |
| Defines the input type of the model. More... | |
| typedef RealVector | OutputType |
| Defines the output type of the model. More... | |
| typedef Batch< InputType >::type | BatchInputType |
| defines the batch type of the input type. More... | |
| typedef Batch< OutputType >::type | BatchOutputType |
| defines the batch type of the output type More... | |
| typedef TypedFlags< Feature > | Features |
| typedef TypedFeatureNotAvailableException< Feature > | FeatureNotAvailableException |
| Protected Attributes inherited from shark::SigmoidModel | |
| RealVector | m_parameters |
| the parameter vector More... | |
| bool | m_useOffset |
| whether or not to allow non-zero offset values More... | |
| bool | m_transformForUnconstrained |
| flag for encoding variant More... | |
| double | m_minLogValue |
| what value should be returned as log-encoded slope if the true slope is actually zero More... | |
| Protected Attributes inherited from shark::AbstractModel< RealVector, RealVector > | |
| Features | m_features |
Detailed Description
scaled Tanh sigmoid function
- This model maps the reals to the unit interval by the sigmoid function \( f(x) = \frac{1}{2} \tanh(<A,x>+b) + \frac{1}{2} \).
Definition at line 167 of file SigmoidModel.h.
Constructor & Destructor Documentation
◆ TanhSigmoidModel()
| SHARK_EXPORT_SYMBOL shark::TanhSigmoidModel::TanhSigmoidModel | ( | bool | transform_for_unconstrained = true | ) |
Member Function Documentation
◆ name()
|
inlinevirtual |
From INameable: return the class name.
Reimplemented from shark::SigmoidModel.
Definition at line 175 of file SigmoidModel.h.
◆ sigmoid()
|
virtual |
activation function \(g_{output}(x)\)
Reimplemented from shark::SigmoidModel.
◆ sigmoidDerivative()
|
virtual |
Computes the derivative of the activation function \(g_{output}(x)\) for the output given the last response of the model gx=g(x)
Reimplemented from shark::SigmoidModel.
The documentation for this class was generated from the following file:
- include/shark/Models/SigmoidModel.h