#include <softmax.h>

Inheritance diagram for Beatmup::NNets::Softmax:

Public Member Functions
	Softmax (const std::string &name="Softmax")
	Creates a softmax layer. More...

int	getInputCount () const
	Returns number of operation inputs. More...

int	getOutputCount () const
	Returns number of operation outputs. More...

bool	acceptsStorageInput (int index=0) const
	Returns `true` if the operation can take a Storage::View at a specific input. More...

bool	acceptsVectorInput (int index=0) const
	Returns `true` if the operation can take a GL::Vector at a specific input. More...

void	setInput (Storage::View &&view, int index=0)

void	setInput (GL::Vector &vector, int index=0)

std::map< std::string, std::string >	serialize () const
	Returns a serialized representation of th operation;. More...

void	disconnect ()
	Assigns empty inputs and outputs. More...

const std::vector< float > &	getProbabilities () const

Public Member Functions inherited from Beatmup::NNets::CpuOperation
bool	usesGpu () const
	Returns `true` if the operation is run on GPU. More...

Public Member Functions inherited from Beatmup::NNets::AbstractOperation
virtual	~AbstractOperation ()

virtual bool	acceptsTextureInput (int index=0) const
	Returns `true` if the operation can take a GL::TextureHandler at a specific input. More...

virtual bool	acceptsStorageOutput (int index=0) const
	Returns `true` if the operation can take a Storage::View at a specific output. More...

virtual bool	acceptsVectorOutput (int index=0) const
	Returns `true` if the operation can take a GL::Vector at a specific output. More...

virtual bool	acceptsTextureOutput (int index=0) const
	Returns `true` if the operation can take a GL::TextureHandler at a specific output. More...

virtual Size	getOutputSize (int outputIndex=0) const
	Returns full size of a specific operation output. More...

virtual Storage::View	getOutput (int index=0)
	Returns a storage view bound to a specific operation output. More...

virtual void	getOutput (GL::Vector *&vector, int index=0)
	Returns a GL::Vector bound to a specific operation output. More...

virtual void	getOutput (GL::TextureHandler *&vector, int index=0)
	Returns a GL::TextureHandler bound to a specific operation output. More...

virtual void	setOutput (Storage::View &&storage, int index=0)

virtual void	setOutput (GL::Vector &vector, int index=0)

virtual void	setInput (GL::TextureHandler &image, int index=0)

virtual void	setOutput (GL::TextureHandler &image, int index=0)

virtual unsigned long	countMultiplyAdds () const
	Counts (approximate) number of multiply-adds used by this operation. More...

virtual unsigned long	countTexelFetches () const
	Counts (approximate) number of texels fetches. More...

std::string	getName () const

Static Public Member Functions
static bool	initDeserializer ()
	Sets up deserialization of the operation. More...

Private Member Functions
int	getAmountOfWork () const
	Returns amount of work in arbitrary units to be splitted among threads. More...

void	beforeExecute (GraphicPipeline &gpu, const int threadCount)
	Called right before the operation is executed. More...

void	execute (const int sliceStart, const int sliceStop, const int threadIdx, const int threadCount)
	Executes the operation body within a specific CPU thread. More...

void	afterExecute (const int threadCount)
	Called right after the operation is executed. More...

Private Attributes
std::vector< float >	output

std::vector< float >	partialSums

Storage::View	inputView

GL::Vector *	inputVector

Additional Inherited Members
Protected Member Functions inherited from Beatmup::NNets::CpuOperation
	CpuOperation (const std::string &name)

void	prepare (GraphicPipeline &gpu, ChunkCollection &data, GL::ProgramBank &bank)
	Compiles GLSL shaders. More...

void	getSampledChannels (int index, int &min, int &max) const
	Retrieves range of input features channels sampled at the same time for a specific input. More...

void	execute (TaskThread &thread, GraphicPipeline &gpu)
	Executes the operation. More...

void	execute (TaskThread &thread)
	Executes the operation within a specific CPU thread. More...

Protected Member Functions inherited from Beatmup::NNets::AbstractOperation
	AbstractOperation (const std::string &name)

virtual int	getInputPadding (int index=0) const
	Retrieves minimum required size of zero padding for a given input. More...

Detailed Description

Softmax layer.

It does not have output, but acts as a sink. The resulting probabilities are returned by getProbabilities(). This operation is executed on CPU.

Definition at line 32 of file softmax.h.

Constructor & Destructor Documentation

◆ Softmax()

Softmax::Softmax ( const std::string & name = "Softmax" )

Creates a softmax layer.

Parameters

[in] name Operation name

Definition at line 26 of file softmax.cpp.

26 : CpuOperation(name) {}

Beatmup::NNets::AbstractOperation::name

std::string name

Definition: operation.h:50

Beatmup::NNets::CpuOperation::CpuOperation

CpuOperation(const std::string &name)

Definition: operation.h:436

Member Function Documentation

◆ getAmountOfWork()

int Softmax::getAmountOfWork ( ) const

privatevirtual

Returns amount of work in arbitrary units to be splitted among threads.

Implements Beatmup::NNets::CpuOperation.

Definition at line 29 of file softmax.cpp.

                                    {
     return (int)output.size();
 }

◆ beforeExecute()

void Softmax::beforeExecute	(	GraphicPipeline &	gpu,
		const int	threadCount
	)

privatevirtual

Called right before the operation is executed.

Reimplemented from Beatmup::NNets::CpuOperation.

Definition at line 34 of file softmax.cpp.

                                                                        {
     partialSums.resize(threadCount);
     if (inputVector)
         inputVector->fetch(gpu, output);
     else {
         inputView.getStorage().pull(gpu);
         output.resize(inputView.getSize().volume());
         Storage::Scanner scanner(inputView);
         scanner.move(0, 0);
         scanner.fill(output.begin(), output.end());
     }
 }

◆ execute()

void Softmax::execute	(	const int	sliceStart,
		const int	sliceStop,
		const int	threadIdx,
		const int	threadCount
	)

privatevirtual

Executes the operation body within a specific CPU thread.

The threads can process different slices according to a given amount of work (see getAmountOfWork()).

Parameters

[in]	sliceStart	Current slice starting point (included in the slice)
[in]	sliceStop	Current slice end point (excluded from the slice)
[in]	threadIdx	Zero-based calling thread number
[in]	threadCount	Total number of threads executing the operation

Implements Beatmup::NNets::CpuOperation.

Definition at line 48 of file softmax.cpp.

                                                                                                            {
     // compute the exponential mapping of the input vector and partial sums
     float sum = 0;
     for (int i = sliceStart; i < sliceStop; ++i)
         sum += (output[i] = std::exp(output[i]));
     partialSums[threadIdx] = sum;
 }

◆ afterExecute()

void Softmax::afterExecute ( const int threadCount )

privatevirtual

Called right after the operation is executed.

Reimplemented from Beatmup::NNets::CpuOperation.

Definition at line 57 of file softmax.cpp.

                                                 {
     // sum up partial sums
     float sum = partialSums[0];
     for (size_t i = 1; i < partialSums.size(); ++i)
         sum += partialSums[i];
  
     // normalize the output vector
     const float normFactor = 1 / sum;
     for (auto& y : output)
         y *= normFactor;
 }

◆ getInputCount()

int Beatmup::NNets::Softmax::getInputCount ( ) const

inlinevirtual

Returns number of operation inputs.

Inputs are then indexed from zero to the returned value minus one inclusive.

Reimplemented from Beatmup::NNets::AbstractOperation.

Definition at line 51 of file softmax.h.

51 { return 1; }

◆ getOutputCount()

int Beatmup::NNets::Softmax::getOutputCount ( ) const

inlinevirtual

Returns number of operation outputs.

Outputs are then indexed from zero to the returned value minus one inclusive.

Reimplemented from Beatmup::NNets::AbstractOperation.

Definition at line 52 of file softmax.h.

52 { return 0; }

◆ acceptsStorageInput()

bool Beatmup::NNets::Softmax::acceptsStorageInput ( int index = 0 ) const

inlinevirtual

Returns true if the operation can take a Storage::View at a specific input.

Neural network operations may accept different kinds of data containers on inputs and outputs, namely Storage::View, GL::Vector and textures. This function is used to check whether a given operation accepts a storage view on input.

Parameters

[in] index The input index. Expected to fall in the valid range, i.e. from zero to getInputCount() - 1 inclusive.

Reimplemented from Beatmup::NNets::AbstractOperation.

Definition at line 54 of file softmax.h.

54 { return index == 0; }

index

jlong jint index

Definition: wrapper_core.cpp:434

◆ acceptsVectorInput()

bool Beatmup::NNets::Softmax::acceptsVectorInput ( int index = 0 ) const

inlinevirtual

Returns true if the operation can take a GL::Vector at a specific input.

Neural network operations may accept different kinds of data containers on inputs and outputs, namely Storage::View, GL::Vector and textures. This function is used to check whether a given operation accepts a vector on input.

Parameters

[in] index The input index. Expected to fall in the valid range, i.e. from zero to getInputCount() - 1 inclusive.

Reimplemented from Beatmup::NNets::AbstractOperation.

Definition at line 55 of file softmax.h.

55 { return index == 0; }

◆ setInput() [1/2]

void Softmax::setInput	(	Storage::View &&	view,
		int	index = `0`
	)

virtual

Reimplemented from Beatmup::NNets::AbstractOperation.

Definition at line 70 of file softmax.cpp.

                                                     {
     OutOfRange::check(index, 0, 1, "Softmax operation input out of range: %d");
     InvalidArgument::check(view.getWidth() == 1 && view.getHeight() == 1, "A column-like storage view is expected on input of Softmax operation.");
     this->inputView = std::move(view);
     this->inputVector = nullptr;
 }

◆ setInput() [2/2]

void Softmax::setInput	(	GL::Vector &	vector,
		int	index = `0`
	)

virtual

Reimplemented from Beatmup::NNets::AbstractOperation.

Definition at line 78 of file softmax.cpp.

                                                   {
     OutOfRange::check(index, 0, 1, "Softmax operation input out of range: %d");
     this->inputVector = &vector;
     this->inputView = Storage::View();
 }

◆ serialize()

std::map< std::string, std::string > Softmax::serialize ( ) const

virtual

Returns a serialized representation of th operation;.

Implements Beatmup::NNets::AbstractOperation.

Definition at line 106 of file softmax.cpp.

                                                       {
     return {
         { "_name", getName() },
         { "_type", "softmax" }
     };
 }

◆ disconnect()

void Softmax::disconnect ( )

virtual

Assigns empty inputs and outputs.

Implements Beatmup::NNets::AbstractOperation.

Definition at line 114 of file softmax.cpp.

                          {
     this->inputVector = nullptr;
     this->inputView = Storage::View();
 }

◆ getProbabilities()

const std::vector<float>& Beatmup::NNets::Softmax::getProbabilities ( ) const

inline

Definition at line 64 of file softmax.h.

64 { return output; }

◆ initDeserializer()

static bool Beatmup::NNets::Softmax::initDeserializer ( )

static

Sets up deserialization of the operation.

Member Data Documentation

◆ output

std::vector<float> Beatmup::NNets::Softmax::output

private

Definition at line 34 of file softmax.h.

◆ partialSums

std::vector<float> Beatmup::NNets::Softmax::partialSums

private

Definition at line 35 of file softmax.h.

◆ inputView

Storage::View Beatmup::NNets::Softmax::inputView

private

Definition at line 36 of file softmax.h.

◆ inputVector

GL::Vector* Beatmup::NNets::Softmax::inputVector

private

Definition at line 37 of file softmax.h.

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

core/nnets/softmax.h
core/nnets/softmax.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Softmax()

Member Function Documentation

◆ getAmountOfWork()

◆ beforeExecute()

◆ execute()

◆ afterExecute()

◆ getInputCount()

◆ getOutputCount()

◆ acceptsStorageInput()

◆ acceptsVectorInput()

◆ setInput() [1/2]

◆ setInput() [2/2]

◆ serialize()

◆ disconnect()

◆ getProbabilities()

◆ initDeserializer()

Member Data Documentation

◆ output

◆ partialSums

◆ inputView

◆ inputVector