iganet::Softmin Class Reference

Softmin activation function. More...

#include </home/runner/work/iganet/iganet/include/iganet/net/activation.hpp>

Inheritance diagram for iganet::Softmin:

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

Private Attributes
torch::nn::functional::SoftminFuncOptions	options_

Additional Inherited Members
Protected Member Functions inherited from iganet::utils::FullQualifiedName
virtual	~FullQualifiedName ()=default
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

Softmin activation function.

\[ \text{Softmin}(x) = \text{Softmax}(-x) \]

Constructor & Destructor Documentation

Softmin() [1/2]

iganet::Softmin::Softmin ( int64_t  dim )

inlineexplicit

Provides the Softmin operation.

Parameters

dim	Value of dim.

Softmin() [2/2]

iganet::Softmin::Softmin ( const torch::nn::functional::SoftminFuncOptions &  options )

inlineexplicit

Provides the Softmin operation.

Parameters

options

Configuration options.

~Softmin()

iganet::Softmin::~Softmin ( )

overridedefault

Member Function Documentation

apply()

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

inlineoverridevirtual

Applies the activation function to the given input.

Parameters

input

Tensor to which the activation function is applied.

Returns

The activated tensor.

Implements iganet::ActivationFunction.

options() [1/2]

torch::nn::functional::SoftminFuncOptions & iganet::Softmin::options ( )

inline

Returns non-constant reference to options.

Returns

Mutable reference to the activation options.

options() [2/2]

const torch::nn::functional::SoftminFuncOptions & iganet::Softmin::options ( ) const

inline

Returns constant reference to options.

Returns

Constant reference to the activation options.

pretty_print()

void iganet::Softmin::pretty_print ( std::ostream &  os ) const

inlineoverridevirtualnoexcept

Returns a string representation of the activation function.

Parameters

os	Stream that receives the representation.

Implements iganet::ActivationFunction.

read()

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

inlineoverridevirtual

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

Parameters

archive	Input archive from which the activation state is read.
key	Key prefix under which the state is stored.

Returns

A reference to archive.

Implements iganet::ActivationFunction.

write()

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

inlineoverridevirtual

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

Parameters

archive	Output archive that receives the activation state.
key	Key prefix under which the state is stored.

Returns

A reference to archive.

Implements iganet::ActivationFunction.

Member Data Documentation

options_

torch::nn::functional::SoftminFuncOptions iganet::Softmin::options_

private

---

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

• include/iganet/net/activation.hpp