embedding_layer.h

Go to the documentation of this file.

//   OpenNN: Open Neural Networks Library
//   www.opennn.net
//
//   E M B E D D I N G   L A Y E R   C L A S S   H E A D E R
//
//   Artificial Intelligence Techniques SL
//   artelnics@artelnics.com

 
#pragma once
 
#include "layer.h"
#include "operators.h"
#include "forward_propagation.h"
#include "back_propagation.h"
 
namespace opennn
{

class Embedding final : public Layer
{
public:

    Embedding(const Shape& input_shape = {0, 0},
              Index embedding_dimension = 0,
              const string& label = "embedding_layer");

    Shape get_input_shape() const override { return {sequence_length}; }
    Shape get_output_shape() const override;

    Index get_vocabulary_size() const { return vocabulary_size; }
    Index get_sequence_length() const { return sequence_length; }
    Index get_embedding_dimension() const { return embedding_dimension; }

    vector<Operator*> get_operators() override;

    vector<pair<Shape, Type>> get_forward_specs(Index batch_size) const override;

    void set(Index vocabulary_size = 0,
             Index sequence_length = 0,
             Index embedding_dimension = 0,
             const string& label = "embedding_layer");

    void set_scale_embedding(bool enabled) { embedding_lookup.scale_embedding = enabled; }
    void set_add_positional_encoding(bool enabled) { embedding_lookup.add_positional_encoding = enabled; }
    void set_dropout_rate(float rate) { dropout.set_rate(rate); }

    void back_propagate(ForwardPropagation&, BackPropagation&, size_t) const noexcept override;

    void read_JSON_body(const Json*) override;
    void write_JSON_body(JsonWriter&) const override;
 
private:

    Index vocabulary_size = 0;
    Index sequence_length = 0;
    Index embedding_dimension = 0;

    EmbeddingLookup embedding_lookup;
    Dropout         dropout;

    enum Forward {Input, Output};
    enum Backward {OutputDelta};
};
 
}
 
// OpenNN: Open Neural Networks Library.
// Copyright(C) 2005-2026 Artificial Intelligence Techniques, SL.
// Licensed under the GNU Lesser General Public License v2.1 or later.