Run pdoc on all shimmer modules

.github/workflows/docs.yml

@@ -24,7 +24,7 @@ jobs:
           poetry run python -m pip install --upgrade pip
           poetry run pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cpu
           poetry run pip install lightning
-      - run: poetry run pdoc ./shimmer -o docs/api/ --docformat=google
+      - run: poetry run pdoc ./shimmer/* -o docs/api/ --docformat=google
       - uses: actions/upload-pages-artifact@v3
         with:
           path: docs/api/

shimmer/types.py

@@ -3,44 +3,41 @@
 
 import torch
 
-module_var = ""
-"""some doc"""
-
-RawDomainGroupT: TypeAlias = Mapping[str, Any]
+RawDomainGroupT = Mapping[str, Any]
 """
 Matched raw unimodal data from multiple domains.
 Keys of the mapping are domains names.
 """
 
-RawDomainGroupDT: TypeAlias = dict[str, Any]
+RawDomainGroupDT = dict[str, Any]
 """
 Matched raw unimodal data from multiple domains.
 Keys of the dict are domains names.
 
 This is a more specific version of `RawDomainGroupT` used in method's outputs.
 """
 
-LatentsDomainGroupT: TypeAlias = Mapping[str, torch.Tensor]
+LatentsDomainGroupT = Mapping[str, torch.Tensor]
 """
 Matched unimodal latent representations from multiple domains.
 Keys of the mapping are domains names.
 """
 
-LatentsDomainGroupDT: TypeAlias = dict[str, torch.Tensor]
+LatentsDomainGroupDT = dict[str, torch.Tensor]
 """
 Matched unimodal latent representations from multiple domains.
 Keys of the dict are domains names.
 
 This is a more specific version of `LatentsDomainGroupT` used in method's outputs.
 """
 
-LatentsDomainGroupsT: TypeAlias = Mapping[frozenset[str], LatentsDomainGroupT]
+LatentsDomainGroupsT = Mapping[frozenset[str], LatentsDomainGroupT]
 """
 Mapping of `LatentsDomainGroupT`. Keys are frozenset of domains matched in the group.
 Each group is independent and contains different data (unpaired).
 """
 
-LatentsDomainGroupsDT: TypeAlias = dict[frozenset[str], LatentsDomainGroupDT]
+LatentsDomainGroupsDT = dict[frozenset[str], LatentsDomainGroupDT]
 """
 Mapping of `LatentsDomainGroupDT`.
 Keys are frozenset of domains matched in the group.
@@ -49,20 +46,20 @@
 This is a more specific version of `LatentsDomainGroupsT` used in method's outputs.
 """
 
-RawDomainGroupsT: TypeAlias = Mapping[frozenset[str], RawDomainGroupT]
+RawDomainGroupsT = Mapping[frozenset[str], RawDomainGroupT]
 """
 Mapping of `RawDomainGroupT`. Keys are frozenset of domains matched in the group.
 Each group is independent and contains different data (unpaired).
 """
 
-RawDomainGroupsDT: TypeAlias = dict[frozenset[str], RawDomainGroupDT]
+RawDomainGroupsDT = dict[frozenset[str], RawDomainGroupDT]
 """
 Mapping of `RawDomainGroupT`. Keys are frozenset of domains matched in the group.
 Each group is independent and contains different data (unpaired).
 
 This is a more specific version of `RawDomainGroupsT` used in method's outputs.
 """
 
-ModelModeT: TypeAlias = Literal["train", "val", "test", "val/ood", "test/ood"]
+ModelModeT = Literal["train", "val", "test", "val/ood", "test/ood"]
 """Mode used by pytorch lightning.
 """