lazyqml 3.0.6__tar.gz → 3.1.0__tar.gz

{lazyqml-3.0.6 → lazyqml-3.1.0}/.github/workflows/docs.yml

@@ -3,7 +3,6 @@ on:
     push:
         branches:
             - main
-            - master
 jobs:
     deploy:
         runs-on: ubuntu-latest
@@ -11,19 +10,15 @@ jobs:
             - uses: actions/checkout@v4
             - uses: actions/setup-python@v5
               with:
-                  python-version: "3.9"
-
+                  python-version: "3.11"
             - name: Install dependencies
               run: |
                   python -m pip install --upgrade pip
                   pip install --user --no-cache-dir Cython
-                  pip install --user -r requirements.txt -r requirements_dev.txt
-                  pip install .
-            - name: Discover typos with codespell
-              run: |
-                  codespell --skip="*.csv,*.geojson,*.json,*.js,*.html,*cff,./.git" --ignore-words-list="aci,hist"
+                  pip install --user -r requirements.txt
             - name: PKG-TEST
               run: |
                   python -m unittest discover tests/
-            - run: mkdocs gh-deploy --force
-
+            - run: python -m pip install --upgrade pip
+            - run: pip install mkdocs-material mkdocstrings mkdocstrings-python-legacy mkdocs-git-revision-date-plugin mkdocs-jupyter
+            - run: mkdocs gh-deploy --force

lazyqml-3.1.0/PKG-INFO

@@ -0,0 +1,130 @@
+Metadata-Version: 2.1
+Name: lazyqml
+Version: 3.1.0
+Summary: LazyQML benchmarking utility to test quantum machine learning models.
+Author-email: QHPC Group <qhpcgroup@gmail.com>
+License: MIT License
+Project-URL: Homepage, https://github.com/QHPC-SP-Research-Lab/LazyQML
+Keywords: lazyqml
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.10
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: LICENSE copy
+License-File: AUTHORS.rst
+Requires-Dist: wheel
+Requires-Dist: tabulate
+Requires-Dist: torch
+Requires-Dist: torchaudio
+Requires-Dist: torchvision
+Requires-Dist: scipy
+Requires-Dist: scikit-learn
+Requires-Dist: PennyLane
+Requires-Dist: PennyLane_Lightning
+Requires-Dist: PennyLane_Lightning_GPU
+Requires-Dist: custatevec_cu12
+Requires-Dist: ucimlrepo
+Requires-Dist: pydantic
+Requires-Dist: psutil
+Requires-Dist: pandas
+Requires-Dist: joblib
+Requires-Dist: gputil
+Provides-Extra: all
+Requires-Dist: lazyqml[extra]; extra == "all"
+Provides-Extra: extra
+Requires-Dist: pandas; extra == "extra"
+
+![logo](./docs/logo.jpg)
+---
+[![Pypi](https://img.shields.io/badge/pypi-%23ececec.svg?style=for-the-badge&logo=pypi&logoColor=1f73b7)](https://pypi.python.org/pypi/lazyqml)
+![GitHub Actions](https://img.shields.io/badge/github%20actions-%232671E5.svg?style=for-the-badge&logo=githubactions&logoColor=white) 
+![NumPy](https://img.shields.io/badge/numpy-%23013243.svg?style=for-the-badge&logo=numpy&logoColor=white)
+![Pandas](https://img.shields.io/badge/pandas-%23150458.svg?style=for-the-badge&logo=pandas&logoColor=white)
+![PyTorch](https://img.shields.io/badge/PyTorch-%23EE4C2C.svg?style=for-the-badge&logo=PyTorch&logoColor=white)
+![scikit-learn](https://img.shields.io/badge/scikit--learn-%23F7931E.svg?style=for-the-badge&logo=scikit-learn&logoColor=white)
+![nVIDIA](https://img.shields.io/badge/cuda-000000.svg?style=for-the-badge&logo=nVIDIA&logoColor=green)
+![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black)
+
+
+
+LazyQML is a Python library designed to streamline, automate, and accelerate experimentation with Quantum Machine Learning (QML) architectures, right on classical computers.
+
+With LazyQML, you can:
+  - 🛠️ Build, test, and benchmark QML models with minimal effort.
+  
+  - ⚡ Compare different QML architectures, hyperparameters seamlessly.
+  
+  - 🧠 Gather knowledge about the most suitable architecture for your problem.
+
+## ✨ Why LazyQML?
+
+- Rapid Prototyping: Experiment with different QML models using just a few lines of code.
+
+- Automated Benchmarking: Evaluate performance and trade-offs across architectures effortlessly.
+
+- Flexible & Modular: From basic quantum circuits to hybrid quantum-classical models—LazyQML has you covered.
+
+## Documentation
+For detailed usage instructions, API reference, and code examples, please refer to the official LazyQML documentation.
+
+## Requirements
+
+- Python >= 3.10
+
+> [!CAUTION]
+> This library is only supported by Linux Systems. It doesn't support Windows nor MacOS. 
+
+
+## Installation
+To install lazyqml, run this command in your terminal:
+
+```
+pip install lazyqml
+```
+
+This is the preferred method to install lazyqml, as it will always install the most recent stable release.
+
+If you don't have [pip](https://pip.pypa.io) installed, this [Python installation guide](http://docs.python-guide.org/en/latest/starting/installation/) can guide you through the process.
+
+### From sources
+
+To install lazyqml from sources, run this command in your terminal:
+
+```
+pip install git+https://github.com/QHPC-SP-Research-Lab/LazyQML
+```
+## Example
+
+```python 
+from sklearn.datasets import load_iris
+from lazyqml.lazyqml import *
+
+# Load data
+data = load_iris()
+X = data.data
+y = data.target
+
+classifier = QuantumClassifier(nqubits={4}, classifiers={Model.QNN, Model.QSVM}, epochs=10)
+
+# Fit and predict
+classifier.fit(X=X, y=y, test_size=0.4)
+```
+
+## Quantum and High Performance Computing (QHPC) - University of Oviedo    
+- José Ranilla Pastor - ranilla@uniovi.es
+- Elías Fernández Combarro - efernandezca@uniovi.es
+- Diego García Vega - diegogarciavega@gmail.com
+- Fernando Álvaro Plou Llorente - ploufernando@uniovi.es
+- Alejandro Leal Castaño - lealcalejandro@uniovi.es
+- Group - https://qhpc.uniovi.es
+
+## Citing
+If you used LazyQML in your work, please cite:
+- García-Vega, D., Plou Llorente, F., Leal Castaño, A., Combarro, E.F., Ranilla, J.: Lazyqml: A python library to benchmark quantum machine learning models. In: 30th European Conference on Parallel and Distributed Processing (2024)
+
+## License
+- Free software: MIT License
+

lazyqml-3.1.0/README.md

@@ -0,0 +1,91 @@
+![logo](./docs/logo.jpg)
+---
+[![Pypi](https://img.shields.io/badge/pypi-%23ececec.svg?style=for-the-badge&logo=pypi&logoColor=1f73b7)](https://pypi.python.org/pypi/lazyqml)
+![GitHub Actions](https://img.shields.io/badge/github%20actions-%232671E5.svg?style=for-the-badge&logo=githubactions&logoColor=white) 
+![NumPy](https://img.shields.io/badge/numpy-%23013243.svg?style=for-the-badge&logo=numpy&logoColor=white)
+![Pandas](https://img.shields.io/badge/pandas-%23150458.svg?style=for-the-badge&logo=pandas&logoColor=white)
+![PyTorch](https://img.shields.io/badge/PyTorch-%23EE4C2C.svg?style=for-the-badge&logo=PyTorch&logoColor=white)
+![scikit-learn](https://img.shields.io/badge/scikit--learn-%23F7931E.svg?style=for-the-badge&logo=scikit-learn&logoColor=white)
+![nVIDIA](https://img.shields.io/badge/cuda-000000.svg?style=for-the-badge&logo=nVIDIA&logoColor=green)
+![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black)
+
+
+
+LazyQML is a Python library designed to streamline, automate, and accelerate experimentation with Quantum Machine Learning (QML) architectures, right on classical computers.
+
+With LazyQML, you can:
+  - 🛠️ Build, test, and benchmark QML models with minimal effort.
+  
+  - ⚡ Compare different QML architectures, hyperparameters seamlessly.
+  
+  - 🧠 Gather knowledge about the most suitable architecture for your problem.
+
+## ✨ Why LazyQML?
+
+- Rapid Prototyping: Experiment with different QML models using just a few lines of code.
+
+- Automated Benchmarking: Evaluate performance and trade-offs across architectures effortlessly.
+
+- Flexible & Modular: From basic quantum circuits to hybrid quantum-classical models—LazyQML has you covered.
+
+## Documentation
+For detailed usage instructions, API reference, and code examples, please refer to the official LazyQML documentation.
+
+## Requirements
+
+- Python >= 3.10
+
+> [!CAUTION]
+> This library is only supported by Linux Systems. It doesn't support Windows nor MacOS. 
+
+
+## Installation
+To install lazyqml, run this command in your terminal:
+
+```
+pip install lazyqml
+```
+
+This is the preferred method to install lazyqml, as it will always install the most recent stable release.
+
+If you don't have [pip](https://pip.pypa.io) installed, this [Python installation guide](http://docs.python-guide.org/en/latest/starting/installation/) can guide you through the process.
+
+### From sources
+
+To install lazyqml from sources, run this command in your terminal:
+
+```
+pip install git+https://github.com/QHPC-SP-Research-Lab/LazyQML
+```
+## Example
+
+```python 
+from sklearn.datasets import load_iris
+from lazyqml.lazyqml import *
+
+# Load data
+data = load_iris()
+X = data.data
+y = data.target
+
+classifier = QuantumClassifier(nqubits={4}, classifiers={Model.QNN, Model.QSVM}, epochs=10)
+
+# Fit and predict
+classifier.fit(X=X, y=y, test_size=0.4)
+```
+
+## Quantum and High Performance Computing (QHPC) - University of Oviedo    
+- José Ranilla Pastor - ranilla@uniovi.es
+- Elías Fernández Combarro - efernandezca@uniovi.es
+- Diego García Vega - diegogarciavega@gmail.com
+- Fernando Álvaro Plou Llorente - ploufernando@uniovi.es
+- Alejandro Leal Castaño - lealcalejandro@uniovi.es
+- Group - https://qhpc.uniovi.es
+
+## Citing
+If you used LazyQML in your work, please cite:
+- García-Vega, D., Plou Llorente, F., Leal Castaño, A., Combarro, E.F., Ranilla, J.: Lazyqml: A python library to benchmark quantum machine learning models. In: 30th European Conference on Parallel and Distributed Processing (2024)
+
+## License
+- Free software: MIT License
+

lazyqml-3.1.0/docs/common.md

@@ -0,0 +1,3 @@
+# common module
+
+::: lazyqml.lazyqml

{lazyqml-3.0.6 → lazyqml-3.1.0}/lazyqml/__init__.py

@@ -2,4 +2,4 @@
 
 __author__ = """Diego García Vega, Fernando Álvaro Plou Llorente, Alejandro Leal Castaño"""
 __email__ = "garciavdiego@uniovi.es, ploufernando@uniovi.es, lealcalejandro@uniovi.es"
-__version__ = "3.0.6"
+__version__ = "3.1.0"

lazyqml-3.1.0/lazyqml.egg-info/PKG-INFO

@@ -0,0 +1,130 @@
+Metadata-Version: 2.1
+Name: lazyqml
+Version: 3.1.0
+Summary: LazyQML benchmarking utility to test quantum machine learning models.
+Author-email: QHPC Group <qhpcgroup@gmail.com>
+License: MIT License
+Project-URL: Homepage, https://github.com/QHPC-SP-Research-Lab/LazyQML
+Keywords: lazyqml
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.10
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: LICENSE copy
+License-File: AUTHORS.rst
+Requires-Dist: wheel
+Requires-Dist: tabulate
+Requires-Dist: torch
+Requires-Dist: torchaudio
+Requires-Dist: torchvision
+Requires-Dist: scipy
+Requires-Dist: scikit-learn
+Requires-Dist: PennyLane
+Requires-Dist: PennyLane_Lightning
+Requires-Dist: PennyLane_Lightning_GPU
+Requires-Dist: custatevec_cu12
+Requires-Dist: ucimlrepo
+Requires-Dist: pydantic
+Requires-Dist: psutil
+Requires-Dist: pandas
+Requires-Dist: joblib
+Requires-Dist: gputil
+Provides-Extra: all
+Requires-Dist: lazyqml[extra]; extra == "all"
+Provides-Extra: extra
+Requires-Dist: pandas; extra == "extra"
+
+![logo](./docs/logo.jpg)
+---
+[![Pypi](https://img.shields.io/badge/pypi-%23ececec.svg?style=for-the-badge&logo=pypi&logoColor=1f73b7)](https://pypi.python.org/pypi/lazyqml)
+![GitHub Actions](https://img.shields.io/badge/github%20actions-%232671E5.svg?style=for-the-badge&logo=githubactions&logoColor=white) 
+![NumPy](https://img.shields.io/badge/numpy-%23013243.svg?style=for-the-badge&logo=numpy&logoColor=white)
+![Pandas](https://img.shields.io/badge/pandas-%23150458.svg?style=for-the-badge&logo=pandas&logoColor=white)
+![PyTorch](https://img.shields.io/badge/PyTorch-%23EE4C2C.svg?style=for-the-badge&logo=PyTorch&logoColor=white)
+![scikit-learn](https://img.shields.io/badge/scikit--learn-%23F7931E.svg?style=for-the-badge&logo=scikit-learn&logoColor=white)
+![nVIDIA](https://img.shields.io/badge/cuda-000000.svg?style=for-the-badge&logo=nVIDIA&logoColor=green)
+![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black)
+
+
+
+LazyQML is a Python library designed to streamline, automate, and accelerate experimentation with Quantum Machine Learning (QML) architectures, right on classical computers.
+
+With LazyQML, you can:
+  - 🛠️ Build, test, and benchmark QML models with minimal effort.
+  
+  - ⚡ Compare different QML architectures, hyperparameters seamlessly.
+  
+  - 🧠 Gather knowledge about the most suitable architecture for your problem.
+
+## ✨ Why LazyQML?
+
+- Rapid Prototyping: Experiment with different QML models using just a few lines of code.
+
+- Automated Benchmarking: Evaluate performance and trade-offs across architectures effortlessly.
+
+- Flexible & Modular: From basic quantum circuits to hybrid quantum-classical models—LazyQML has you covered.
+
+## Documentation
+For detailed usage instructions, API reference, and code examples, please refer to the official LazyQML documentation.
+
+## Requirements
+
+- Python >= 3.10
+
+> [!CAUTION]
+> This library is only supported by Linux Systems. It doesn't support Windows nor MacOS. 
+
+
+## Installation
+To install lazyqml, run this command in your terminal:
+
+```
+pip install lazyqml
+```
+
+This is the preferred method to install lazyqml, as it will always install the most recent stable release.
+
+If you don't have [pip](https://pip.pypa.io) installed, this [Python installation guide](http://docs.python-guide.org/en/latest/starting/installation/) can guide you through the process.
+
+### From sources
+
+To install lazyqml from sources, run this command in your terminal:
+
+```
+pip install git+https://github.com/QHPC-SP-Research-Lab/LazyQML
+```
+## Example
+
+```python 
+from sklearn.datasets import load_iris
+from lazyqml.lazyqml import *
+
+# Load data
+data = load_iris()
+X = data.data
+y = data.target
+
+classifier = QuantumClassifier(nqubits={4}, classifiers={Model.QNN, Model.QSVM}, epochs=10)
+
+# Fit and predict
+classifier.fit(X=X, y=y, test_size=0.4)
+```
+
+## Quantum and High Performance Computing (QHPC) - University of Oviedo    
+- José Ranilla Pastor - ranilla@uniovi.es
+- Elías Fernández Combarro - efernandezca@uniovi.es
+- Diego García Vega - diegogarciavega@gmail.com
+- Fernando Álvaro Plou Llorente - ploufernando@uniovi.es
+- Alejandro Leal Castaño - lealcalejandro@uniovi.es
+- Group - https://qhpc.uniovi.es
+
+## Citing
+If you used LazyQML in your work, please cite:
+- García-Vega, D., Plou Llorente, F., Leal Castaño, A., Combarro, E.F., Ranilla, J.: Lazyqml: A python library to benchmark quantum machine learning models. In: 30th European Conference on Parallel and Distributed Processing (2024)
+
+## License
+- Free software: MIT License
+

{lazyqml-3.0.6 → lazyqml-3.1.0}/lazyqml.egg-info/SOURCES.txt

@@ -4,7 +4,6 @@ AUTHORS.rst
 LICENSE
 LICENSE copy
 MANIFEST.in
-README copy.md
 README.md
 experimentallibs.txt
 mkdocs.yml
@@ -27,6 +26,7 @@ docs/faq.md
 docs/index.md
 docs/installation.md
 docs/lazyqml.md
+docs/logo.jpg
 docs/usage.md
 docs/examples/intro.ipynb
 docs/overrides/main.html

{lazyqml-3.0.6 → lazyqml-3.1.0}/mkdocs.yml

@@ -1,8 +1,8 @@
 site_name: lazyqml
 site_description: LazyQML benchmarking utility to test quantum machine learning models.
-site_author: DiegoGV-Uniovi
-site_url: https://DiegoGV-Uniovi.github.io/lazyqml
-repo_url: https://github.com/DiegoGV-Uniovi/lazyqml
+site_author: QHPC Group
+site_url: https://QHPC-SP-Research-Lab.github.io/lazyqml
+repo_url: https://github.com/QHPC-SP-Research-Lab/LazyQML
 
 copyright: "Copyright © 2024 - 2024 Diego García Vega"
 
@@ -40,18 +40,7 @@ plugins:
     - search
     - mkdocstrings
     - git-revision-date
-    - git-revision-date-localized:
-          enable_creation_date: true
-          type: timeago
-    # - pdf-export
-    - mkdocs-jupyter:
-          include_source: True
-          ignore_h1_titles: True
-          execute: True
-          allow_errors: false
-          ignore: ["conf.py"]
-          execute_ignore: ["*ignore.ipynb"]
-          
+
 markdown_extensions:
     - admonition
     - abbr
@@ -78,9 +67,9 @@ nav:
     - Contributing: contributing.md
     - FAQ: faq.md
     - Changelog: changelog.md
-    - Report Issues: https://github.com/DiegoGV-Uniovi/lazyqml/issues
+    - Report Issues: https://github.com/QHPC-SP-Research-Lab/LazyQML/issues
     - Examples:
         - examples/intro.ipynb
     - API Reference:
-          - lazyqml module: lazyqml.md
-          - common module: common.md
+        - lazyqml module: lazyqml.md
+

{lazyqml-3.0.6 → lazyqml-3.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "lazyqml"
-version = "3.0.6"
+version = "3.1.0"
 dynamic = [
     "dependencies",
 ]
@@ -48,7 +48,7 @@ universal = true
 
 
 [tool.bumpversion]
-current_version = "3.0.6"
+current_version = "3.1.0"
 commit = true
 tag = true