common.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021, NVIDIA CORPORATION.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * 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.
 */
 
#pragma once
 
#include "node.h"
 
#include <cstdint>
#include <map>
#include <string>
#include <vector>
 
namespace cuml {
namespace genetic {
 
enum class metric_t : uint32_t {
  mae,
 
  mse,
 
  rmse,
 
  pearson,
 
  spearman,
 
  logloss,
};  // enum class metric_t
 
enum class init_method_t : uint32_t {
  grow,
 
  full,
 
  half_and_half,
};  // enum class init_method_t
 
enum class transformer_t : uint32_t {
  sigmoid,
};  // enum class transformer_t
 
enum class mutation_t : uint32_t {
  none,
 
  crossover,
 
  subtree,
 
  hoist,
 
  point,
 
  reproduce
};  // enum class mutation_t
 
struct param {
  int population_size = 1000;
 
  int hall_of_fame = 100;
 
  int n_components = 10;
 
  int generations = 20;
 
  int tournament_size = 20;
 
  float stopping_criteria = 0.0f;
 
  float const_range[2] = {-1.0f, 1.0f};
 
  int init_depth[2] = {2, 6};
 
  init_method_t init_method = init_method_t::half_and_half;
 
  std::vector<node::type> function_set{
    node::type::add, node::type::mul, node::type::div, node::type::sub};
 
  std::map<int, std::vector<node::type>> arity_set{
    {2, {node::type::add, node::type::mul, node::type::div, node::type::sub}}};
  transformer_t transformer = transformer_t::sigmoid;
  metric_t metric = metric_t::mae;
  float parsimony_coefficient = 0.001f;
  float p_crossover = 0.9f;
  float p_subtree_mutation = 0.01f;
  float p_hoist_mutation = 0.01f;
 
  float p_point_mutation = 0.01f;
 
  float p_point_replace = 0.05f;
 
  float max_samples = 1.0f;
 
  float terminalRatio = 0.0f;
 
  std::vector<std::string> feature_names;
 
  int num_features;
 
  uint64_t random_state = 0UL;
 
  int num_epochs = 0;
 
  bool low_memory = false;
 
  float p_reproduce() const;
 
  int max_programs() const;
 
  int criterion() const;
};  // struct param
 
}  // namespace genetic
}  // namespace cuml