pyautoencoder 1.0.7__tar.gz → 1.0.8__tar.gz

pyautoencoder-1.0.8/.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          # install your package and test deps
+          pip install .
+          pip install pytest
+          # if you have more dev deps, add them here
+
+      - name: Run tests
+        run: |
+          pytest

pyautoencoder-1.0.8/.github/workflows/publish.yml

@@ -0,0 +1,33 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: read
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install build tooling
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI via OIDC
+        uses: pypa/gh-action-pypi-publish@release/v1

pyautoencoder-1.0.8/.gitignore

@@ -0,0 +1,177 @@
+.vscode
+data
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc

{pyautoencoder-1.0.7 → pyautoencoder-1.0.8}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 Andrea Pollastro
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2025 Andrea Pollastro
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{pyautoencoder-1.0.7 → pyautoencoder-1.0.8}/PKG-INFO

@@ -1,165 +1,156 @@
-Metadata-Version: 2.4
-Name: pyautoencoder
-Version: 1.0.7
-Summary: A Python package offering implementations of state-of-the-art autoencoder architectures in PyTorch.
-Home-page: https://github.com/andrea-pollastro/pyautoencoder
-Author: Andrea Pollastro
-License: MIT
-Keywords: autoencoder,pytorch,deep learning,machine learning,representation learning,dimensionality reduction,generative models
-Classifier: Operating System :: OS Independent
-Classifier: Intended Audience :: Science/Research
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python
-Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: torch>=2.0.0
-Dynamic: author
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
-Dynamic: license-file
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-# PyAutoencoder
-
-A clean, modular PyTorch library for building and training autoencoders.
-
-<!-- <p align="center">
-  <img src="assets/logo_nobackground.png" alt="pyautoencoder logo" width="220"/>
-</p> -->
-
-![logo](https://raw.githubusercontent.com/andrea-pollastro/pyautoencoder/main/assets/logo_nobackground.png)
-
-<p align="center">
-  <a href="https://pypi.org/project/pyautoencoder/"><img alt="PyPI" src="https://img.shields.io/pypi/v/pyautoencoder.svg"></a>
-  <a href="https://github.com/andrea-pollastro/pyautoencoder/blob/main/LICENSE"><img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-blue.svg"></a>
-  <a href="https://github.com/andrea-pollastro/pyautoencoder/stargazers"><img alt="Stars" src="https://img.shields.io/github/stars/andrea-pollastro/pyautoencoder?style=social"></a>
-</p>
-
----
-
-## Highlights
-
-PyAutoencoder is designed to offer **simple and easy access to autoencoder frameworks**. Here's what it offers:
-
-- **Minimal, composable API**  
-You don't have to inherit from complicated base classes or learn a new training loop. Simply provide your own PyTorch nn.Module encoder and decoder, and plug them into the ready‑to‑use autoencoder wrappers. This makes it easy to experiment with different architectures (e.g. MLPs, CNNs) while reusing the same training pipeline.
-
-- **Ready‑to‑use autoencoders**
-  The library ships with working implementations of autoencoders, each paired with their respective loss functions. You can start training in a few lines, without re‑implementing reconstruction likelihoods, KL divergence, or other boilerplate.
-
-- **PyTorch compatibility**  
-  The library is fully compatible with the PyTorch ecosystem, so models integrate naturally with modules, tensors, optimizers, and schedulers.
-
-- **Lightweight, research‑oriented**  
-  The library is intentionally minimal: no training loop frameworks, no heavy abstractions. This makes it well suited for research prototypes where you want control and transparency.
-
-> **Status**: The project is in an early but usable stage. Contributions, issues, and feedback are highly encouraged!
-
-**Currently implemented**:
-- Autoencoder (AE)
-- Variational Autoencoder (VAE)
-
----
-
-## Installation
-
-```bash
-pip install pyautoencoder
-```
-
-Or install from source for development:
-
-```bash
-git clone https://github.com/andrea-pollastro/pyautoencoder.git
-cd pyautoencoder
-pip install -e .
-```
-
-## Quick start
-
-```python
-import torch
-import torch.nn as nn
-from pyautoencoder.variational import VAE
-from pyautoencoder.loss import VAELoss
-
-# Define encoder/decoder
-encoder = nn.Sequential(
-    nn.Linear(784, 512), 
-    nn.ReLU(),
-    nn.Linear(512, 256)
-)
-
-decoder = nn.Sequential(
-    nn.Linear(256, 512), 
-    nn.ReLU(),
-    nn.Linear(512, 784)
-)
-
-# Model
-vae = VAE(encoder=encoder, decoder=decoder, latent_dim=32)
-
-# Loss
-criterion = VAELoss(beta=1.0, likelihood="gaussian")
-optimizer = torch.optim.Adam(vae.parameters())
-for x in dataloader:
-    optimizer.zero_grad()
-    out = vae(x)
-    losses = criterion(out, x)
-    losses.total.backward() # negative ELBO
-    optimizer.step()
-
-    # optional: log components
-    log_likelihood = losses.components["log_likelihood"]
-    kl_divergence = losses.components["kl_divergence"]
-```
-
-## Built‑in models
-
-- **`AE`** — standard Autoencoder
-  ```python
-  from pyautoencoder.vanilla import AE
-  from pyautoencoder.loss import AELoss
-  ae = AE(encoder=encoder, decoder=decoder)
-  criterion = AELoss(likelihood="gaussian") # or bernoulli
-  ```
-
-- **`VAE`** — Variational Autoencoder
-  ```python
-  from pyautoencoder.variational import VAE, VAELoss
-  from pyautoencoder.loss import VAELoss
-  vae = VAE(encoder=encoder, decoder=decoder, latent_dim=32)
-  criterion = VAELoss(beta=1.0, likelihood="gaussian") # or bernoulli
-  ```
-
-## Examples
-
-See the [`examples/`](examples/) folder for runnable scripts showing example of usage.
-
-## License
-
-This project is released under the **MIT License**. See [LICENSE](LICENSE).
-
-## Citation
-
-If you use this package in academic work, please cite:
-
-```bibtex
-@misc{pollastro2025pyautoencoder,
-  author       = {Andrea Pollastro},
-  title        = {pyautoencoder},
-  year         = {2025},
-  howpublished = {GitHub repository},
-  url          = {https://github.com/andrea-pollastro/pyautoencoder}
-}
-```
+Metadata-Version: 2.4
+Name: pyautoencoder
+Version: 1.0.8
+Summary: A Python package offering implementations of state-of-the-art autoencoder architectures in PyTorch.
+Author: Andrea Pollastro
+License: MIT
+Project-URL: Homepage, https://github.com/andrea-pollastro/pyautoencoder
+Project-URL: Repository, https://github.com/andrea-pollastro/pyautoencoder
+Keywords: autoencoder,pytorch,deep learning,machine learning,representation learning,dimensionality reduction,generative models
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: torch>=2.1.0
+Dynamic: license-file
+
+# PyAutoencoder
+
+A clean, modular PyTorch library for building and training autoencoders.
+
+<!-- <p align="center">
+  <img src="assets/logo_nobackground.png" alt="pyautoencoder logo" width="220"/>
+</p> -->
+
+![logo](https://raw.githubusercontent.com/andrea-pollastro/pyautoencoder/main/assets/logo_nobackground.png)
+
+<p align="center">
+  <a href="https://pypi.org/project/pyautoencoder/"><img alt="PyPI" src="https://img.shields.io/pypi/v/pyautoencoder.svg"></a>
+  <a href="https://github.com/andrea-pollastro/pyautoencoder/blob/main/LICENSE"><img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-blue.svg"></a>
+  <a href="https://github.com/andrea-pollastro/pyautoencoder/stargazers"><img alt="Stars" src="https://img.shields.io/github/stars/andrea-pollastro/pyautoencoder?style=social"></a>
+</p>
+
+---
+
+## Highlights
+
+PyAutoencoder is designed to offer **simple and easy access to autoencoder frameworks**. Here's what it offers:
+
+- **Minimal, composable API**  
+You don't have to inherit from complicated base classes or learn a new training loop. Simply provide your own PyTorch nn.Module encoder and decoder, and plug them into the ready‑to‑use autoencoder wrappers. This makes it easy to experiment with different architectures (e.g. MLPs, CNNs) while reusing the same training pipeline.
+
+- **Ready‑to‑use autoencoders**
+  The library ships with working implementations of autoencoders, each paired with their respective loss functions. You can start training in a few lines, without re‑implementing reconstruction likelihoods, KL divergence, or other boilerplate.
+
+- **PyTorch compatibility**  
+  The library is fully compatible with the PyTorch ecosystem, so models integrate naturally with modules, tensors, optimizers, and schedulers.
+
+- **Lightweight, research‑oriented**  
+  The library is intentionally minimal: no training loop frameworks, no heavy abstractions. This makes it well suited for research prototypes where you want control and transparency.
+
+> **Status**: The project is in an early but usable stage. Contributions, issues, and feedback are highly encouraged!
+
+**Currently implemented**:
+- Autoencoder (AE)
+- Variational Autoencoder (VAE)
+
+---
+
+## Installation
+
+```bash
+pip install pyautoencoder
+```
+
+Or install from source for development:
+
+```bash
+git clone https://github.com/andrea-pollastro/pyautoencoder.git
+cd pyautoencoder
+pip install -e .
+```
+
+## Quick start
+
+```python
+import torch
+import torch.nn as nn
+from pyautoencoder.variational import VAE
+from pyautoencoder.loss import VAELoss
+
+# Define encoder/decoder
+encoder = nn.Sequential(
+    nn.Linear(784, 512), 
+    nn.ReLU(),
+    nn.Linear(512, 256)
+)
+
+decoder = nn.Sequential(
+    nn.Linear(256, 512), 
+    nn.ReLU(),
+    nn.Linear(512, 784)
+)
+
+# Model
+vae = VAE(encoder=encoder, decoder=decoder, latent_dim=32)
+
+# Loss
+criterion = VAELoss(beta=1.0, likelihood="gaussian")
+optimizer = torch.optim.Adam(vae.parameters())
+for x in dataloader:
+    optimizer.zero_grad()
+    out = vae(x)
+    losses = criterion(out, x)
+    losses.total.backward() # negative ELBO
+    optimizer.step()
+
+    # optional: log components
+    log_likelihood = losses.components["log_likelihood"]
+    kl_divergence = losses.components["kl_divergence"]
+```
+
+## Built‑in models
+
+- **`AE`** — standard Autoencoder
+  ```python
+  from pyautoencoder.vanilla import AE
+  from pyautoencoder.loss import AELoss
+  ae = AE(encoder=encoder, decoder=decoder)
+  criterion = AELoss(likelihood="gaussian") # or bernoulli
+  ```
+
+- **`VAE`** — Variational Autoencoder
+  ```python
+  from pyautoencoder.variational import VAE, VAELoss
+  from pyautoencoder.loss import VAELoss
+  vae = VAE(encoder=encoder, decoder=decoder, latent_dim=32)
+  criterion = VAELoss(beta=1.0, likelihood="gaussian") # or bernoulli
+  ```
+
+## Examples
+
+See the [`examples/`](examples/) folder for runnable scripts showing example of usage.
+
+## License
+
+This project is released under the **MIT License**. See [LICENSE](LICENSE).
+
+## Citation
+
+If you use this package in academic work, please cite:
+
+```bibtex
+@misc{pollastro2025pyautoencoder,
+  author       = {Andrea Pollastro},
+  title        = {pyautoencoder},
+  year         = {2025},
+  howpublished = {GitHub repository},
+  url          = {https://github.com/andrea-pollastro/pyautoencoder}
+}
+```