data_reader_synthetic.hpp

Go to the documentation of this file.

// Copyright (c) 2014-2023, Lawrence Livermore National Security, LLC.
// Produced at the Lawrence Livermore National Laboratory.
// Written by the LBANN Research Team (B. Van Essen, et al.) listed in
// the CONTRIBUTORS file. <lbann-dev@llnl.gov>
//
// LLNL-CODE-697807.
// All rights reserved.
//
// This file is part of LBANN: Livermore Big Artificial Neural Network
// Toolkit. For details, see http://software.llnl.gov/LBANN or
// https://github.com/LLNL/LBANN.
//
// Licensed under the Apache License, Version 2.0 (the "Licensee"); you
// may not use this file except in compliance with the License.  You may
// obtain a copy of the License at:
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the license.
//

#ifndef LBANN_DATA_READER_SYNTHETIC_HPP
#define LBANN_DATA_READER_SYNTHETIC_HPP

#include "data_reader.hpp"
#include "lbann/utils/dim_helpers.hpp"

// Forward declaration
class DataReaderSyntheticWhiteboxTester;

namespace lbann {

class data_reader_synthetic : public generic_data_reader
{
public:
  // TODO: add what data distribution to use
  data_reader_synthetic(int num_samples, int num_features, bool shuffle = true);
  data_reader_synthetic(int num_samples,
                        std::vector<El::Int> dims,
                        int num_labels,
                        bool shuffle = true);
  data_reader_synthetic(int num_samples,
                        std::vector<El::Int> dims,
                        std::vector<El::Int> response_dims,
                        bool shuffle = true);
  data_reader_synthetic(int num_samples,
                        std::map<data_field_type, std::vector<El::Int>> data_fields,
                        bool shuffle = true);
  data_reader_synthetic(const data_reader_synthetic&) = default;
  data_reader_synthetic& operator=(const data_reader_synthetic&) = default;
  ~data_reader_synthetic() override {}
  data_reader_synthetic* copy() const override
  {
    return new data_reader_synthetic(*this);
  }
  std::string get_type() const override { return "data_reader_synthetic"; }

  void load() override;

  int get_linearized_size(data_field_type const& data_field) const override
  {
    auto iter = m_synthetic_data_fields.find(data_field);
    if (iter == end(m_synthetic_data_fields)) {
      LBANN_ERROR("Unknown data field ", data_field);
    }
    return get_linear_size(iter->second);
  }

  int get_linearized_data_size() const override
  {
    return get_linear_size(m_dimensions);
  }
  int get_linearized_label_size() const override { return m_num_labels; }
  int get_linearized_response_size() const override
  {
    return get_linear_size(m_response_dimensions);
  }

  const std::vector<El::Int> get_data_dims() const override { return m_dimensions; }

  int get_num_labels() const override { return m_num_labels; }
  int get_num_responses() const override
  {
    return get_linearized_response_size();
  }

protected:
  bool fetch_data_field(data_field_type data_field,
                        CPUMat& Y,
                        int data_id,
                        int mb_idx) override;
  bool fetch_datum(CPUMat& X, int data_id, int mb_idx) override;
  bool fetch_label(CPUMat& Y, int data_id, int mb_idx) override;
  bool fetch_response(CPUMat& Y, int data_id, int mb_idx) override;

  // Designate a whitebox testing friend
  friend class ::DataReaderSyntheticWhiteboxTester;

private:
  int m_num_samples;
  int m_num_labels;
  std::vector<El::Int> m_dimensions;
  std::vector<El::Int> m_response_dimensions;

  std::map<data_field_type, std::vector<El::Int>> m_synthetic_data_fields;
};

} // namespace lbann

#endif // LBANN_DATA_READER_SYNTHETIC_HPP