iaode 0.2.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
iaode/__init__.py ADDED
@@ -0,0 +1,103 @@
1
+ """
2
+ iAODE: Interpretable Autoencoder with Ordinary Differential Equations
3
+
4
+ A deep learning framework for single-cell omics data analysis combining
5
+ variational autoencoders with neural ODEs for trajectory inference and
6
+ dimensionality reduction.
7
+
8
+ Main Components:
9
+ - agent: High-level interface for model training and evaluation
10
+ - annotation: Peak-to-gene annotation pipeline for scATAC-seq data
11
+ - BEN: Benchmark evaluation framework for comparing dimensionality reduction methods
12
+ - environment: Data handling and train/validation/test splitting
13
+ - model: Core VAE model with ODE integration
14
+ - module: Neural network building blocks (encoders, decoders, ODE functions)
15
+ - utils: Utility functions for data preprocessing
16
+ - DRE: Dimensionality reduction quality evaluation metrics
17
+ - LSE: Latent space evaluation for single-cell data
18
+
19
+ Usage Example:
20
+ >>> import anndata as ad
21
+ >>> import iaode
22
+ >>>
23
+ >>> # Load your data
24
+ >>> adata = ad.read_h5ad('your_data.h5ad')
25
+ >>>
26
+ >>> # Create and train model
27
+ >>> model = iaode.agent(
28
+ ... adata,
29
+ ... layer='counts',
30
+ ... latent_dim=10,
31
+ ... use_ode=True
32
+ ... )
33
+ >>> model.fit(epochs=100)
34
+ >>>
35
+ >>> # Get latent representation
36
+ >>> latent = model.get_latent()
37
+ """
38
+
39
+ __version__ = "0.2.0"
40
+ __author__ = "Zeyu Fu"
41
+
42
+ # Import main classes and functions
43
+ from .agent import agent
44
+ from .annotation import (
45
+ annotation_pipeline,
46
+ load_10x_h5_data,
47
+ add_peak_coordinates,
48
+ annotate_peaks_to_genes,
49
+ )
50
+ from .BEN import (
51
+ DataSplitter,
52
+ train_scvi_models,
53
+ evaluate_scvi_models,
54
+ )
55
+ from .DRE import (
56
+ DimensionalityReductionEvaluator,
57
+ evaluate_dimensionality_reduction,
58
+ compare_dimensionality_reduction_methods,
59
+ )
60
+ from .LSE import (
61
+ SingleCellLatentSpaceEvaluator,
62
+ evaluate_single_cell_latent_space,
63
+ compare_single_cell_methods,
64
+ )
65
+ from .utils import (
66
+ tfidf_normalization,
67
+ select_highly_variable_peaks,
68
+ )
69
+
70
+ # Import datasets module (lazy import to avoid unnecessary dependencies)
71
+ from . import datasets
72
+
73
+ # Define public API
74
+ __all__ = [
75
+ # Main agent class
76
+ 'agent',
77
+
78
+ # Annotation pipeline
79
+ 'annotation_pipeline',
80
+ 'load_10x_h5_data',
81
+ 'add_peak_coordinates',
82
+ 'annotate_peaks_to_genes',
83
+
84
+ # Benchmark evaluation
85
+ 'DataSplitter',
86
+ 'train_scvi_models',
87
+ 'evaluate_scvi_models',
88
+
89
+ # Evaluation metrics
90
+ 'DimensionalityReductionEvaluator',
91
+ 'evaluate_dimensionality_reduction',
92
+ 'compare_dimensionality_reduction_methods',
93
+ 'SingleCellLatentSpaceEvaluator',
94
+ 'evaluate_single_cell_latent_space',
95
+ 'compare_single_cell_methods',
96
+
97
+ # Utility functions
98
+ 'tfidf_normalization',
99
+ 'select_highly_variable_peaks',
100
+
101
+ # Datasets module
102
+ 'datasets',
103
+ ]