Presentation.hpp

Go to the documentation of this file.

#pragma once
 
#include "io/EvaluateResult.hpp"
#include "io/Output.hpp"
#include "models/Evaluation.hpp"
#include "stats/ConfusionMatrix.hpp"
#include "stats/Metrics.hpp"
 
#include <nlohmann/json.hpp>
 
namespace ppforest2::io {

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

  void print_variable_importance(
      Output& out, VariableImportance const& vi, types::Names const& feature_names = {}, int max_rows = 20
  );

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

  void print_regression_metrics(
      Output& out, stats::RegressionMetrics const& rm, std::string const& title = "Regression Metrics"
  );

  void print_metrics_block(
      Output& out,
      stats::ClassificationMetrics const& cm,
      std::string const& label,
      types::Names const& group_names = {}
  );
  void print_metrics_block(
      Output& out, stats::RegressionMetrics const& rm, std::string const& label, types::Names const& group_names = {}
  );
  void print_metrics_block(
      Output& out, stats::Metrics const& metrics, std::string const& label, types::Names const& group_names = {}
  );

  void print_metrics_block(Output& out, stats::ClassificationMetrics const& m, types::Names const& group_names = {});
  void print_metrics_block(Output& out, stats::RegressionMetrics const& m, types::Names const& group_names = {});
  void print_metrics_block(Output& out, stats::Metrics const& m, types::Names const& group_names = {});

  struct ConfigDisplayHints {
    float 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 = {});
}