|
a |
|
b/docs/api/developer.md |
|
|
1 |
# Developer |
|
|
2 |
|
|
|
3 |
## Benchmarking |
|
|
4 |
|
|
|
5 |
```{eval-rst} |
|
|
6 |
.. module:: nichecompass.benchmarking |
|
|
7 |
.. currentmodule:: nichecompass |
|
|
8 |
|
|
|
9 |
.. autosummary:: |
|
|
10 |
:toctree: generated |
|
|
11 |
|
|
|
12 |
benchmarking.utils.compute_knn_graph_connectivities_and_distances |
|
|
13 |
``` |
|
|
14 |
|
|
|
15 |
## Data |
|
|
16 |
|
|
|
17 |
```{eval-rst} |
|
|
18 |
.. module:: nichecompass.data |
|
|
19 |
.. currentmodule:: nichecompass |
|
|
20 |
|
|
|
21 |
.. autosummary:: |
|
|
22 |
:toctree: generated |
|
|
23 |
|
|
|
24 |
data.initialize_dataloaders |
|
|
25 |
data.edge_level_split |
|
|
26 |
data.node_level_split_mask |
|
|
27 |
data.prepare_data |
|
|
28 |
data.SpatialAnnTorchDataset |
|
|
29 |
``` |
|
|
30 |
|
|
|
31 |
## Models |
|
|
32 |
|
|
|
33 |
```{eval-rst} |
|
|
34 |
.. module:: nichecompass.models |
|
|
35 |
.. currentmodule:: nichecompass |
|
|
36 |
|
|
|
37 |
.. autosummary:: |
|
|
38 |
:toctree: generated |
|
|
39 |
|
|
|
40 |
models.utils.load_saved_files |
|
|
41 |
models.utils.validate_var_names |
|
|
42 |
models.utils.initialize_model |
|
|
43 |
``` |
|
|
44 |
|
|
|
45 |
## Modules |
|
|
46 |
|
|
|
47 |
```{eval-rst} |
|
|
48 |
.. module:: nichecompass.modules |
|
|
49 |
.. currentmodule:: nichecompass |
|
|
50 |
|
|
|
51 |
.. autosummary:: |
|
|
52 |
:toctree: generated |
|
|
53 |
|
|
|
54 |
modules.VGPGAE |
|
|
55 |
modules.VGAEModuleMixin |
|
|
56 |
modules.BaseModuleMixin |
|
|
57 |
modules.compute_cat_covariates_contrastive_loss |
|
|
58 |
modules.compute_edge_recon_loss |
|
|
59 |
modules.compute_gp_group_lasso_reg_loss |
|
|
60 |
modules.compute_gp_l1_reg_loss |
|
|
61 |
modules.compute_kl_reg_loss |
|
|
62 |
modules.compute_omics_recon_nb_loss |
|
|
63 |
``` |
|
|
64 |
|
|
|
65 |
## NN |
|
|
66 |
|
|
|
67 |
```{eval-rst} |
|
|
68 |
.. module:: nichecompass.nn |
|
|
69 |
.. currentmodule:: nichecompass |
|
|
70 |
|
|
|
71 |
.. autosummary:: |
|
|
72 |
:toctree: generated |
|
|
73 |
|
|
|
74 |
nn.OneHopAttentionNodeLabelAggregator |
|
|
75 |
nn.OneHopGCNNormNodeLabelAggregator |
|
|
76 |
nn.OneHopSumNodeLabelAggregator |
|
|
77 |
nn.CosineSimGraphDecoder |
|
|
78 |
nn.FCOmicsFeatureDecoder |
|
|
79 |
nn.MaskedOmicsFeatureDecoder |
|
|
80 |
nn.Encoder |
|
|
81 |
nn.MaskedLinear |
|
|
82 |
nn.AddOnMaskedLayer |
|
|
83 |
``` |
|
|
84 |
|
|
|
85 |
## Train |
|
|
86 |
|
|
|
87 |
```{eval-rst} |
|
|
88 |
.. module:: nichecompass.train |
|
|
89 |
.. currentmodule:: nichecompass |
|
|
90 |
|
|
|
91 |
.. autosummary:: |
|
|
92 |
:toctree: generated |
|
|
93 |
|
|
|
94 |
train.Trainer |
|
|
95 |
train.eval_metrics |
|
|
96 |
train.plot_eval_metrics |
|
|
97 |
``` |