clean up docstrings a bit

Author: jjcmoon

src/circuit.cpp

@@ -455,14 +455,14 @@ nb::class_<Circuit>(m, "Circuit")
 .def("add_SDD_from_file", &Circuit::add_SDD_from_file, "filename"_a, "true_lits"_a = std::vector<int>(), "false_lits"_a = std::vector<int>())
 .def("add_D4_from_file", &Circuit::add_D4_from_file, "filename"_a, "true_lits"_a = std::vector<int>(), "false_lits"_a = std::vector<int>())
 .def("_get_indices", &Circuit::get_indices)
-.def("nb_nodes", &Circuit::nb_nodes, "number of nodes in the circuit")
-.def("nb_root_nodes", &Circuit::nb_root_nodes, "number of root nodes in the circuit")
-.def("true_node", &Circuit::true_node, "adds a true node to the circuit, and returns a pointer")
-.def("false_node", &Circuit::false_node, "adds a false node to the circuit, and returns a pointer")
-.def("literal_node", &Circuit::literal_node, "adds a literal node to the circuit ,and returns a pointer")
-.def("or_node", &Circuit::or_node, "children"_a, "adds an or node to the circuit, and returns a pointer")
-.def("and_node", &Circuit::and_node, "children"_a, "adds an and node to the circuit, and returns a pointer")
-.def("set_root", &Circuit::set_root, "root"_a, "marks a node pointer as root")
+.def("nb_nodes", &Circuit::nb_nodes, "Number of nodes in the circuit.")
+.def("nb_root_nodes", &Circuit::nb_root_nodes, "Number of root nodes in the circuit.")
+.def("true_node", &Circuit::true_node, "Adds a true node to the circuit, and returns it as a pointer.")
+.def("false_node", &Circuit::false_node, "Adds a false node to the circuit, and returns it as a pointer.")
+.def("literal_node", &Circuit::literal_node, "Adds a literal node to the circuit, and returns it as a pointer.", "literal"_a)
+.def("or_node", &Circuit::or_node, "children"_a, "Adds an :code:`or` node to the circuit, and returns it as a pointer.")
+.def("and_node", &Circuit::and_node, "children"_a, "Adds an :code:`and` node to the circuit, and returns it as a pointer.")
+.def("set_root", &Circuit::set_root, "root"_a, "Marks a node pointer as root.")
 .def("remove_unused_nodes", &Circuit::remove_unused_nodes, "Removes unused non-root nodes from the circuit.\nCareful! This invalidates any NodePtr refering to an unused node (i.e., a node not conneected to a root node).");
 
 m.def("to_dot_file", &to_dot_file, "circuit"_a, "filename"_a, "Write the given circuit as dot format to a file");

src/klay/__init__.py

@@ -1,25 +1,42 @@
 # noinspection PyUnresolvedReferences
 from .nanobind_ext import Circuit
 
+from collections.abc import Sequence
 
-def to_torch_module(circuit: Circuit, semiring: str = "log"):
+
+def to_torch_module(self: Circuit, semiring: str = "log"):
+    """
+    Convert the circuit into a PyTorch module.
+
+    :param semiring:
+        The semiring in which the circuit should be evaluated. Supported options are ("log", "real", "mpe", "godel").
+    """
     from .backends import torch_backend
-    indices = circuit._get_indices()
+    indices = self._get_indices()
     return torch_backend.KnowledgeModule(*indices, semiring=semiring)
 
 
-def to_jax_function(circuit: Circuit, semiring: str = "log"):
+def to_jax_function(self: Circuit, semiring: str = "log"):
+    """
+    Convert the circuit into a Jax function.
+
+    :param semiring:
+        The semiring in which the circuit should be evaluated. Supported options are ("log", "real").
+    """
     from .backends import jax_backend
-    indices = circuit._get_indices()
+    indices = self._get_indices()
     return jax_backend.create_knowledge_layer(*indices, semiring=semiring)
 
 
-def add_sdd(circuit: Circuit, sdd: "SddNode", **kwargs):
+def add_sdd(self: Circuit, sdd: "SddNode", true_lits: Sequence[int] = (), false_lits: Sequence[int] = ()):
+    """
+    Add an SDD to the Circuit.
+    """
     import os
     from pathlib import Path
 
     sdd.save(bytes(Path("tmp.sdd")))
-    circuit.add_SDD_from_file("tmp.sdd", **kwargs)
+    self.add_SDD_from_file("tmp.sdd", true_lits, false_lits)
     os.remove("tmp.sdd")