You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This PR introduces changes to the package look and feel and prepares the
repository for moving into the [MQT
organization](https://github.com/munich-quantum-toolkit).
---------
Co-authored-by: flowerthrower <flowerthrower@users.noreply.github.com>
Copy file name to clipboardExpand all lines: .github/contributing.rst
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ We value contributions from people with all levels of experience.
6
6
In particular if this is your first pull request not everything has to be perfect.
7
7
We will guide you through the process.
8
8
9
-
We use GitHub to `host code <https://github.com/cda-tum/mqt-predictor>`_, to `track issues and feature requests <https://github.com/cda-tum/mqt-predictor/issues>`_, as well as accept `pull requests <https://github.com/cda-tum/mqt-predictor/pulls>`_.
9
+
We use GitHub to `host code <https://github.com/munich-quantum-toolkit/predictor>`_, to `track issues and feature requests <https://github.com/munich-quantum-toolkit/predictor/issues>`_, as well as accept `pull requests <https://github.com/munich-quantum-toolkit/predictor/pulls>`_.
10
10
See https://docs.github.com/en/get-started/quickstart for a general introduction to working with GitHub and contributing to projects.
11
11
12
12
Types of Contributions
@@ -15,16 +15,16 @@ Types of Contributions
15
15
You can contribute in several ways:
16
16
17
17
- 🐛 Report Bugs
18
-
Report bugs at https://github.com/cda-tum/mqt-predictor/issues using the *🐛 Bug report* issue template. Please make sure to fill out all relevant information in the respective issue form.
18
+
Report bugs at https://github.com/munich-quantum-toolkit/predictor/issues using the *🐛 Bug report* issue template. Please make sure to fill out all relevant information in the respective issue form.
19
19
20
20
- 🐛 Fix Bugs
21
-
Look through the `GitHub Issues <https://github.com/cda-tum/mqt-predictor/issues>`_ for bugs. Anything tagged with "bug" is open to whoever wants to try and fix it.
21
+
Look through the `GitHub Issues <https://github.com/munich-quantum-toolkit/predictor/issues>`_ for bugs. Anything tagged with "bug" is open to whoever wants to try and fix it.
22
22
23
23
- ✨ Propose New Features
24
-
Propose new features at https://github.com/cda-tum/mqt-predictor/issues using the *✨ Feature request* issue template. Please make sure to fill out all relevant information in the respective issue form.
24
+
Propose new features at https://github.com/munich-quantum-toolkit/predictor/issues using the *✨ Feature request* issue template. Please make sure to fill out all relevant information in the respective issue form.
25
25
26
26
- ✨ Implement New Features
27
-
Look through the `GitHub Issues <https://github.com/cda-tum/mqt-predictor/issues>`_ for features. Anything tagged with "feature" is open to whoever wants to implement it. We highly appreciate external contributions to the project.
27
+
Look through the `GitHub Issues <https://github.com/munich-quantum-toolkit/predictor/issues>`_ for features. Anything tagged with "feature" is open to whoever wants to implement it. We highly appreciate external contributions to the project.
28
28
29
29
- 📝 Write Documentation
30
30
MQT Predictor could always use some more `documentation <https://mqt.readthedocs.io/projects/predictor>`_, and we appreciate any help with that.
If you are stuck with a problem using MQT Predictor or have questions, please do get in touch at our `Issues <https://github.com/cda-tum/mqt-predictor/issues>`_ or `Discussions <https://github.com/cda-tum/mqt-predictor/discussions>`_. We'd love to help.
4
+
If you are stuck with a problem using MQT Predictor or have questions, please do get in touch at our `Issues <https://github.com/munich-quantum-toolkit/predictor/issues>`_ or `Discussions <https://github.com/munich-quantum-toolkit/predictor/discussions>`_. We'd love to help.
5
5
6
6
You can save time by following this procedure when reporting a problem:
7
7
8
8
- Do try to solve the problem on your own first. Make sure to consult the `Documentation <https://mqt.readthedocs.io/projects/predictor>`_.
9
-
- Search through past `Issues <https://github.com/cda-tum/mqt-predictor/issues>`_ to see if someone else already had the same problem.
9
+
- Search through past `Issues <https://github.com/munich-quantum-toolkit/predictor/issues>`_ to see if someone else already had the same problem.
10
10
- Before filing a bug report, try to create a minimal working example (MWE) that reproduces the problem. It's much easier to identify the cause for the problem if a handful of lines suffice to show that something isn't working.
11
11
12
12
You can also always reach us at `quantum.cda@xcit.tum.de <mailto:quantum.cda@xcit.tum.de>`_.
@@ -41,13 +41,29 @@ For more details, please refer to:
41
41
</a>
42
42
</p>
43
43
44
-
MQT Predictor is part of the [Munich Quantum Toolkit (MQT)](https://mqt.readthedocs.io/) developed by the [Chair for Design Automation](https://www.cda.cit.tum.de/) at the [Technical University of Munich](https://www.tum.de/).
44
+
## Contributors and Supporters
45
45
46
-
If you have any questions, feel free to create a [discussion](https://github.com/cda-tum/mqt-predictor/discussions) or an [issue](https://github.com/cda-tum/mqt-predictor/issues) on [GitHub](https://github.com/cda-tum/mqt-predictor).
46
+
The _[Munich Quantum Toolkit (MQT)](https://mqt.readthedocs.io)_ is developed by the [Chair for Design Automation](https://www.cda.cit.tum.de/) at the [Technical University of Munich](https://www.tum.de/) and supported by the [Munich Quantum Software Company (MQSC)](https://munichquantum.software).
47
+
Among others, it is part of the [Munich Quantum Software Stack (MQSS)](https://www.munich-quantum-valley.de/research/research-areas/mqss) ecosystem, which is being developed as part of the [Munich Quantum Valley (MQV)](https://www.munich-quantum-valley.de) initiative.
`mqt-predictor` is available via [PyPI](https://pypi.org/project/mqt.predictor/).
66
+
`mqt.predictor` is available via [PyPI](https://pypi.org/project/mqt.predictor/).
51
67
52
68
```console
53
69
(venv) $ pip install mqt.predictor
@@ -59,7 +75,7 @@ The following code gives an example on the usage:
59
75
from mqt.predictor import qcompile
60
76
from mqt.bench import get_benchmark
61
77
62
-
# get a benchmark circuit on algorithmic level representing the GHZ state with 5 qubits from [MQT Bench](https://github.com/cda-tum/mqt-bench)
78
+
# get a benchmark circuit on algorithmic level representing the GHZ state with 5 qubits from [MQT Bench](https://github.com/munich-quantum-toolkit/bench)
Copy file name to clipboardExpand all lines: docs/Compilation.rst
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,5 +51,5 @@ We trained one RL model for each currently :ref:`supported quantum device <suppo
51
51
52
52
Training Data
53
53
-------------
54
-
To train the model, sufficient training data must be provided as qasm files in the `respective directory <https://github.com/cda-tum/mqt-predictor/tree/main/src/mqt/predictor/rl/training_data/training_circuits>`_.
55
-
We provide the training data used for the initial performance evaluation of this framework which are stored `here <https://github.com/cda-tum/mqt-predictor/tree/main/src/mqt/predictor/rl/training_data/trained_model>`_.
54
+
To train the model, sufficient training data must be provided as qasm files in the `respective directory <https://github.com/munich-quantum-toolkit/predictor/tree/main/src/mqt/predictor/rl/training_data/training_circuits>`_.
55
+
We provide the training data used for the initial performance evaluation of this framework which are stored `here <https://github.com/munich-quantum-toolkit/predictor/tree/main/src/mqt/predictor/rl/training_data/trained_model>`_.
Copy file name to clipboardExpand all lines: docs/DevelopmentGuide.rst
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ Ready to contribute to the project? Here is how to set up a local development en
6
6
Initial Setup
7
7
#############
8
8
9
-
1. Fork the `cda-tum/mqt-predictor <https://github.com/cda-tum/mqt-predictor>`_ repository on GitHub (see https://docs.github.com/en/get-started/quickstart/fork-a-repo).
9
+
1. Fork the `munich-quantum-toolkit/predictor <https://github.com/munich-quantum-toolkit/predictor>`_ repository on GitHub (see https://docs.github.com/en/get-started/quickstart/fork-a-repo).
0 commit comments