autoencodix 0.2.0__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.

Potentially problematic release.


This version of autoencodix might be problematic. Click here for more details.

Files changed (91) hide show
  1. autoencodix/__init__.py +27 -0
  2. autoencodix/base/.ipynb_checkpoints/_base_pipeline-checkpoint.py +1274 -0
  3. autoencodix/base/.ipynb_checkpoints/_base_trainer-checkpoint.py +247 -0
  4. autoencodix/base/__init__.py +21 -0
  5. autoencodix/base/_base_autoencoder.py +138 -0
  6. autoencodix/base/_base_dataset.py +103 -0
  7. autoencodix/base/_base_evaluator.py +34 -0
  8. autoencodix/base/_base_loss.py +311 -0
  9. autoencodix/base/_base_pipeline.py +1355 -0
  10. autoencodix/base/_base_predictor.py +6 -0
  11. autoencodix/base/_base_preprocessor.py +1033 -0
  12. autoencodix/base/_base_trainer.py +259 -0
  13. autoencodix/base/_base_visualizer.py +578 -0
  14. autoencodix/base/sampleconfig.yaml +132 -0
  15. autoencodix/configs/__init__.py +21 -0
  16. autoencodix/configs/default_config.py +652 -0
  17. autoencodix/configs/disentanglix_config.py +15 -0
  18. autoencodix/configs/maskix_config.py +39 -0
  19. autoencodix/configs/ontix_config.py +35 -0
  20. autoencodix/configs/stackix_config.py +33 -0
  21. autoencodix/configs/vanillix_config.py +18 -0
  22. autoencodix/configs/varix_config.py +15 -0
  23. autoencodix/configs/xmodalix_config.py +43 -0
  24. autoencodix/disentanglix.py +72 -0
  25. autoencodix/evaluate/.ipynb_checkpoints/evaluate-checkpoint.py +532 -0
  26. autoencodix/evaluate/__init__.py +4 -0
  27. autoencodix/evaluate/_general_evaluator.py +730 -0
  28. autoencodix/evaluate/_xmodalix_evaluator.py +376 -0
  29. autoencodix/imagix.py +76 -0
  30. autoencodix/losses/disentanglix_loss.py +215 -0
  31. autoencodix/losses/maskix_loss.py +94 -0
  32. autoencodix/losses/vanillix_loss.py +28 -0
  33. autoencodix/losses/varix_loss.py +102 -0
  34. autoencodix/losses/xmodal_loss.py +304 -0
  35. autoencodix/maskix.py +108 -0
  36. autoencodix/modeling/.ipynb_checkpoints/__init__-checkpoint.py +16 -0
  37. autoencodix/modeling/.ipynb_checkpoints/_captum_forward-checkpoint.py +16 -0
  38. autoencodix/modeling/__init__.py +20 -0
  39. autoencodix/modeling/_captum_forward.py +20 -0
  40. autoencodix/modeling/_classifier.py +45 -0
  41. autoencodix/modeling/_imagevae_architecture.py +296 -0
  42. autoencodix/modeling/_imgfast_architecture.py +288 -0
  43. autoencodix/modeling/_layer_factory.py +71 -0
  44. autoencodix/modeling/_maskix_architecture.py +190 -0
  45. autoencodix/modeling/_ontix_architecture.py +305 -0
  46. autoencodix/modeling/_vanillix_architecture.py +136 -0
  47. autoencodix/modeling/_varix_architecture.py +192 -0
  48. autoencodix/notebooks/__init__.py +0 -0
  49. autoencodix/ontix.py +136 -0
  50. autoencodix/py.typed +0 -0
  51. autoencodix/stackix.py +122 -0
  52. autoencodix/trainers/__init__.py +6 -0
  53. autoencodix/trainers/_general_trainer.py +525 -0
  54. autoencodix/trainers/_maskix_trainer.py +116 -0
  55. autoencodix/trainers/_ontix_trainer.py +77 -0
  56. autoencodix/trainers/_stackix_orchestrator.py +522 -0
  57. autoencodix/trainers/_stackix_trainer.py +209 -0
  58. autoencodix/trainers/_xmodal_trainer.py +1006 -0
  59. autoencodix/utils/.ipynb_checkpoints/_explainer-checkpoint.py +118 -0
  60. autoencodix/utils/.ipynb_checkpoints/_model_output-checkpoint.py +30 -0
  61. autoencodix/utils/.ipynb_checkpoints/_utils-checkpoint.py +626 -0
  62. autoencodix/utils/.ipynb_checkpoints/adata_converter-checkpoint.py +99 -0
  63. autoencodix/utils/.ipynb_checkpoints/feature_importance-checkpoint.py +823 -0
  64. autoencodix/utils/__init__.py +22 -0
  65. autoencodix/utils/_annealer.py +193 -0
  66. autoencodix/utils/_bulkreader.py +232 -0
  67. autoencodix/utils/_explainer.py +246 -0
  68. autoencodix/utils/_imgreader.py +404 -0
  69. autoencodix/utils/_internals.py +23 -0
  70. autoencodix/utils/_llm_explainer.py +318 -0
  71. autoencodix/utils/_losses.py +20 -0
  72. autoencodix/utils/_model_output.py +30 -0
  73. autoencodix/utils/_result.py +393 -0
  74. autoencodix/utils/_screader.py +76 -0
  75. autoencodix/utils/_traindynamics.py +187 -0
  76. autoencodix/utils/_utils.py +690 -0
  77. autoencodix/utils/adata_converter.py +111 -0
  78. autoencodix/utils/example_data.py +398 -0
  79. autoencodix/utils/feature_importance.py +829 -0
  80. autoencodix/utils/prompts.py +21 -0
  81. autoencodix/vanillix.py +141 -0
  82. autoencodix/varix.py +80 -0
  83. autoencodix/visualize/__init__.py +5 -0
  84. autoencodix/visualize/_general_visualizer.py +913 -0
  85. autoencodix/visualize/_imagix_visualizer.py +111 -0
  86. autoencodix/visualize/_xmodal_visualizer.py +841 -0
  87. autoencodix/visualize/visualize.py +1214 -0
  88. autoencodix/xmodalix.py +318 -0
  89. autoencodix-0.2.0.dist-info/METADATA +143 -0
  90. autoencodix-0.2.0.dist-info/RECORD +91 -0
  91. autoencodix-0.2.0.dist-info/WHEEL +4 -0
@@ -0,0 +1,39 @@
1
+ from .default_config import DefaultConfig
2
+ from pydantic import Field
3
+
4
+
5
+ class MaskixConfig(DefaultConfig):
6
+ """
7
+ A specialized configuration inheriting from DefaultConfig.
8
+ """
9
+
10
+ beta: float = Field(
11
+ default=0.1, # Overridden default (was 1.0)
12
+ ge=0,
13
+ description="Beta weighting factor for VAE loss",
14
+ )
15
+ epoch: int = Field(
16
+ default=30, ge=0, description="How many epochs should the model train for."
17
+ )
18
+ maskix_hidden_dim: int = Field(
19
+ default=128,
20
+ ge=8,
21
+ description="The Maskix implementation follows https://doi.org/10.1093/bioinformatics/btae020. The authors use a hidden dimension 0f 256 for their neural network, so we set this as default",
22
+ )
23
+ maskix_swap_prob: float = Field(
24
+ default=0.2,
25
+ ge=0,
26
+ description="For the Maskix input_data masinkg, we sample a probablity if samples within one gene should be swapt. This is done with a Bernoulli distribution, maskix_swap_prob is the probablity passed to the bernoulli distribution ",
27
+ )
28
+ delta_mask_predictor: float = Field(
29
+ default=0.7,
30
+ ge=0.0,
31
+ description="Delta weighting factor of the mask prediction loss term for the Maskix",
32
+ )
33
+ delta_mask_corrupted: float = Field(
34
+ default=0.75,
35
+ ge=0.0,
36
+ description="For the Maskix: if >0.5 this gives more weight for the correct reconstruction of corrupted input",
37
+ )
38
+
39
+ # TODO find sensible defaults for Maskix
@@ -0,0 +1,35 @@
1
+ from typing import Literal
2
+ from pydantic import Field, model_validator
3
+ from .default_config import DefaultConfig
4
+
5
+
6
+ class OntixConfig(DefaultConfig):
7
+ """
8
+ A specialized configuration for Ontix that only allows scaling methods
9
+ guaranteeing non-negative outputs.
10
+ """
11
+
12
+ # 1. Override the top-level 'scaling' attribute
13
+ scaling: Literal["MINMAX", "NONE", "NOTSET", "LOG1P"] = Field(
14
+ default="MINMAX",
15
+ description="Global scaling method. For Ontix, only 'MINMAX' and 'NONE' are allowed, because we need positive values only",
16
+ )
17
+
18
+ # 2. Add a validator for the nested 'scaling' attributes
19
+ @model_validator(mode="after")
20
+ def validate_nested_scaling(self) -> "OntixConfig":
21
+ """
22
+ Ensures that any scaling method set within DataInfo is also a valid
23
+ positive-value scaler.
24
+ """
25
+ # Define the set of allowed scaling methods
26
+ allowed_scalers = {"MINMAX", "NONE", "NOTSET"}
27
+
28
+ # Loop through each data modality defined in the data_config
29
+ for modality_name, data_info in self.data_config.data_info.items():
30
+ if data_info.scaling not in allowed_scalers:
31
+ raise ValueError(
32
+ f"Invalid scaling '{data_info.scaling}' for modality '{modality_name}'. "
33
+ f"OntixConfig only permits {list(allowed_scalers)}."
34
+ )
35
+ return self
@@ -0,0 +1,33 @@
1
+ from .default_config import DefaultConfig
2
+ from pydantic import Field, model_validator
3
+
4
+ import warnings
5
+
6
+
7
+ class StackixConfig(DefaultConfig):
8
+ """
9
+ A specialized configuration inheriting from DefaultConfig.
10
+ For Stackix, `save_memory` is always False (feature not supported).
11
+ """
12
+
13
+ beta: float = Field(
14
+ default=0.1,
15
+ ge=0,
16
+ description="Beta weighting factor for VAE loss",
17
+ )
18
+
19
+ save_memory: bool = Field(
20
+ default=False,
21
+ description="Always False — not supported for Stackix.",
22
+ )
23
+
24
+ @model_validator(mode="before")
25
+ def _force_save_memory_false(cls, values):
26
+ if values.get("save_memory") is True:
27
+ warnings.warn(
28
+ "`save_memory=True` is not supported for StackixConfig — forcing to False., Set the checkpoint_interval to number of epochs if you want to save memory",
29
+ UserWarning,
30
+ stacklevel=2,
31
+ )
32
+ values["save_memory"] = False
33
+ return values
@@ -0,0 +1,18 @@
1
+ from .default_config import DefaultConfig
2
+ from pydantic import Field
3
+
4
+
5
+ class VanillixConfig(DefaultConfig):
6
+ """
7
+ A specialized configuration inheriting from DefaultConfig.
8
+ """
9
+
10
+ beta: float = Field(
11
+ default=0.1, # Overridden default (was 1.0)
12
+ ge=0,
13
+ description="Beta weighting factor for VAE loss",
14
+ )
15
+ epoch: int = Field(
16
+ default=30, ge=0, description="How many epochs should the model train for."
17
+ )
18
+ # TODO find sensible defaults for Vanillix
@@ -0,0 +1,15 @@
1
+ from .default_config import DefaultConfig
2
+ from pydantic import Field
3
+
4
+
5
+ class VarixConfig(DefaultConfig):
6
+ """
7
+ A specialized configuration inheriting from DefaultConfig.
8
+ """
9
+
10
+ beta: float = Field(
11
+ default=0.1, # Overridden default (was 1.0)
12
+ ge=0,
13
+ description="Beta weighting factor for VAE loss",
14
+ )
15
+ # TODO find sensible defaults for Varix
@@ -0,0 +1,43 @@
1
+ from .default_config import DefaultConfig
2
+
3
+ from pydantic import Field, model_validator
4
+ import warnings
5
+ from typing import Optional
6
+
7
+
8
+ class XModalixConfig(DefaultConfig):
9
+ """
10
+ A specialized configuration inheriting from DefaultConfig.
11
+
12
+ This class overrides specific training parameters like pretrain_epochs and beta
13
+ for the XModalix model, while inheriting all other settings.
14
+ """
15
+
16
+ pretrain_epochs: Optional[int] = Field(
17
+ default=None, # Overridden default (was 0)
18
+ description="Number of pretraining epochs, can be overwritten in DataInfo to have different number of pretraining epochs for each data modality",
19
+ )
20
+
21
+ beta: float = Field(
22
+ default=0.1, # Overridden default (was 1.0)
23
+ ge=0,
24
+ description="Beta weighting factor for VAE loss",
25
+ )
26
+ requires_paired: bool = Field(default=False)
27
+ save_memory: bool = Field(
28
+ default=False,
29
+ description="Always False — not supported for Stackix.",
30
+ )
31
+
32
+ @model_validator(mode="before")
33
+ def _force_save_memory_false(cls, values):
34
+ if values.get("save_memory") is True:
35
+ warnings.warn(
36
+ "`save_memory=True` is not supported for XModalixConfig — forcing to False., Set the checkpoint_interval to number of epochs if you want to save memory",
37
+ UserWarning,
38
+ stacklevel=2,
39
+ )
40
+ values["save_memory"] = False
41
+ return values
42
+
43
+ # TODO find sensible defaults for XModalix
@@ -0,0 +1,72 @@
1
+ from typing import Dict, Optional, Type, Union
2
+ import torch
3
+ import numpy as np
4
+
5
+ from autoencodix.base._base_dataset import BaseDataset
6
+ from autoencodix.utils._utils import config_method
7
+ from autoencodix.base._base_loss import BaseLoss
8
+ from autoencodix.base._base_pipeline import BasePipeline
9
+ from autoencodix.base._base_trainer import BaseTrainer
10
+ from autoencodix.base._base_visualizer import BaseVisualizer
11
+ from autoencodix.base._base_preprocessor import BasePreprocessor
12
+ from autoencodix.base._base_evaluator import BaseEvaluator
13
+ from autoencodix.base._base_autoencoder import BaseAutoencoder
14
+ from autoencodix.data._datasetcontainer import DatasetContainer
15
+ from autoencodix.data._datasplitter import DataSplitter
16
+ from autoencodix.data.datapackage import DataPackage
17
+ from autoencodix.data._numeric_dataset import NumericDataset
18
+ from autoencodix.data.general_preprocessor import GeneralPreprocessor
19
+ from autoencodix.evaluate._general_evaluator import GeneralEvaluator
20
+ from autoencodix.modeling._varix_architecture import VarixArchitecture
21
+ from autoencodix.trainers._general_trainer import GeneralTrainer
22
+ from autoencodix.utils._result import Result
23
+ from autoencodix.configs.default_config import DefaultConfig
24
+ from autoencodix.configs.disentanglix_config import DisentanglixConfig
25
+ from autoencodix.utils._losses import DisentanglixLoss
26
+ from autoencodix.visualize._general_visualizer import GeneralVisualizer
27
+
28
+
29
+ class Disentanglix(BasePipeline):
30
+ """Disentanglix-specific version of the BasePipeline.
31
+
32
+ This class extends BasePipeline. See the parent class for a full list
33
+ of attributes and methods.
34
+
35
+ Additional Attributes:
36
+ _default_config: Is set to DisentanglixConfig here.
37
+ """
38
+
39
+ def __init__(
40
+ self,
41
+ data: Optional[Union[DataPackage, DatasetContainer]] = None,
42
+ trainer_type: Type[BaseTrainer] = GeneralTrainer,
43
+ dataset_type: Type[BaseDataset] = NumericDataset,
44
+ model_type: Type[BaseAutoencoder] = VarixArchitecture,
45
+ loss_type: Type[BaseLoss] = DisentanglixLoss,
46
+ preprocessor_type: Type[BasePreprocessor] = GeneralPreprocessor,
47
+ visualizer: Type[BaseVisualizer] = GeneralVisualizer,
48
+ evaluator: Optional[Type[BaseEvaluator]] = GeneralEvaluator,
49
+ result: Optional[Result] = None,
50
+ datasplitter_type: Type[DataSplitter] = DataSplitter,
51
+ custom_splits: Optional[Dict[str, np.ndarray]] = None,
52
+ config: Optional[DefaultConfig] = None,
53
+ ) -> None:
54
+ """Initialize Varix pipeline with customizable components.
55
+
56
+ See the init method of parent class for a full list of Args.
57
+ """
58
+ self._default_config = DisentanglixConfig()
59
+ super().__init__(
60
+ data=data,
61
+ dataset_type=dataset_type,
62
+ trainer_type=trainer_type,
63
+ model_type=model_type,
64
+ loss_type=loss_type,
65
+ preprocessor_type=preprocessor_type,
66
+ visualizer=visualizer,
67
+ evaluator=evaluator,
68
+ result=result,
69
+ datasplitter_type=datasplitter_type,
70
+ config=config,
71
+ custom_split=custom_splits,
72
+ )