iganet::Softmax Class Reference

Softmax activation function. More...

#include </home/runner/work/iganet/iganet/include/layer.hpp>

Inheritance diagram for iganet::Softmax:

Public Member Functions
	Softmax (const torch::nn::functional::SoftmaxFuncOptions &options)
	Softmax (int64_t dim)
	~Softmax () override=default
torch::Tensor	apply (const torch::Tensor &input) const override
	Applies the activation function to the given input.
torch::nn::functional::SoftmaxFuncOptions &	options ()
	Returns non-constant reference to options.
const torch::nn::functional::SoftmaxFuncOptions &	options () const
	Returns constant reference to options.
virtual void	pretty_print (std::ostream &os=Log(log::info)) const noexcept override
	Returns a string representation of the activation function.
torch::serialize::InputArchive &	read (torch::serialize::InputArchive &archive, const std::string &key="softmax") override
	Reads the activation function from a torch::serialize::InputArchive object.
torch::serialize::OutputArchive &	write (torch::serialize::OutputArchive &archive, const std::string &key="softmax") const override
	Writes the activation function into a torch::serialize::OutputArchive object.
Public Member Functions inherited from iganet::ActivationFunction
virtual	~ActivationFunction ()=default

Private Attributes
torch::nn::functional::SoftmaxFuncOptions	options_

Additional Inherited Members
Protected Member Functions inherited from iganet::utils::FullQualifiedName
virtual const std::string &	name () const noexcept
	Returns the full qualified name of the object.
Protected Attributes inherited from iganet::utils::FullQualifiedName
at::optional< std::string >	name_
	String storing the full qualified name of the object.

Detailed Description

Softmax activation function.

\[ \text{Softmax}(x_i) = \frac{\exp(x_i)}{\sum_j \exp(x_j)} \]

where \( x \) is an \(n\)-dimensional input tensor

Constructor & Destructor Documentation

Softmax() [1/2]

iganet::Softmax::Softmax ( int64_t  dim )

inlineexplicit

Softmax() [2/2]

iganet::Softmax::Softmax ( const torch::nn::functional::SoftmaxFuncOptions &  options )

inlineexplicit

~Softmax()

iganet::Softmax::~Softmax ( )

overridedefault

Member Function Documentation

apply()

torch::Tensor iganet::Softmax::apply ( const torch::Tensor &  input ) const

inlineoverridevirtual

Applies the activation function to the given input.

Implements iganet::ActivationFunction.

options() [1/2]

torch::nn::functional::SoftmaxFuncOptions & iganet::Softmax::options ( )

inline

Returns non-constant reference to options.

options() [2/2]

const torch::nn::functional::SoftmaxFuncOptions & iganet::Softmax::options ( ) const

inline

Returns constant reference to options.

pretty_print()

virtual void iganet::Softmax::pretty_print ( std::ostream &  os = Log(log::info) ) const

inlineoverridevirtualnoexcept

Returns a string representation of the activation function.

Implements iganet::ActivationFunction.

read()

torch::serialize::InputArchive & iganet::Softmax::read ( torch::serialize::InputArchive &  archive, const std::string &  key = "softmax"  )

inlineoverridevirtual

Reads the activation function from a torch::serialize::InputArchive object.

Implements iganet::ActivationFunction.

write()

torch::serialize::OutputArchive & iganet::Softmax::write ( torch::serialize::OutputArchive &  archive, const std::string &  key = "softmax"  ) const

inlineoverridevirtual

Writes the activation function into a torch::serialize::OutputArchive object.

Implements iganet::ActivationFunction.

Member Data Documentation

options_

torch::nn::functional::SoftmaxFuncOptions iganet::Softmax::options_

private

---

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

• include/layer.hpp