parameter_sweep.hpp

Go to the documentation of this file.

/*
 *  SNABSuite -- Spiking Neural Architecture Benchmark Suite
 *  Copyright (C) 2016  Christoph Jenzen
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#ifndef SNABSUITE_COMMON_PARAMETER_SWEEP
#define SNABSUITE_COMMON_PARAMETER_SWEEP

#include <cypress/cypress.hpp>

#include <fstream>
#include <memory>
#include <string>

#include "common/snab_base.hpp"

namespace SNAB {

class ParameterSweep {
private:
    // String containing the simulation backend
    std::string m_backend;
    // Sweep Configuration
    cypress::Json m_sweep_config;
    // Benchmark class
    std::shared_ptr<SNABBase> m_snab;
    // Shuffled indices
    std::vector<size_t> m_indices;
    // List of indices with jobs already done
    std::vector<size_t> m_jobs_done;
    // Vector containing all configuration files of a sweep
    std::vector<cypress::Json> m_sweep_vector;
    // Names and Keys for parameters swept over
    std::vector<std::string> m_sweep_names;
    // Vector containing all resulting json files
    std::vector<std::vector<std::array<cypress::Real, 4>>> m_results;
    // TODO: Number of repetitions for every simulation
    size_t m_repetitions = 1;

    std::string m_file_name;

    // Number of threads for panellizing sweep
    size_t m_n_threads = 1;

    void shuffle_sweep_indices(size_t size);

    void recover_broken_simulation();

public:
    ParameterSweep(std::string backend, cypress::Json &config,
                   size_t bench_index = 0, size_t threads = 1);

    void execute();

    static std::vector<cypress::Json> generate_sweep_vector(
        const cypress::Json &source, const cypress::Json &target,
        std::vector<std::string> &sweep_names);

    void write_csv();
    void backup_simulation_results();

    ~ParameterSweep();
};
}  // namespace SNAB

#endif