data_reader_numpy_npz.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.
//
// lbann_data_reader_numpy_npz .hpp .cpp - generic_data_reader class for numpy
// .npz dataset

#ifndef LBANN_DATA_READER_NUMPY_NPZ_HPP
#define LBANN_DATA_READER_NUMPY_NPZ_HPP

#include "data_reader.hpp"
#include "data_reader_numpy.hpp"
#include <cnpy.h>

namespace lbann {
class numpy_npz_reader : public generic_data_reader
{
public:
  numpy_npz_reader(const bool shuffle);
  // These need to be explicit because of some issue with the cnpy copy
  // constructor/assignment operator not linking correctly otherwise.
  numpy_npz_reader(const numpy_npz_reader&);
  numpy_npz_reader& operator=(const numpy_npz_reader&);
  ~numpy_npz_reader() override {}

  numpy_npz_reader* copy() const override
  {
    return new numpy_npz_reader(*this);
  }

  std::string get_type() const override { return "numpy_npz_reader"; }

  void set_scaling_factor_int16(DataType s) { m_scaling_factor_int16 = s; }

  void load() override;

  int get_num_labels() const override { return m_num_labels; }
  int get_num_responses() const override
  {
    return get_linearized_response_size();
  }
  int get_linearized_data_size() const override { return m_num_features; }
  int get_linearized_label_size() const override { return m_num_labels; }
  int get_linearized_response_size() const override
  {
    return m_num_response_features;
  }
  const std::vector<El::Int> get_data_dims() const override
  {
    std::vector<El::Int> dims(m_data.shape.begin() + 1, m_data.shape.end());
    return dims;
  }

protected:
  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;

  int m_num_samples = 0;
  int m_num_features = 0;
  int m_num_labels = 0;
  int m_num_response_features = 0;
  cnpy::NpyArray m_data, m_labels, m_responses;

  // A constant to be multiplied when data is converted
  // from int16 to DataType.
  DataType m_scaling_factor_int16 = 1.0;

private:
  // Keys to retrieve data, labels, responses from a given .npz file.
  static const std::string NPZ_KEY_DATA, NPZ_KEY_LABELS, NPZ_KEY_RESPONSES;
};

} // namespace lbann

#endif // LBANN_DATA_READER_NUMPY_NPZ_HPP