Module rename (#49)

qiskit-community · Sep 13, 2024 · 723249c · 723249c
1 parent 3495722
commit 723249c
Show file tree

Hide file tree

Showing 60 changed files with 176 additions and 180 deletions.
diff --git a/.github/workflows/draft-pdf.yml b/.github/workflows/draft-pdf.yml
@@ -1,25 +1,25 @@
-name: Build JoSS paper
+# name: Build JoSS paper
 
-on:
-  workflow_dispatch:
-  push:
-    paths:
-      - 'docs/paper/**'
+# on:
+#   workflow_dispatch:
+#   push:
+#     paths:
+#       - 'docs/paper/**'
 
-jobs:
-  paper:
-    runs-on: ubuntu-latest
-    name: Paper Draft
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Build draft PDF
-        uses: openjournals/openjournals-draft-action@master
-        with:
-          journal: joss
-          paper-path: docs/paper/paper.md
-      - name: Upload
-        uses: actions/upload-artifact@v1
-        with:
-          name: paper
-          path: docs/paper/paper.pdf
+# jobs:
+#   paper:
+#     runs-on: ubuntu-latest
+#     name: Paper Draft
+#     steps:
+#       - name: Checkout
+#         uses: actions/checkout@v3
+#       - name: Build draft PDF
+#         uses: openjournals/openjournals-draft-action@master
+#         with:
+#           journal: joss
+#           paper-path: docs/paper/paper.md
+#       - name: Upload
+#         uses: actions/upload-artifact@v1
+#         with:
+#           name: paper
+#           path: docs/paper/paper.pdf
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -2,15 +2,15 @@
 
 **We appreciate all kinds of help, so thank you!**
 
-## Contributing to Blackwater
+## Contributing to ML-QEM
 
 Specific details for contributing to this project are outlined below.
 
 ### Reporting Bugs and Requesting Features
 
 Users are encouraged to use GitHub Issues for reporting issues and requesting features.
 
-### Ask/Answer Questions and Discuss Blackwater
+### Ask/Answer Questions and Discuss ML-QEM
 
 Users are encouraged to use GitHub Discussions for engaging with researchers, developers, and other users regarding this project and the provided examples.
 

diff --git a/README.md b/README.md
@@ -1,9 +1,6 @@
-# Blackwater
-
-![logo](./docs/images/logo.gif)
-
-Package for solving quantum computing problems using machine learning.
+# ML-QEM
 
+Package for quantum error mitigation and solving general quantum computing problems using machine learning.
 
 ### Table of Contents
 
@@ -21,7 +18,7 @@ Package for solving quantum computing problems using machine learning.
 ### How to Give Feedback
 
 We encourage your feedback! You can share your thoughts with us by:
-- [Opening an issue](https://github.com/IceKhan13/blackwater/issues) in the repository
+- [Opening an issue](https://github.com/qiskit-community/ml-qem/issues) in the repository
 
 
 ----------------------------------------------------------------------------------------------------
@@ -38,7 +35,6 @@ For information on how to contribute to this project, please take a look at our
 [2] Qiskit-terra https://github.com/Qiskit/qiskit-terra \
 [3] PyTorch https://pytorch.org/ \
 [4] PyTorch geometric https://pytorch-geometric.readthedocs.io/en/latest/ \
-[5] [Zlatko Minev](https://github.com/zlatko-minev) for :water_polo: :ocean:
 
 ----------------------------------------------------------------------------------------------------
 

diff --git a/blackwater/exception.py b/blackwater/exception.py
diff --git a/blackwater/metrics/__init__.py b/blackwater/metrics/__init__.py
diff --git a/docs/apidocs/data.rst b/docs/apidocs/data.rst
@@ -1,6 +1,6 @@
-.. _blackwater-data:
+.. _ml_qem-data:
 
-.. automodule:: blackwater.data
+.. automodule:: ml_qem.data
    :no-members:
    :no-inherited-members:
    :no-special-members:
diff --git a/docs/apidocs/index.rst b/docs/apidocs/index.rst
@@ -1,8 +1,8 @@
-.. module:: blackwater
+.. module:: ml_qem
 
-=========================
-BlackWater API References
-=========================
+=====================
+ML-QEM API References
+=====================
 
 .. toctree::
    :maxdepth: 1

diff --git a/docs/apidocs/library.rst b/docs/apidocs/library.rst
@@ -1,6 +1,6 @@
-.. _blackwater-library:
+.. _ml_qem-library:
 
-.. automodule:: blackwater.library
+.. automodule:: ml_qem.library
    :no-members:
    :no-inherited-members:
    :no-special-members:
diff --git a/docs/apidocs/metrics.rst b/docs/apidocs/metrics.rst
@@ -1,6 +1,6 @@
-.. _blackwater-metrics:
+.. _ml_qem-metrics:
 
-.. automodule:: blackwater.metrics
+.. automodule:: ml_qem.metrics
    :no-members:
    :no-inherited-members:
    :no-special-members:
diff --git a/docs/apidocs/primitives.rst b/docs/apidocs/primitives.rst
@@ -1,6 +1,6 @@
-.. _blackwater-primitives:
+.. _ml_qem-primitives:
 
-.. automodule:: blackwater.primitives
+.. automodule:: ml_qem.primitives
    :no-members:
    :no-inherited-members:
    :no-special-members:
diff --git a/docs/apidocs/rl.rst b/docs/apidocs/rl.rst
@@ -1,6 +1,6 @@
-.. _blackwater-rl:
+.. _ml_qem-rl:
 
-.. automodule:: blackwater.rl
+.. automodule:: ml_qem.rl
    :no-members:
    :no-inherited-members:
    :no-special-members:
diff --git a/docs/conf.py b/docs/conf.py
@@ -8,7 +8,7 @@
 
 sys.path.append(os.path.abspath('..'))
 
-project = "BlackWater"
+project = "ML-QEM"
 copyright = "2023"  # pylint: disable=redefined-builtin
 author = ""
 

diff --git a/docs/guides/01_encoders.ipynb b/docs/guides/01_encoders.ipynb
@@ -18,7 +18,7 @@
     "from qiskit import QuantumCircuit, transpile\n",
     "from qiskit.providers.fake_provider import FakeLimaV2\n",
     "\n",
-    "from blackwater.data.encoders.graph_utils import (\n",
+    "from ml_qem.data.encoders.graph_utils import (\n",
     "    circuit_to_json_graph, \n",
     "    backend_to_json_graph, \n",
     "    BackendNodeEncoder\n",
@@ -146,7 +146,7 @@
     "from qiskit.quantum_info import SparsePauliOp\n",
     "from torch_geometric.data import Data\n",
     "\n",
-    "from blackwater.data.encoders.graph_utils import ExpValData"
+    "from ml_qem.data.encoders.graph_utils import ExpValData"
    ]
   },
   {

diff --git a/docs/guides/03_data_io.ipynb b/docs/guides/03_data_io.ipynb
@@ -19,9 +19,9 @@
     "from qiskit.providers.fake_provider import FakeLimaV2\n",
     "from qiskit.quantum_info import SparsePauliOp\n",
     "\n",
-    "from blackwater.data.encoders.graph_utils import ExpValData\n",
-    "from blackwater.data.dataio.dataio import ExpValDataWriter\n",
-    "from blackwater.data.loaders.dataclasses import ExpValDataSet"
+    "from ml_qem.data.encoders.graph_utils import ExpValData\n",
+    "from ml_qem.data.dataio.dataio import ExpValDataWriter\n",
+    "from ml_qem.data.loaders.dataclasses import ExpValDataSet"
    ]
   },
   {

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,12 +1,10 @@
-##########
-BlackWater
-##########
+######
+ML-QEM
+######
 
-BlackWater: Library for solving quantum computing problems using machine learning
+ML-QEM: Library for quantum error mitigation and solving quantum computing problems using machine learning
 
-.. image:: /images/logo.gif
-
-The source code to the project is available `on GitHub <https://github.com/IceKhan13/blackwater>`_.
+The source code to the project is available `on GitHub <https://github.com/qiskit-community/ml-qem>`_.
 
 ------------
 
@@ -15,7 +13,7 @@ The source code to the project is available `on GitHub <https://github.com/IceKh
 .. code-block::
    :caption: pip install
 
-      pip install blackwater
+      pip install ml_qem
 
 
 ------------

diff --git a/docs/installation_guide.md b/docs/installation_guide.md
@@ -1,4 +1,4 @@
-# Blackwater Installation Guide
+# ML-QEM Installation Guide
 
 ## PyPi
 
@@ -13,7 +13,7 @@ Installation through PyPi is not available
 pip install -r requirements.txt
 ```
 
-3. Installing Blackwater
+3. Installing ML-QEM
 
 ```shell
 pip install .

diff --git a/docs/paper/paper.md b/docs/paper/paper.md
@@ -1,5 +1,5 @@
 ---
-title: 'BlackWater: library.rst for solving quantum computing problems using machine learning'
+title: 'ML-QEM: library.rst for solving quantum computing problems using machine learning'
 tags:
   - quantum computing
   - qiskit
@@ -19,10 +19,10 @@ bibliography: paper.bib
 
 # Summary
 
-BlackWater is an open-source machine learning library designed to address 
+ML-QEM is an open-source machine learning library designed to address 
 the challenges of solving quantum computing problems. By integrating 
 cutting-edge machine learning techniques with the intricacies of quantum 
-computing, BlackWater provides a comprehensive set of tools for researchers 
+computing, ML-QEM provides a comprehensive set of tools for researchers 
 and practitioners in the field. This library enables the application of 
 classical machine learning algorithms to quantum computing, bridging 
 the gap between the two domains and accelerating the development of 

diff --git a/docs/tutorials/01_ngem.ipynb b/docs/tutorials/01_ngem.ipynb
@@ -63,8 +63,8 @@
     "from qiskit.quantum_info import SparsePauliOp\n",
     "from qiskit.primitives import BackendEstimator, Estimator\n",
     "\n",
-    "from blackwater.data.encoders.graph_utils import ExpValData\n",
-    "from blackwater.data.dataio import ExpValDataWriter"
+    "from ml_qem.data.encoders.graph_utils import ExpValData\n",
+    "from ml_qem.data.dataio import ExpValDataWriter"
    ]
   },
   {
@@ -155,7 +155,7 @@
     "\n",
     "import glob\n",
     "from torch_geometric.loader import DataLoader\n",
-    "from blackwater.data.loaders.dataclasses import ExpValDataSet\n",
+    "from ml_qem.data.loaders.dataclasses import ExpValDataSet\n",
     "\n",
     "paths = glob.glob(f\"{data_folder}/**.json\")\n",
     "split = int(0.6 * len(paths))\n",
@@ -180,7 +180,7 @@
    "source": [
     "# create model\n",
     "\n",
-    "from blackwater.library.ngem import SimpleExpectationValueModel\n",
+    "from ml_qem.library.ngem import SimpleExpectationValueModel\n",
     "\n",
     "model = SimpleExpectationValueModel(\n",
     "    num_node_features=22, \n",
@@ -400,12 +400,12 @@
    "source": [
     "# estimator\n",
     "\n",
-    "from blackwater.primitives.learning_esimator import (\n",
+    "from ml_qem.primitives.learning_esimator import (\n",
     "    learning_estimator,\n",
     "    ScikitLearnEstimatorModel,\n",
     "    TorchGeometricEstimatorModel,\n",
     ")\n",
-    "from blackwater.data.encoders.graph_utils import DefaultPyGEstimatorEncoder\n",
+    "from ml_qem.data.encoders.graph_utils import DefaultPyGEstimatorEncoder\n",
     "\n",
     "\n",
     "circuit = transpile(random_circuit(5, 2),  fake_lima)\n",

diff --git a/blackwater/VERSION.txt → ml_qem/VERSION.txt b/blackwater/VERSION.txt → ml_qem/VERSION.txt
diff --git a/blackwater/__init__.py → ml_qem/__init__.py b/blackwater/__init__.py → ml_qem/__init__.py
diff --git a/blackwater/data/__init__.py → ml_qem/data/__init__.py b/blackwater/data/__init__.py → ml_qem/data/__init__.py
@@ -1,9 +1,9 @@
 """
-=============================
-Data (:mod:`blackwater.data`)
-=============================
+=========================
+Data (:mod:`ml_qem.data`)
+=========================
 
-.. currentmodule:: blackwater.data
+.. currentmodule:: ml_qem.data
 
 Circuit encoders
 ================

diff --git a/blackwater/data/core.py → ml_qem/data/core.py b/blackwater/data/core.py → ml_qem/data/core.py
@@ -1,4 +1,5 @@
 """Dataclasses module."""
+
 from abc import abstractmethod
 from dataclasses import dataclass
 from typing import List, Any
@@ -76,8 +77,8 @@ def encode(self, node: DAGNode, **kwargs) -> List[float]:  # type: ignore
 
 # pylint: disable=no-member
 @dataclass
-class BlackwaterData:
-    """BlackwaterData."""
+class MLQEMData:
+    """MLQEMData."""
 
     def serialize(self) -> dict:
         """Serialize class data to dictionary"""

diff --git a/blackwater/data/dataio/__init__.py → ml_qem/data/dataio/__init__.py b/blackwater/data/dataio/__init__.py → ml_qem/data/dataio/__init__.py
@@ -1,2 +1,3 @@
 """Data io module."""
+
 from .dataio import ExpValDataWriter, ExpValDataReader, Reader, Writer
Original file line number	Diff line number	Diff line change
		@@ -1,2 +1,3 @@
		"""Data io module."""

		from .dataio import ExpValDataWriter, ExpValDataReader, Reader, Writer