Index

A

a (submarit.validation.rand_index.RandIndexResult attribute), [1] adj_rand (submarit.validation.rand_index.RandIndexResult attribute), [1] adj_rand_conf (submarit.validation.topk_analysis.TopKResult attribute), [1] adj_rand_dist (submarit.validation.rand_index.RandEmpiricalDistribution attribute), [1]

adj_rand_p (submarit.validation.topk_analysis.TopKResult attribute), [1] analyze_solution_stability() (in module submarit.validation.topk_analysis) avg_adj_rand (submarit.validation.topk_analysis.TopKResult attribute), [1] avg_rand (submarit.validation.topk_analysis.TopKResult attribute), [1]

B

b (submarit.validation.rand_index.RandIndexResult attribute), [1] BaseClusterer (class in submarit.core.base) BaseEstimator (class in submarit.core.base)

BaseEvaluator (class in submarit.core.base) BaseValidator (class in submarit.core.base) best_solutions (submarit.validation.topk_analysis.TopKResult attribute), [1] bootstrap_confidence_interval() (submarit.evaluation.statistical_tests.StatisticalTests static method)

C

c (submarit.validation.rand_index.RandIndexResult attribute), [1] calculate() (submarit.validation.rand_index.RandIndex method) calculate_detailed() (submarit.validation.rand_index.RandIndex method) calculate_empirical_p_value() (in module submarit.validation.p_values) calculate_p_value_range() (in module submarit.validation.p_values) calculate_p_values() (submarit.validation.rand_index.RandEmpiricalDistribution method) ci_lower (submarit.validation.p_values.PValueResult attribute), [1] ci_upper (submarit.validation.p_values.PValueResult attribute), [1] cluster_validity_indices() (submarit.evaluation.statistical_tests.StatisticalTests static method)

ClusterEvaluator (class in submarit.evaluation) ClusteringResult (class in submarit.core.base) combine_p_values() (in module submarit.validation.p_values) convert_in() (submarit.utils.matlab_compat.IndexConverter method) convert_mat_to_npz() (in module submarit.io.matlab_io) convert_out() (submarit.utils.matlab_compat.IndexConverter method) create_evaluation_report() (submarit.evaluation.visualization.EvaluationVisualizer method) create_from_consumer_product_data() (submarit.core.substitution_matrix.SubstitutionMatrix method) create_from_sales_data() (submarit.core.substitution_matrix.SubstitutionMatrix method) create_rand_empirical_distribution() (in module submarit.validation.rand_index)

D

d (submarit.validation.rand_index.RandIndexResult attribute), [1]

direction (submarit.validation.p_values.PValueResult attribute), [1]

E

empirical_dist (submarit.validation.topk_analysis.TopKResult attribute), [1] ensure_matlab_compatibility() (in module submarit.utils.matlab_compat) evaluate() (submarit.core.base.BaseEvaluator method) (submarit.evaluation.ClusterEvaluator method)

evaluate_legacy() (submarit.evaluation.ClusterEvaluator method) EvaluationResult (class in submarit.core.base) EvaluationVisualizer (class in submarit.evaluation.visualization)

F

fit() (submarit.core.base.BaseClusterer method)

fit_predict() (submarit.core.base.BaseClusterer method)

G

gap_statistic() (in module submarit.evaluation) get_inter_cluster_substitution() (submarit.core.substitution_matrix.SubstitutionMatrix method) get_intra_cluster_substitution() (submarit.core.substitution_matrix.SubstitutionMatrix method)

get_matrix() (submarit.core.substitution_matrix.SubstitutionMatrix method) get_params() (submarit.core.base.BaseEstimator method) get_percentiles() (submarit.validation.rand_index.RandEmpiricalDistribution method) get_submatrix() (submarit.core.substitution_matrix.SubstitutionMatrix method)

I

IndexConverter (class in submarit.utils.matlab_compat) is_normalized (submarit.core.substitution_matrix.SubstitutionMatrix property)

is_significant() (submarit.validation.p_values.PValueResult method) is_symmetric() (submarit.core.substitution_matrix.SubstitutionMatrix method)

K

KFoldValidator (class in submarit.validation)

L

labels_ (submarit.core.base.BaseClusterer property)

load_mat() (in module submarit.io.matlab_io) load_substitution_data() (in module submarit.io.data_io)

M

matlab_compatible_random() (in module submarit.utils.matlab_compat) matlab_find() (in module submarit.utils.matlab_compat) matlab_reshape() (in module submarit.utils.matlab_compat) matlab_size() (in module submarit.utils.matlab_compat) matlab_to_python_index() (in module submarit.utils.matlab_compat) MatlabCompatibilityError MatlabRandom (class in submarit.utils.matlab_compat) min_items (submarit.validation.rand_index.RandEmpiricalDistribution attribute), [1] module submarit.core.base submarit.core.substitution_matrix submarit.evaluation.statistical_tests submarit.evaluation.visualization submarit.io.data_io submarit.io.matlab_io submarit.utils.matlab_compat submarit.validation.p_values submarit.validation.rand_index submarit.validation.topk_analysis

multiple_testing_correction() (in module submarit.validation.p_values)

N

n_clusters (submarit.validation.rand_index.RandEmpiricalDistribution attribute), [1] n_items (submarit.validation.rand_index.RandEmpiricalDistribution attribute), [1] (submarit.validation.rand_index.RandIndexResult attribute), [1] n_iter_ (submarit.core.base.BaseClusterer property)

n_pairs (submarit.validation.rand_index.RandIndexResult attribute), [1] n_points (submarit.validation.rand_index.RandEmpiricalDistribution attribute), [1] n_products (submarit.core.substitution_matrix.SubstitutionMatrix property) n_simulations (submarit.validation.p_values.PValueResult attribute), [1] normalize() (submarit.core.substitution_matrix.SubstitutionMatrix method)

O

observed (submarit.validation.p_values.PValueResult attribute), [1]

P

p_value (submarit.validation.p_values.PValueResult attribute), [1] p_value_corrected (submarit.validation.p_values.PValueResult attribute), [1] pairwise_adj_rand (submarit.validation.topk_analysis.TopKResult attribute), [1] pairwise_rand (submarit.validation.topk_analysis.TopKResult attribute), [1] percentile (submarit.validation.p_values.PValueResult attribute), [1] permutation_test() (in module submarit.validation.p_values) (submarit.evaluation.statistical_tests.StatisticalTests static method)

plot_cluster_comparison() (submarit.evaluation.visualization.EvaluationVisualizer method) plot_cluster_sizes() (submarit.evaluation.visualization.EvaluationVisualizer method) plot_entropy_evolution() (submarit.evaluation.visualization.EvaluationVisualizer method) plot_probability_comparison() (submarit.evaluation.visualization.EvaluationVisualizer method) predict() (submarit.core.base.BaseClusterer method) PValueResult (class in submarit.validation.p_values) python_to_matlab_index() (in module submarit.utils.matlab_compat)

R

rand (submarit.validation.rand_index.RandIndexResult attribute), [1] rand() (submarit.utils.matlab_compat.MatlabRandom method) rand_conf (submarit.validation.topk_analysis.TopKResult attribute), [1] rand_dist (submarit.validation.rand_index.RandEmpiricalDistribution attribute), [1] rand_empirical_p() (in module submarit.validation.rand_index) rand_p (submarit.validation.topk_analysis.TopKResult attribute), [1]

RandEmpiricalDistribution (class in submarit.validation.rand_index) randi() (submarit.utils.matlab_compat.MatlabRandom method) RandIndex (class in submarit.validation.rand_index) RandIndexResult (class in submarit.validation.rand_index) randn() (submarit.utils.matlab_compat.MatlabRandom method) randperm() (submarit.utils.matlab_compat.MatlabRandom method) run_clusters_topk() (in module submarit.validation.topk_analysis)

S

save_mat() (in module submarit.io.matlab_io) save_results() (in module submarit.io.data_io) set_data() (submarit.core.substitution_matrix.SubstitutionMatrix method) set_default_dtype() (in module submarit.utils.matlab_compat) set_params() (submarit.core.base.BaseEstimator method) shape (submarit.core.substitution_matrix.SubstitutionMatrix property) stability_analysis() (submarit.evaluation.statistical_tests.StatisticalTests static method) StatisticalTests (class in submarit.evaluation.statistical_tests) submarit.core.base module submarit.core.substitution_matrix module submarit.evaluation.statistical_tests module submarit.evaluation.visualization module

submarit.io.data_io module submarit.io.matlab_io module submarit.utils.matlab_compat module submarit.validation.p_values module submarit.validation.rand_index module submarit.validation.topk_analysis module SubstitutionMatrix (class in submarit.core.substitution_matrix) summary() (submarit.validation.p_values.PValueResult method) (submarit.validation.rand_index.RandIndexResult method) (submarit.validation.topk_analysis.TopKResult method)

T

TopKResult (class in submarit.validation.topk_analysis)

V

validate() (submarit.core.base.BaseValidator method) (submarit.validation.KFoldValidator method)

validate_mat_file() (in module submarit.io.matlab_io)