archetypax package

Subpackages

• archetypax.models package
  • Submodules
  • archetypax.models.archetypes module
    • ImprovedArchetypalAnalysis
      • ImprovedArchetypalAnalysis.__init__()
      • ImprovedArchetypalAnalysis.directional_init()
      • ImprovedArchetypalAnalysis.fit()
      • ImprovedArchetypalAnalysis.fit_transform()
      • ImprovedArchetypalAnalysis.kmeans_pp_init()
      • ImprovedArchetypalAnalysis.loss_function()
      • ImprovedArchetypalAnalysis.project_archetypes()
      • ImprovedArchetypalAnalysis.project_archetypes_convex_hull()
      • ImprovedArchetypalAnalysis.project_archetypes_knn()
      • ImprovedArchetypalAnalysis.project_weights()
      • ImprovedArchetypalAnalysis.qhull_init()
      • ImprovedArchetypalAnalysis.set_fit_request()
      • ImprovedArchetypalAnalysis.transform()
      • ImprovedArchetypalAnalysis.update_archetypes()
  • archetypax.models.base module
    • ArchetypalAnalysis
      • ArchetypalAnalysis.__init__()
      • ArchetypalAnalysis.fit()
      • ArchetypalAnalysis.fit_transform()
      • ArchetypalAnalysis.get_loss_history()
      • ArchetypalAnalysis.loss_function()
      • ArchetypalAnalysis.project_archetypes()
      • ArchetypalAnalysis.project_weights()
      • ArchetypalAnalysis.reconstruct()
      • ArchetypalAnalysis.set_fit_request()
      • ArchetypalAnalysis.transform()
  • archetypax.models.biarchetypes module
    • BiarchetypalAnalysis
      • BiarchetypalAnalysis.__init__()
      • BiarchetypalAnalysis.fit()
      • BiarchetypalAnalysis.fit_transform()
      • BiarchetypalAnalysis.get_all_archetypes()
      • BiarchetypalAnalysis.get_all_weights()
      • BiarchetypalAnalysis.get_biarchetypes()
      • BiarchetypalAnalysis.get_col_archetypes()
      • BiarchetypalAnalysis.get_col_weights()
      • BiarchetypalAnalysis.get_row_archetypes()
      • BiarchetypalAnalysis.get_row_weights()
      • BiarchetypalAnalysis.loss_function()
      • BiarchetypalAnalysis.project_col_archetypes()
      • BiarchetypalAnalysis.project_col_coefficients()
      • BiarchetypalAnalysis.project_row_archetypes()
      • BiarchetypalAnalysis.project_row_coefficients()
      • BiarchetypalAnalysis.reconstruct()
      • BiarchetypalAnalysis.set_fit_request()
      • BiarchetypalAnalysis.transform()
  • archetypax.models.sparse_archetypes module
    • SparseArchetypalAnalysis
      • SparseArchetypalAnalysis.__init__()
      • SparseArchetypalAnalysis.diversify_archetypes()
      • SparseArchetypalAnalysis.fit()
      • SparseArchetypalAnalysis.fit_transform()
      • SparseArchetypalAnalysis.get_archetype_sparsity()
      • SparseArchetypalAnalysis.loss_function()
      • SparseArchetypalAnalysis.set_fit_request()
      • SparseArchetypalAnalysis.update_archetypes()
  • Module contents
• archetypax.tools package
  • Submodules
  • archetypax.tools.evaluation module
    • ArchetypalAnalysisEvaluator
      • ArchetypalAnalysisEvaluator.__init__()
      • ArchetypalAnalysisEvaluator.archetype_feature_importance()
      • ArchetypalAnalysisEvaluator.archetype_separation()
      • ArchetypalAnalysisEvaluator.clustering_metrics()
      • ArchetypalAnalysisEvaluator.comprehensive_evaluation()
      • ArchetypalAnalysisEvaluator.convex_hull_metrics()
      • ArchetypalAnalysisEvaluator.dominant_archetype_purity()
      • ArchetypalAnalysisEvaluator.explained_variance()
      • ArchetypalAnalysisEvaluator.plot_archetype_feature_comparison()
      • ArchetypalAnalysisEvaluator.plot_convex_hull()
      • ArchetypalAnalysisEvaluator.plot_distance_matrix()
      • ArchetypalAnalysisEvaluator.plot_entropy_vs_reconstruction()
      • ArchetypalAnalysisEvaluator.plot_feature_importance_heatmap()
      • ArchetypalAnalysisEvaluator.plot_purity_distribution()
      • ArchetypalAnalysisEvaluator.plot_weight_distributions()
      • ArchetypalAnalysisEvaluator.print_evaluation_report()
      • ArchetypalAnalysisEvaluator.reconstruction_error()
      • ArchetypalAnalysisEvaluator.weight_diversity()
    • BiarchetypalAnalysisEvaluator
      • BiarchetypalAnalysisEvaluator.__init__()
      • BiarchetypalAnalysisEvaluator.archetype_separation()
      • BiarchetypalAnalysisEvaluator.comprehensive_evaluation()
      • BiarchetypalAnalysisEvaluator.dominant_archetype_purity()
      • BiarchetypalAnalysisEvaluator.explained_variance()
      • BiarchetypalAnalysisEvaluator.print_evaluation_report()
      • BiarchetypalAnalysisEvaluator.print_summary()
      • BiarchetypalAnalysisEvaluator.reconstruction_error()
      • BiarchetypalAnalysisEvaluator.weight_diversity()
  • archetypax.tools.interpret module
    • ArchetypalAnalysisInterpreter
      • ArchetypalAnalysisInterpreter.__init__()
      • ArchetypalAnalysisInterpreter.add_model()
      • ArchetypalAnalysisInterpreter.cluster_purity()
      • ArchetypalAnalysisInterpreter.evaluate_all_models()
      • ArchetypalAnalysisInterpreter.feature_consistency()
      • ArchetypalAnalysisInterpreter.feature_distinctiveness()
      • ArchetypalAnalysisInterpreter.information_gain()
      • ArchetypalAnalysisInterpreter.plot_interpretability_metrics()
      • ArchetypalAnalysisInterpreter.sparsity_coefficient()
      • ArchetypalAnalysisInterpreter.suggest_optimal_archetypes()
    • BiarchetypalAnalysisInterpreter
      • BiarchetypalAnalysisInterpreter.__init__()
      • BiarchetypalAnalysisInterpreter.add_model()
      • BiarchetypalAnalysisInterpreter.cluster_purity()
      • BiarchetypalAnalysisInterpreter.compute_information_gain()
      • BiarchetypalAnalysisInterpreter.evaluate_all_models()
      • BiarchetypalAnalysisInterpreter.feature_distinctiveness()
      • BiarchetypalAnalysisInterpreter.plot_interpretability_heatmap()
      • BiarchetypalAnalysisInterpreter.sparsity_coefficient()
      • BiarchetypalAnalysisInterpreter.suggest_optimal_biarchetypes()
  • archetypax.tools.visualization module
    • ArchetypalAnalysisVisualizer
      • ArchetypalAnalysisVisualizer.plot_archetype_distribution()
      • ArchetypalAnalysisVisualizer.plot_archetype_profiles()
      • ArchetypalAnalysisVisualizer.plot_archetypes_2d()
      • ArchetypalAnalysisVisualizer.plot_loss()
      • ArchetypalAnalysisVisualizer.plot_membership_weights()
      • ArchetypalAnalysisVisualizer.plot_reconstruction_comparison()
      • ArchetypalAnalysisVisualizer.plot_simplex_2d()
    • BiarchetypalAnalysisVisualizer
      • BiarchetypalAnalysisVisualizer.plot_biarchetypal_reconstruction()
      • BiarchetypalAnalysisVisualizer.plot_dual_archetypes_2d()
      • BiarchetypalAnalysisVisualizer.plot_dual_membership_heatmap()
      • BiarchetypalAnalysisVisualizer.plot_dual_simplex_2d()
      • BiarchetypalAnalysisVisualizer.plot_mixture_effect()
  • Module contents

Module contents

ArchetypAX: GPU-accelerated Archetypal Analysis implementation using JAX.

This package provides efficient implementations of various Archetypal Analysis algorithms leveraging JAX for GPU acceleration and automatic differentiation.

Main Components:

models: Core model implementations for different types of archetypal analysis tools: Utilities for evaluation, interpretation, and visualization logger: Standardized logging system

Basic Usage:

import archetypax as apx import numpy as np

# Create data data = np.random.rand(100, 10)

# Initialize and fit a model model = apx.ArchetypalAnalysis(n_archetypes=5) model.fit(data)

# Get archetypal representations archetypes = model.get_archetypes() coefficients = model.transform(data)