deploy: e5742cc

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 44a8f2a4d492a666343d4261f2cdf146
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/getting_started.rst.txt

@@ -0,0 +1,59 @@
+Getting Started
+================
+
+Setup
+-----
+
+Begin by creating a new Python environment or activating an existing one for working with the `piQture` library. You set up a Python virtual environment `venv` or a Conda environment and use `pip` or `conda` to install the `piQture` package.
+
+Here's how you can create a conda environment and manage a Python environment:
+
+.. code:: sh
+
+    # Create a new conda environment
+    conda create -n piqture_env python=3.x
+
+    # Activate the conda environment
+    conda activate piqture_env
+
+Installation
+------------
+
+Once the Python environment is activated, the required `piQture` package can be installed using `pip`. You can install the latest version directly from PyPI.
+
+.. code:: sh
+
+    pip install piqture
+
+To create a development environment, and install `piQture` from source, you can refer to section :ref:`Install from Source <installation_from_source>`.
+
+.. _installation_from_source:
+Installation from Source
+------------------------
+
+To set up a development environment and install `piQture` from source, follow these steps:
+
+1. Start by cloning the `piQture` repository from GitHub.
+
+.. code:: sh
+
+    # Clone the GitHub repository.
+    git clone https://github.com/SaashaJoshi/piQture.git
+
+
+2. Activate the Python environment and navigate to the `piQture` repository directory. Then, inside the Python environment, install the required dependencies from the `requirements.txt` configuration file.
+
+.. code:: sh
+
+    # Install the required dependencies
+    pip install -r requirements.txt
+
+
+3. Install `piQture` in editable mode to make changes to the source code.
+
+.. code:: sh
+
+    # Install from source in editable mode
+    pip install -e .
+
+Your development environment is set up, and `piQture` is installed from source. You can now start making changes to the code, running tests, and contributing to the project as a developer.

_sources/index.rst.txt

@@ -0,0 +1,29 @@
+.. piQture documentation master file, created by
+   sphinx-quickstart on Wed Apr 24 19:35:42 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to piQture's documentation!
+===================================
+
+**piQture** is a Python and Qiskit-based toolkit designed to simplify the development, execution, and training of Quantum Machine Learning (QML) models tailored for image processing tasks. This library seamlessly integrates with the Qiskit SDK, providing a convenient and user-friendly workflow for leveraging the potential of quantum computing for advanced image processing.
+
+
+Contribution Guidelines
+-----------------------
+
+We welcome contributions! Whether you're a quantum enthusiast or a Python developer, your input is valuable. Check out our Contribution Guidelines to get started.
+
+Authors and Citation
+--------------------
+
+Saasha Joshi
+
+Table of Contents
+------------------
+
+.. toctree::
+   :maxdepth: 2
+
+   getting_started
+   piqture

_sources/modules.rst.txt

@@ -0,0 +1,7 @@
+piqture
+=======
+
+.. toctree::
+   :maxdepth: 4
+
+   piqture

_sources/piqture.data_loader.rst.txt

@@ -0,0 +1,10 @@
+Data Loader
+============================
+
+piqture.data\_loader.mnist\_data\_loader module
+-----------------------------------------------
+
+.. automodule:: piqture.data_loader.mnist_data_loader
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/piqture.embeddings.image_embeddings.rst.txt

@@ -0,0 +1,34 @@
+Image Embeddings
+============================================
+
+piqture.embeddings.image\_embeddings.frqi module
+------------------------------------------------
+
+.. automodule:: piqture.embeddings.image_embeddings.frqi
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+piqture.embeddings.image\_embeddings.ineqr module
+-------------------------------------------------
+
+.. automodule:: piqture.embeddings.image_embeddings.ineqr
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+piqture.embeddings.image\_embeddings.mcrqi module
+-------------------------------------------------
+
+.. automodule:: piqture.embeddings.image_embeddings.mcrqi
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+piqture.embeddings.image\_embeddings.neqr module
+------------------------------------------------
+
+.. automodule:: piqture.embeddings.image_embeddings.neqr
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/piqture.embeddings.rst.txt

@@ -0,0 +1,34 @@
+Embeddings
+==========================
+
+Submodules
+-----------
+.. toctree::
+   :maxdepth: 2
+
+   piqture.embeddings.image_embeddings
+
+piqture.embeddings.amplitude\_encoder module
+--------------------------------------------
+
+.. automodule:: piqture.embeddings.amplitude_encoder
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+piqture.embeddings.angle\_encoding module
+-----------------------------------------
+
+.. automodule:: piqture.embeddings.angle_encoding
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+piqture.embeddings.image\_embedding module
+------------------------------------------
+
+.. automodule:: piqture.embeddings.image_embedding
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/piqture.gates.rst.txt

@@ -0,0 +1,18 @@
+Gates
+=====================
+
+piqture.gates.two\_qubit\_unitary module
+----------------------------------------
+
+.. automodule:: piqture.gates.two_qubit_unitary
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+piqture.gates.unitary\_block module
+-----------------------------------
+
+.. automodule:: piqture.gates.unitary_block
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/piqture.mixin.rst.txt

@@ -0,0 +1,10 @@
+Mixin
+=====================
+
+piqture.mixin.image\_embedding\_mixin module
+--------------------------------------------
+
+.. automodule:: piqture.mixin.image_embedding_mixin
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/piqture.neural_networks.layers.rst.txt

@@ -0,0 +1,34 @@
+Neural Network Layers
+=======================================
+
+piqture.neural\_networks.layers.base\_layer module
+--------------------------------------------------
+
+.. automodule:: piqture.neural_networks.layers.base_layer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+piqture.neural\_networks.layers.convolutional\_layer module
+-----------------------------------------------------------
+
+.. automodule:: piqture.neural_networks.layers.convolutional_layer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+piqture.neural\_networks.layers.fully\_connected\_layer module
+--------------------------------------------------------------
+
+.. automodule:: piqture.neural_networks.layers.fully_connected_layer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+piqture.neural\_networks.layers.pooling\_layer module
+-----------------------------------------------------
+
+.. automodule:: piqture.neural_networks.layers.pooling_layer
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/piqture.neural_networks.rst.txt

@@ -0,0 +1,34 @@
+Neural Networks
+================================
+
+
+Submodules
+-----------
+.. toctree::
+   :maxdepth: 2
+
+   piqture.neural_networks.layers
+
+piqture.neural\_networks.qcnn module
+------------------------------------
+
+.. automodule:: piqture.neural_networks.qcnn
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+piqture.neural\_networks.quantum\_autoencoder module
+----------------------------------------------------
+
+.. automodule:: piqture.neural_networks.quantum_autoencoder
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+piqture.neural\_networks.quantum\_neural\_network module
+--------------------------------------------------------
+
+.. automodule:: piqture.neural_networks.quantum_neural_network
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/piqture.rst.txt

@@ -0,0 +1,25 @@
+piQture
+=======
+
+API References
+--------------
+
+.. toctree::
+   :maxdepth: 2
+
+   piqture.data_loader
+   piqture.embeddings
+   piqture.gates
+   piqture.mixin
+   piqture.neural_networks
+   piqture.tensor_networks
+   piqture.transforms
+   piqture.variational_classifiers
+
+.. only:: never
+    Module contents
+    ---------------
+    .. automodule:: piqture
+       :members:
+       :undoc-members:
+       :show-inheritance:

_sources/piqture.tensor_networks.rst.txt

@@ -0,0 +1,42 @@
+Tensor Networks
+================================
+
+piqture.tensor\_networks.base\_tensor\_network module
+-----------------------------------------------------
+
+.. automodule:: piqture.tensor_networks.base_tensor_network
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+piqture.tensor\_networks.mera module
+------------------------------------
+
+.. automodule:: piqture.tensor_networks.mera
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+piqture.tensor\_networks.mps module
+-----------------------------------
+
+.. automodule:: piqture.tensor_networks.mps
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+piqture.tensor\_networks.peps module
+------------------------------------
+
+.. automodule:: piqture.tensor_networks.peps
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+piqture.tensor\_networks.ttn module
+-----------------------------------
+
+.. automodule:: piqture.tensor_networks.ttn
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/piqture.transforms.rst.txt

@@ -0,0 +1,10 @@
+Transforms
+==========================
+
+piqture.transforms.transforms module
+------------------------------------
+
+.. automodule:: piqture.transforms.transforms
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/piqture.variational_classifiers.rst.txt

@@ -0,0 +1,26 @@
+piqture.variational\_classifiers package
+========================================
+
+piqture.variational\_classifiers.data\_reuploading module
+---------------------------------------------------------
+
+.. automodule:: piqture.variational_classifiers.data_reuploading
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+piqture.variational\_classifiers.kernel\_estimator module
+---------------------------------------------------------
+
+.. automodule:: piqture.variational_classifiers.kernel_estimator
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+piqture.variational\_classifiers.variational\_classifier module
+---------------------------------------------------------------
+
+.. automodule:: piqture.variational_classifiers.variational_classifier
+   :members:
+   :undoc-members:
+   :show-inheritance: