Options.hpp

Go to the documentation of this file.

#ifndef UMAPPP_OPTIONS_HPP
#define UMAPPP_OPTIONS_HPP
 
#include <random>
#include <optional>
 
#include "sanisizer/sanisizer.hpp"
#include "irlba/irlba.hpp"
#include "Eigen/Dense"
 
namespace umappp {
 
enum InitializeMethod : char { SPECTRAL, RANDOM, NONE };
 
typedef std::mt19937_64 RngEngine;
 
struct Options {
    double local_connectivity = 1;
 
    double bandwidth = 1;
 
    double mix_ratio = 1;
 
    double spread = 1;
 
    double min_dist = 0.1;
 
    std::optional<double> a;
 
    std::optional<double> b;
 
    double repulsion_strength = 1;
 
    InitializeMethod initialize_method = InitializeMethod::SPECTRAL;
 
    bool initialize_random_on_spectral_fail = true;
 
    irlba::Options<Eigen::VectorXd> initialize_spectral_irlba_options;
 
    double initialize_spectral_scale = 10;
 
    bool initialize_spectral_jitter = false;
 
    double initialize_spectral_jitter_sd = 0.0001;
 
    double initialize_random_scale = 10;
 
    typename RngEngine::result_type initialize_seed = sanisizer::cap<typename RngEngine::result_type>(9876543210);
 
    std::optional<int> num_epochs;
 
    double learning_rate = 1; 
 
    double negative_sample_rate = 5;
 
    int num_neighbors = 15;
 
    typename RngEngine::result_type optimize_seed = sanisizer::cap<typename RngEngine::result_type>(1234567890);
 
    int num_threads = 1;
 
    int parallel_optimization = false;
};
 
}
 
#endif