Presentation.hpp

Go to the documentation of this file.

#pragma once
 
#include "io/Color.hpp"
#include "io/Output.hpp"
#include "models/VariableImportance.hpp"
#include "stats/ConfusionMatrix.hpp"
#include "stats/Stats.hpp"
#include "utils/Types.hpp"
 
#include <nlohmann/json.hpp>
 
namespace ppforest2::io {
  struct ModelStats {
    types::Vector<float> tr_times;
    types::Vector<float> tr_error;
    types::Vector<float> te_error;
    long peak_rss_bytes = -1;
 
    double mean_time() const { return tr_times.mean(); }
 
    double mean_tr_error() const { return tr_error.mean(); }
 
    double mean_te_error() const { return te_error.mean(); }
 
    double std_time() const { return stats::sd(tr_times); }
 
    double std_tr_error() const { return stats::sd(tr_error); }
 
    double std_te_error() const { return stats::sd(te_error); }

    nlohmann::json to_json() const;
  };

  void print_results(Output& out, ModelStats const& stats);

  void print_variable_importance(Output& out,
                                 VariableImportance const& vi,
                                 std::vector<std::string> const& feature_names = {},
                                 int max_rows                                  = 20);

  void print_confusion_matrix(Output& out,
                              stats::ConfusionMatrix const& cm,
                              std::string const& title                    = "Confusion Matrix",
                              std::vector<std::string> const& group_names = {});

  struct ConfigDisplayHints {
    int vars_percent     = -1;
    bool default_vars    = false;
    bool default_threads = false;
    bool default_seed    = false;
    std::string training_samples;
    std::string test_samples;
  };

  void print_configuration(Output& out, nlohmann::json const& config, ConfigDisplayHints const& hints = {});

  void print_data_summary(Output& out, nlohmann::json const& meta);

  void print_summary(Output& out, nlohmann::json const& model_data, ConfigDisplayHints const& hints = {});
}