compiled-knowledge 4.0.0a23__tar.gz → 4.0.0a25__tar.gz

{compiled_knowledge-4.0.0a23/src/compiled_knowledge.egg-info → compiled_knowledge-4.0.0a25}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: compiled-knowledge
-Version: 4.0.0a23
+Version: 4.0.0a25
 Summary: A Python package for compiling and querying discrete probabilistic graphical models.
 Author-email: Barry Drake <barry@compiledknowledge.org>
 License-Expression: MIT

{compiled_knowledge-4.0.0a23 → compiled_knowledge-4.0.0a25}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "compiled-knowledge"
-version = "4.0.0a23"
+version = "4.0.0a25"
 description = "A Python package for compiling and querying discrete probabilistic graphical models."
 readme = "README.md"
 license = "MIT"
@@ -36,6 +36,7 @@ setuptools = "*"
 build = "*"
 cibuildwheel = "*"
 jupyter-book = "*"
+sphinx = "*"
 twine = "*"
 toml = "*"
 

{compiled_knowledge-4.0.0a23 → compiled_knowledge-4.0.0a25}/src/ck/circuit/tmp_const.py

@@ -10,15 +10,16 @@ class TmpConst:
     A TmpConst enables the consistent, temporary setting and clearing
     of circuit variables to constant values.
 
-    Example usage:
+    Example usage::
+
         with TmpConst(my_circuit) as tmp:
             tmp.set_const(0, 123.456)
             tmp.set_const(my_list_of_vars, 110.99)
             program = Program(my_top)
-        # now use 'program'
+        # now use `program`
 
-    Within the 'with' section, circuit variables are set to const values, which
-    the compiler can optimise. When the 'with' section exits, the variables
+    Within the `with` section, circuit variables are set to const values, which
+    the compiler can optimise. When the `with` section exits, the variables
     are restored to their original state.
     """
     __slots__ = ('_circuit', '_undo')

{compiled_knowledge-4.0.0a23 → compiled_knowledge-4.0.0a25}/src/ck/circuit_compiler/circuit_compiler.py

@@ -13,12 +13,13 @@ class CircuitCompiler(Protocol):
             circuit: Optional[Circuit] = None,
     ) -> RawProgram:
         """
-        A circuit compiler is a function with this signature.
+        A PGM compiler compiles selected results nodes of an arithmetic circuit to a program.
 
         Args:
             *result: one or more circuit of nodes defining the result of the program function.
                 All result node must be from the same circuit.
-            input_vars: how to determine the input variables. Default is to use all circuit variables, in index order.
+            input_vars: how to determine the input variables. Either a sequence of VarNodes, or a single
+                VarNode, or a `InferVars` member. The default is to use all circuit variables, in index order.
             circuit: optionally explicitly specify the Circuit (mandatory if no result nodes are provided).
 
         Returns:

{compiled_knowledge-4.0.0a23 → compiled_knowledge-4.0.0a25}/src/ck/circuit_compiler/support/llvm_ir_function.py

@@ -213,10 +213,10 @@ def compile_llvm_program(
     Compile the given LLVM program.
 
     Returns:
-        (engine, function) where
-        engine: is an LLVM execution engine, which must remain
-            in memory for the returned function to be valid.
-        function: is the raw Python callable for the compiled function.
+        `engine` an LLVM execution engine, which must remain
+        in memory for the returned function to be valid,
+
+        `function` the raw Python callable for the compiled function.
     """
     _init_llvm()
 

{compiled_knowledge-4.0.0a23 → compiled_knowledge-4.0.0a25}/src/ck/example/diamond_square.py

@@ -8,7 +8,8 @@ class DiamondSquare(PGM):
     This PGM is the 'DiamondSquare' factor graph.
 
     The DiamondSquare is a factor graph with seven random variables (a, b, c, ..., h).
-    Binary factors are between pairs of random variables creating the pattern:
+    Binary factors are between pairs of random variables creating the pattern::
+
                      b
                     / \
                    /   \
@@ -20,6 +21,7 @@ class DiamondSquare(PGM):
                   \   /
                    \ /
                     g
+
     If include_unaries then, also includes one unary factor per random variable.
     """
 

{compiled_knowledge-4.0.0a23 → compiled_knowledge-4.0.0a25}/src/ck/example/triangle_square.py

@@ -8,12 +8,14 @@ class TriangleSquare(PGM):
     This PGM is the 'TriangleSquare' factor graph.
 
     The TriangleSquare is a factor graph with six random variables (a, b, c, ..., f).
-    Binary factors are between pairs of random variables crating the pattern:
+    Binary factors are between pairs of random variables crating the pattern::
+
                   b -- d
                 / |    | \
                a  |    |  f
                 \ |    | /
                   c -- e
+
     If include_unaries then, also includes one unary factor per random variable.
     """
 

{compiled_knowledge-4.0.0a23 → compiled_knowledge-4.0.0a25}/src/ck/example/truss.py

@@ -7,12 +7,14 @@ class Truss(PGM):
     This PGM is the 'Truss' factor graph.
 
     The Truss is a factor graph with five random variables (a, b, c, d, e).
-    Binary factors are between pairs of random variables creating the pattern:
+    Binary factors are between pairs of random variables creating the pattern::
+
                   b ---- d
                 / |    / |
                a  |  /   |
                 \ | /    |
                   c ---- e
+
     If include_unaries then, also includes one unary factor per random variable.
     """
 

{compiled_knowledge-4.0.0a23 → compiled_knowledge-4.0.0a25}/src/ck/in_out/parse_net.py

@@ -16,36 +16,37 @@ def read_network(input_stream, *, name: Optional[str] = None, network_builder: O
     The input can be a string or a stream.
     If the input is empty, then its is treated as an error.
 
-    This input is expected to conform to the following format.
+    This input is expected to conform to the following format::
 
-    <network> ::= <net_block> <node_block>* <potential_block>*
+        <network> ::= <net_block> <node_block>* <potential_block>*
 
-    <net_block> ::= 'net' <block>
+        <net_block> ::= 'net' <block>
 
-    <node_block> ::= 'node' <NAME> <block>
+        <node_block> ::= 'node' <NAME> <block>
 
-    <potential_block> ::= 'potential' <link> <block>
+        <potential_block> ::= 'potential' <link> <block>
 
-    <block> ::= '{' <sentence>* '}'
-    <sentence> ::= <NAME> '=' <value> ';'
+        <block> ::= '{' <sentence>* '}'
+        <sentence> ::= <NAME> '=' <value> ';'
 
-    <link> ::= '(' <NAME> ')'
-             | '(' <NAME> '|' <NAME>+ ')'
+        <link> ::= '(' <NAME> ')'
+                 | '(' <NAME> '|' <NAME>+ ')'
 
-    <value> ::= <STRING> | <NUMBER> | <list>
-    <list> ::='(' <value>* ')'
+        <value> ::= <STRING> | <NUMBER> | <list>
+        <list> ::='(' <value>* ')'
 
     The sentences of a <net_block> are ignored.
 
-    The sentences of a <node_block>
-        <name> of 'states' mandatory, with value that is a list of <STRING>
-        other sentences are ignored.
+    In a <node_block>,
+    <name> of 'states' mandatory, with value that is a list of <STRING>
+    other sentences are ignored.
 
-    The sentences of a <potential_block>
-        <name> of 'data' mandatory, with value that is a list of (list of)* <NUMBER> (shape matching the link)
-        other sentences are ignored.
+    In a <potential_block>,
+    <name> of 'data' is mandatory, with value that is a list of (list of) <NUMBER> (shape matching the link)
+    other sentences are ignored.
+
+    Here is a simple example input::
 
-    Here is a simple example input:
         net{}
         node a
         {
@@ -62,8 +63,9 @@ def read_network(input_stream, *, name: Optional[str] = None, network_builder: O
         }
         potential ( b | a )
         {
-          data = ((0.4 0.4 0.2)(0.4 0.4 0.2)) ;
+          data = ((0.4 0.4 0.2)(0.4 0.4 0.2));
         }
+
     """
     # Decorate the input stream
     input_stream = ParserInput(input_stream)

{compiled_knowledge-4.0.0a23 → compiled_knowledge-4.0.0a25}/src/ck/in_out/parser_utils.py

@@ -57,8 +57,10 @@ class ParserInput:
 
     def readline(self) -> str:
         """
+        Read a line of input.
+
         Returns:
-             the next line (including the trailing '\n') or '' if EOF.
+             the next line (including the trailing newline) or empty string if EOF.
         """
         line = ''
         while True:
@@ -69,9 +71,11 @@ class ParserInput:
 
     def read_past_space(self, single_line: bool, comment_char=None) -> str:
         """
+        Read the input up to and including the first non-whitespace character.
+
         Returns:
-            either empty string, '', if end of input, otherwise a single character string that is not whitespace.
-            If single_line is True, then '\n' is treated as eof.
+            either empty string, if end of input, otherwise a single character string that is not whitespace.
+            If single_line is True, then newline is treated as eof.
         """
         c = self.read_one()
         while True: