Add docstring #201

Glacialte · 2025-02-14T00:50:51Z

docstringを追加しました。docstringがReadtheDocsに反映されていない問題を解消しました。
f64のみ表示されていたのでf32も一応表示しています。

…ched

…operator.hpp

…batched to ReadtheDocs

KowerKoint · 2025-02-14T02:17:03Z

include/scaluq/circuit/circuit.hpp

+                                                     ">>> print(circuit.to_json())",
+                                                     "{\"gate_list\":[],\"n_qubits\":3}"}))
+                                .build_as_google_style()
+                                .c_str())
        .def(nb::init<std::uint64_t>(), "Initialize empty circuit of specified qubits.")


Suggested change

.def(nb::init<std::uint64_t>(), "Initialize empty circuit of specified qubits.")

.def(nb::init<std::uint64_t>(), "n_qubits"_a, "Initialize empty circuit of specified qubits.")

引数の名前をいれないとドキュメントがargやらarg0やらになって見づらいのでここをそれぞれ入れていってほしいです

KowerKoint · 2025-02-14T02:18:30Z

include/scaluq/gate/gate.hpp

-            [](const GATE_TYPE<FLOAT>& gate) { return gate->get_inverse(); },                \
+            [](const GATE_TYPE<FLOAT>& gate) {                                               \
+                auto inv = gate->get_inverse();                                              \
+                if (!inv) nb::none();                                                        \


KowerKoint · 2025-02-14T02:22:33Z

include/scaluq/gate/gate.hpp

+inline nb::sig concatenate_description(const std::string& desc) {
+    std::string combined =
+        desc +
+        "\n\n.. note:: Upcast is required to use gate-general functions (ex: add to Circuit).";
+    return nb::sig(combined.c_str());
+}


使ってない…？
もともとのマクロでは何が不都合でしたか

変更してた時の残骸です...
消しておきます。

KowerKoint · 2025-02-14T02:26:24Z

include/scaluq/gate/gate_factory.hpp

+    mgate.def(
+        "Y",
+        &gate::Y<Fp>,
+        "taget"_a,


Suggested change

"taget"_a,

"target"_a,

KowerKoint · 2025-02-14T02:30:16Z

include/scaluq/gate/gate_factory.hpp

+        "controls"_a = std::vector<std::uint64_t>{},
+        DocString()
+            .desc("Generate general Gate class instance of S.")
+            .desc("Performs phase flip operation.")


Performs phase flip operationのコピペ跡がたくさん残ってそうです．

すべてのゲートについて言葉で説明しなくてもよさそうです(どちらかというと行列表現を全部書いてあげるとまず理解の齟齬がなくて良さそう)

KowerKoint · 2025-02-14T03:03:02Z

include/scaluq/gate/gate_factory.hpp

各ゲートのクラスとの関連性がわかるように書きたい(「RXGateのインスタンスを作るけどGenericなGate型で返す．RXGateクラス固有の関数が使いたければダウンキャストしてくれ．」のような書き方をしたい)

KowerKoint · 2025-02-14T03:16:29Z

include/scaluq/operator/pauli_operator.hpp

+                          .value("PAULI_I", PauliOperator<Fp>::PAULI_I)
+                          .value("PAULI_X", PauliOperator<Fp>::PAULI_X)
+                          .value("PAULI_Y", PauliOperator<Fp>::PAULI_Y)
+                          .value("PAULI_Z", PauliOperator<Fp>::PAULI_Z);


これ前の書き方だったらドキュメント化されないんでしたっけ？いいとは思います．
値の名前をPAULI_*に変えた意図も一応知りたいのと，pauli_enumに代入する必要はなさそうに見えています．

ただのIやXだとmake htmlで失敗してたんですが、今元通りにしたらエラーが消えてました...
それ以外で変えた意図はないので元通りにしておきます。pauli_enumに代入する必要がないのは確かに。

KowerKoint · 2025-02-14T03:17:51Z

include/scaluq/operator/pauli_operator.hpp

+            .desc("Given `target_qubit_list: std::vector<std::uint64_t>, pauli_id_list: "
+                  "std::vector<std::uint64_t>, coef: Complex<Fp>`, Initialize pauli operator. For "
+                  "each `i`, single pauli correspond to `pauli_id_list[i]` is applied to "
+                  "`target_qubit_list`-th qubit.")


Suggested change

"`target_qubit_list`-th qubit.")

"`target_qubit_list[i]`-th qubit.")

KowerKoint · 2025-02-14T03:18:04Z

include/scaluq/operator/pauli_operator.hpp

+                  "`target_qubit_list`-th qubit.")
+            .desc("Given `pauli_string: std::string_view, coef: Complex<Fp>`, Initialize pauli "
+                  "operator. For each `i`, single pauli correspond to `pauli_id_list[i]` is "
+                  "applied to `target_qubit_list`-th qubit.")


Suggested change

"applied to `target_qubit_list`-th qubit.")

"applied to `target_qubit_list[i]`-th qubit.")

KowerKoint · 2025-02-14T03:18:25Z

include/scaluq/operator/pauli_operator.hpp

+                  "applied to `target_qubit_list`-th qubit.")
+            .desc("Given `pauli_id_par_qubit: std::vector<std::uint64_t>, coef: Complex<Fp>`, "
+                  "Initialize pauli operator. For each `i`, single pauli correspond to "
+                  "`paul_id_per_qubit` is applied to `i`-th qubit.")


Suggested change

"`paul_id_per_qubit` is applied to `i`-th qubit.")

"`paul_id_per_qubit[i]` is applied to `i`-th qubit.")

gandalfr-KY · 2025-02-18T02:48:33Z

include/scaluq/gate/gate_standard.hpp

Glacialte さんの変更差分ではないんですが，GlobalPhaseGateの表示がこうなっているのでついでに修正をお願いしたいです．

もう一つついででいうなら，説明中の数式に現れる angle を θ とかに変えたいですね
数式っぽくないのと，U1,U2,U3 はそうなっているので

引数の名前で書いてたんですが、そもそも引数の名前をギリシャ文字の名前にすると良さそうですね。(Global Phaseならphaseではなくgamma、RX/RY/RZならtheta)

gandalfr-KY · 2025-02-18T02:55:38Z

include/scaluq/state/state_vector_batched.hpp

        .def(
            "load_json",
            [](StateVectorBatched<Fp>& states, const std::string& str) {
                states = nlohmann::json::parse(str);
            },
-            "Read an object from the JSON representation of the states.");
+            "json_str"_a,


ほかのload_jsonも引数をargからjson_strに統一したいですね

KowerKoint · 2025-02-28T01:22:25Z

include/scaluq/circuit/circuit.hpp

@@ -164,6 +186,8 @@ void bind_circuit_circuit_hpp(nb::module_& m) {
                }
                circuit.update_quantum_state(states, parameters);
            },
+            "state"_a,
+            "kwargs"_a,
            "Apply gate to the StateVectorBatched. StateVectorBatched in args is directly updated. "
            "If the circuit contains parametric gate, you have to give real value of parameter as "
            "\"name=[value1, value2, ...]\" format in kwargs.")


このPRの変更分ではないんですが、Circuit::copyでは #135 以降各ゲートはコピーされなくなった(参照渡しされる)ので反映してほしい

KowerKoint · 2025-02-28T01:53:36Z

include/scaluq/gate/gate.hpp

**Control qubits is not included.**→**Control qubits are not included.**
(今回の変更分じゃないですが)

KowerKoint · 2025-02-28T02:00:55Z

doc/source/conf.py

-subprocess.run([sys.executable, '-m', 'nanobind.stubgen', '-m', 'scaluq.scaluq_core.gate', '-o', './stub/scaluq/gate.py'])
+stub_dir = Path('./stub/scaluq/')
+stub_dir.mkdir(parents=True, exist_ok=True)
+


GateType initialize などはサブモジュールに含まれていないのでscaluq_core直下の分も入れてほしい

KowerKoint · 2025-02-28T02:03:20Z

include/scaluq/gate/gate.hpp

            "Generate inverse gate as `Gate` type. If not exists, return None.")             \
        .def(                                                                                \
            "update_quantum_state",                                                          \
            [](const GATE_TYPE<FLOAT>& gate, StateVector<FLOAT>& state_vector) {             \
                gate->update_quantum_state(state_vector);                                    \
            },                                                                               \
+            "state"_a,                                                                       \


ドキュメントはstate_vectorと書いてるので合わせたい

KowerKoint · 2025-02-28T02:57:35Z

include/scaluq/operator/pauli_operator.hpp

+            .desc("Given `coef: Complex<Fp>`, Initialize operator which just multiplying coef.")
+            .desc("Given `target_qubit_list: std::vector<std::uint64_t>, pauli_id_list: "
+                  "std::vector<std::uint64_t>, coef: Complex<Fp>`, Initialize pauli operator. For "
+                  "each `i`, single pauli correspond to `pauli_id_list[i]` is applied to "
+                  "`target_qubit_list[i]`-th qubit.")
+            .desc("Given `pauli_string: std::string_view, coef: Complex<Fp>`, Initialize pauli "
+                  "operator. For each `i`, single pauli correspond to `pauli_id_list[i]` is "
+                  "applied to `target_qubit_list[i]`-th qubit.")
+            .desc("Given `pauli_id_par_qubit: std::vector<std::uint64_t>, coef: Complex<Fp>`, "
+                  "Initialize pauli operator. For each `i`, single pauli correspond to "
+                  "`paul_id_per_qubit[i]` is applied to `i`-th qubit.")
+            .desc("Given `bit_flip_mask: std::uint64_t, phase_flip_mask: std::uint64_t, coef: "
+                  "Complex<Fp>`, Initialize pauli operator. For each `i`, single pauli applied to "
+                  "`i`-th qubit is "


Complex<Fp>とかstd::vector<std::uint64_t>ではなくてPythonの型で書きたい。complex, list[int]

KowerKoint · 2025-02-28T03:07:19Z

include/scaluq/gate/gate_factory.hpp

+        "target"_a,
+        DocString()
+            .desc("Generate general :class:`~f64.Gate` class instance of CNotGate. Performs "
+                  "controlled-X operation.")


「instance of XGate with one control qubit」みたいなのほうが正しそうです。
downcastしてくれという説明もXGateにdowncastしないといけないのでそう書きたい

Glacialte added 12 commits January 10, 2025 11:19

add docstring for gate_factory, richer docstring for state_vector_bat…

f96fd11

…ched

add f32 module

28c1fe3

undo changes

980271e

iroiro fix

2c4ffc0

mini fix for conf.py, remove export_values() for pauli_enum in pauli_…

cbae27d

…operator.hpp

add concatenate_descriotion() to gate.hpp

b70955f

Merge remote-tracking branch 'origin/main' into add-docstring

061a608

fix python package

ddc91df

mini fix example, gate.hpp

d7a92d5

reflect description for circuit, operator, paulioperator, statevector…

48a7065

…batched to ReadtheDocs

add description of constructors

bcf4211

mini fix

fc33700

Glacialte requested review from KowerKoint and gandalfr-KY February 14, 2025 00:50

remove unnecessary option in conf.py

6dff6f4

KowerKoint reviewed Feb 14, 2025

View reviewed changes

gandalfr-KY reviewed Feb 18, 2025

View reviewed changes

add more detailed description

dc7e967

KowerKoint reviewed Feb 28, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add docstring #201

Add docstring #201

Glacialte commented Feb 14, 2025

KowerKoint Feb 14, 2025

KowerKoint Feb 14, 2025

KowerKoint Feb 14, 2025

Glacialte Feb 18, 2025

KowerKoint Feb 14, 2025

KowerKoint Feb 14, 2025

KowerKoint Feb 14, 2025

KowerKoint Feb 14, 2025

Glacialte Feb 21, 2025

KowerKoint Feb 14, 2025

KowerKoint Feb 14, 2025

KowerKoint Feb 14, 2025

gandalfr-KY Feb 18, 2025

gandalfr-KY Feb 18, 2025

KowerKoint Feb 19, 2025

gandalfr-KY Feb 18, 2025

KowerKoint Feb 28, 2025

KowerKoint Feb 28, 2025

KowerKoint Feb 28, 2025

KowerKoint Feb 28, 2025

KowerKoint Feb 28, 2025

KowerKoint Feb 28, 2025

	.def(nb::init<std::uint64_t>(), "Initialize empty circuit of specified qubits.")
	.def(nb::init<std::uint64_t>(), "n_qubits"_a, "Initialize empty circuit of specified qubits.")

	"`target_qubit_list`-th qubit.")
	"`target_qubit_list[i]`-th qubit.")

	"applied to `target_qubit_list`-th qubit.")
	"applied to `target_qubit_list[i]`-th qubit.")

	"`paul_id_per_qubit` is applied to `i`-th qubit.")
	"`paul_id_per_qubit[i]` is applied to `i`-th qubit.")

Add docstring #201

Are you sure you want to change the base?

Add docstring #201

Conversation

Glacialte commented Feb 14, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment