qudas 0.1.0__tar.gz

qudas-0.1.0/LICENSE

@@ -0,0 +1,233 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+   Copyright 2024 DEVEL Co., Ltd.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+---
+
+## Additional Terms and Conditions for Qudas
+
+The following terms are supplementary to the Apache License Version 2.0 and apply specifically to the use of the Qudas software package:
+
+1. **Prohibited Uses**
+   - The software may not be used for illegal activities, intellectual property infringement, or any purpose that violates public policy.
+   - Reverse engineering, decompiling, or modifying the software is prohibited unless explicitly permitted by this license or applicable law.
+
+2. **Export Control Compliance**
+   - Users agree to comply with all applicable export control laws and regulations when using this software.
+
+3. **Disclaimer of High-Risk Use**
+   - This software is not designed for high-risk applications such as life support systems, nuclear facilities, or other critical infrastructure requiring fail-safe performance.
+
+4. **Third-Party Components**
+   - This package may include third-party components with their own licensing terms. Users must adhere to these terms when using those components.
+
+5. **Support and Maintenance**
+   - The Qudas package is provided "AS IS" without warranty of any kind. Support and maintenance are not guaranteed but may be available under separate terms.
+
+6. **Fixstars Amplify SDK Compliance**
+   - If the software integrates or interfaces with the Fixstars Amplify SDK, users must comply with the SDK's licensing terms as specified by Fixstars Corporation.
+
+7. **Liability Limitations**
+   - Under no circumstances shall the authors or copyright holders be liable for any damages arising from the use of this software, except as required by applicable law.
+
+---
+
+For inquiries or more information, contact: higa.devel@gmail.com

qudas-0.1.0/MANIFEST.in

@@ -0,0 +1,8 @@
+include README.md
+include LICENSE
+include VERSION
+include requirements.txt
+recursive-include docs *    # docs フォルダ内のすべてのファイルを含める
+recursive-include tests *   # テストフォルダ内のすべてのファイルを含める
+graft qudas                 # qudas フォルダ全体を含める
+global-exclude *.pyc        # コンパイル済みのPythonファイルを除外

qudas-0.1.0/PKG-INFO

@@ -0,0 +1,272 @@
+Metadata-Version: 2.1
+Name: qudas
+Version: 0.1.0
+Summary: Quantum data transform package
+Home-page: https://github.com/devel-system/qudas
+Author: Keiichiro Higa
+Author-email: Keiichiro Higa <higa.devel@gmail.com>
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+
+# Qudas (Quantum Data Transformation Library)
+
+Qudasは、量子計算における最適化問題の入出力データを変換するためのPythonライブラリです。異なるデータ形式間の変換をサポートし、さまざまな量子計算環境での統一的なデータ処理を可能にします。
+
+## 主な機能
+- 量子計算における入力データのフォーマット変換
+- 計算結果の出力データのフォーマット変換
+- AnnealingやGateデバイスのデータに対応
+
+## インストール
+以下のコマンドを使用してインストールします。
+
+```
+pip install qudas
+```
+
+## 使用方法
+
+### 初期化
+
+```python
+from qudata import QuData
+
+# 最適化問題の初期化
+prob = {('q0', 'q1'): 1.0, ('q2', 'q2'): -1.0}
+qudata = QuData.input(prob)
+print(qudata.prob)  # 出力: {('q0', 'q1'): 1.0, ('q2', 'q2'): -1.0}
+
+# Noneで初期化した場合
+qudata = QuData.input()
+print(qudata.prob)  # 出力: {}
+```
+
+### 加算・減算・乗算・べき乗
+
+```python
+# 辞書形式の問題を加算
+qudata1 = QuData.input({('q0', 'q1'): 1.0})
+qudata2 = QuData.input({('q0', 'q0'): 2.0})
+result = qudata1 + qudata2
+print(result.prob)  # 出力: {('q0', 'q1'): 1.0, ('q0', 'q0'): 2.0}
+
+# 辞書形式の問題をべき乗
+qudata = QuData.input({('q0', 'q1'): 1.0})
+result = qudata ** 2
+print(result.prob)  # 出力: {('q0', 'q1'): 1.0, ('q0', 'q2', 'q1'): -2.0}
+```
+
+### データ形式の変換（QuDataInput）
+デバイスへの様々な入力形式のデータを `QuData` オブジェクトを介して変換することができます。
+
+#### pyqubo から Amplify への変換
+```python
+from pyqubo import Binary
+from qudas import QuData
+
+# Pyqubo で問題を定義
+q0, q1 = Binary("q0"), Binary("q1")
+prob = (q0 + q1) ** 2
+
+# QuData に Pyqubo の問題を渡す
+qudata = QuData.input().from_pyqubo(prob)
+print(qudata.prob)  # 出力: {('q0', 'q0'): 1.0, ('q0', 'q1'): 2.0, ('q1', 'q1'): 1.0}
+
+# Amplify 形式に変換
+amplify_prob = qudata.to_amplify()
+print(amplify_prob)
+```
+
+#### 配列から BQM への変換
+```python
+import numpy as np
+from qudas import QuData
+
+# Numpy 配列を定義
+prob = np.array([
+    [1, 1, 0],
+    [0, 2, 0],
+    [0, 0, -1],
+])
+
+# QuData に配列を渡す
+qudata = QuData.input().from_array(prob)
+print(qudata.prob)  # 出力: {('q_0', 'q_0'): 1, ('q_0', 'q_1'): 1, ('q_1', 'q_1'): 2, ('q_2', 'q_2'): -1}
+
+# BQM 形式に変換
+bqm_prob = qudata.to_dimod_bqm()
+print(bqm_prob)
+```
+
+#### CSV から PuLP への変換
+```python
+import pulp
+from qudas import QuData
+
+# CSVファイルのパス
+csv_file_path = './data/qudata.csv'
+
+# QuData に CSV を渡す
+qudata = QuData.input().from_csv(csv_file_path)
+print(qudata.prob)  # 出力: {('q_0', 'q_0'): 1.0, ('q_0', 'q_2'): 2.0, ...}
+
+# PuLP 形式に変換
+pulp_prob = qudata.to_pulp()
+print(pulp_prob)
+```
+
+### データ形式の変換（QuDataOutput）
+デバイスからの様々な出力形式のデータを `QuData` オブジェクトを介して変換することができます。
+
+#### PuLP から Amplify への変換
+```python
+   import pulp
+   from qudas import QuData
+
+   # PuLP問題を定義して解く
+   prob = pulp.LpProblem("Test Problem", pulp.LpMinimize)
+   x = pulp.LpVariable('x', lowBound=0, upBound=1, cat='Binary')
+   y = pulp.LpVariable('y', lowBound=0, upBound=1, cat='Binary')
+   prob += 2*x - y
+   prob.solve()
+
+   # QuDataOutputのインスタンスを生成し、from_pulpメソッドで問題を変換
+   qudata = QuData.output().from_pulp(prob)
+   print(qudata.prob)  # 出力: {'x': 2.0, 'y': -1.0}
+
+   # Amplify形式に変換
+   amplify_prob = qudata.to_amplify()
+   print(amplify_prob)  # 出力: Amplifyの目標関数形式
+```
+
+#### SciPy から Dimod への変換
+```python
+   import numpy as np
+   from sympy import symbols, lambdify
+   from scipy.optimize import minimize, Bounds
+   from qudas import QuData
+
+   # シンボリック変数の定義
+   q0, q1, q2 = symbols('q0 q1 q2')
+
+   # 目的関数を定義
+   objective_function = 2 * q0 - q1 - q2
+
+   # シンボリック関数を数値化して評価できる形式に変換
+   f = lambdify([q0, q1, q2], objective_function, 'numpy')
+
+   # 初期解 (すべて0.5に設定)
+   q = [0.5, 0.5, 0.5]
+
+   # バイナリ変数の範囲を定義 (0 <= x <= 1)
+   bounds = Bounds([0, 0, 0], [1, 1, 1])
+
+   # SciPyで制約付き最適化を実行
+   res = minimize(lambda q: f(q[0], q[1], q[2]), q, method='SLSQP', bounds=bounds)
+
+   # QuDataOutputのインスタンスを生成し、from_scipyメソッドをテスト
+   qudata = QuData.output().from_scipy(res)
+   print(qudata.prob)  # 出力: {'q0': 2, 'q1': -1, 'q2': -1}
+
+   # Dimod形式に変換
+   dimod_prob = qudata.to_dimod_bqm()
+   print(dimod_prob)  # 出力: DimodのBQM形式
+```
+
+## テストコード
+本ライブラリには、以下のようなテストを含めて動作確認を行っています。
+
+```python
+class TestQudata(unittest.TestCase):
+
+    def test_init_with_dict(self):
+        # 辞書データで初期化する場合のテスト
+        prob = {('q0', 'q1'): 1.0, ('q2', 'q2'): -1.0}
+        qudata = QuData.input(prob)
+        self.assertTrue(dicts_are_equal(qudata.prob, prob))
+
+    def test_add(self):
+        # __add__メソッドのテスト
+        prob1 = {('q0', 'q1'): 1.0}
+        prob2 = {('q0', 'q0'): 2.0}
+        qudata1 = QuData.input(prob1)
+        qudata2 = QuData.input(prob2)
+        result = qudata1 + qudata2
+        expected = {('q0', 'q1'): 1.0, ('q0', 'q0'): 2.0}
+        self.assertTrue(dicts_are_equal(result.prob, expected))
+```
+
+## 開発者向け情報
+
+### ドキュメントの生成方法
+
+Sphinxを使用してHTMLドキュメントを生成します。
+
+1. 初回の設定
+```
+mkdir docs
+cd docs
+sphinx-quickstart
+sphinx-apidoc -f -o source ../qudas
+```
+
+2. `docs/source/conf.py` を適宜修正
+
+3. ドキュメントをビルド
+```
+cd docs
+make clean
+make html
+```
+
+生成されたHTMLドキュメントは `docs/build/html/index.html` で確認できます。
+Markdownは [GitHub-flavored Markdown](https://guides.github.com/features/mastering-markdown/) を参考にしてください。
+
+### テスト
+Qudasのテストは、`tests/` ディレクトリに配置された `test_xxx.py` ファイルで行います。テストの実行は以下のコマンドで可能です。
+
+```
+pytest tests/
+```
+
+### コードフォーマット
+
+このプロジェクトでは、Python コードのフォーマットに [Black](https://black.readthedocs.io/en/stable/) を使用しています。`Black` は自動でコードを整形し、一貫したスタイルを保つことができます。
+
+#### `Black` を使ったコードフォーマット
+
+1. `Black` のインストール:
+    - 開発環境用の依存パッケージとともに `Black` をインストールします:
+    ```bash
+    pip install .[dev]
+    ```
+
+2. コードを自動フォーマットするには、プロジェクトのルートディレクトリで次のコマンドを実行します:
+    ```bash
+    black .
+    ```
+
+    これにより、すべての Python ファイルが自動的にフォーマットされます。
+
+#### コードフォーマットの確認
+
+`black --check .` コマンドを使用すると、コードがフォーマットされているかどうかを確認することができます。このコマンドは実際にはファイルを変更せず、フォーマットが必要かどうかを表示するだけです。
+
+```bash
+black --check .
+```
+
+### パッケージの更新方法
+以下のコマンドでパッケージを更新します。
+
+```
+pip install . -U
+```
+
+## ライセンス
+このプロジェクトはApache-2.0ライセンスの下で提供されています。詳細は`LICENSE`ファイルを参照してください。