GraphBuilder->Graph with separate Workflow type

docs/source/core_concepts.md

@@ -30,7 +30,7 @@ From the data dependencies, the runtime environment can infer which tasks it nee
 ### Types
 
 In Tierkreis, it is possible to associate types with edges (data) at construction.
-Type information can be used by the `GraphBuilder` to infer additional information about the graph to prevent runtime errors.
+Type information can be used while building the `Graph` to detect and prevent runtime errors.
 
 ## Execution model
 

docs/source/examples/data/typed_eval.py

@@ -1,6 +1,6 @@
 from typing import NamedTuple
 
-from tierkreis.builder import GraphBuilder
+from tierkreis.builder import Graph
 from tierkreis.builtins import iadd, itimes
 from tierkreis.controller.data.core import EmptyModel
 from tierkreis.controller.data.models import TKR
@@ -17,34 +17,30 @@ class DoublerOutput(NamedTuple):
 
 
 def typed_doubler():
-    g = GraphBuilder(TKR[int], TKR[int])
+    g = Graph(TKR[int], TKR[int])
     out = g.task(itimes(a=g.const(2), b=g.inputs))
-    g.outputs(out)
-    return g
+    return g.finish_with_outputs(out)
 
 
 def typed_doubler_plus_multi():
-    g = GraphBuilder(DoublerInput, DoublerOutput)
+    g = Graph(DoublerInput, DoublerOutput)
     mul = g.task(itimes(a=g.inputs.x, b=g.const(2)))
     out = g.task(iadd(a=mul, b=g.inputs.intercept))
-    g.outputs(DoublerOutput(a=g.inputs.x, value=out))
-    return g
+    return g.finish_with_outputs(DoublerOutput(a=g.inputs.x, value=out))
 
 
 def typed_doubler_plus():
-    g = GraphBuilder(DoublerInput, TKR[int])
+    g = Graph(DoublerInput, TKR[int])
     mul = g.task(itimes(a=g.inputs.x, b=g.const(2)))
     out = g.task(iadd(a=mul, b=g.inputs.intercept))
-    g.outputs(out)
-    return g
+    return g.finish_with_outputs(out)
 
 
 class TypedEvalOutputs(NamedTuple):
     typed_eval_output: TKR[int]
 
 
 def typed_eval():
-    g = GraphBuilder(EmptyModel, TypedEvalOutputs)
+    g = Graph(EmptyModel, TypedEvalOutputs)
     e = g.eval(typed_doubler_plus(), DoublerInput(x=g.const(6), intercept=g.const(0)))
-    g.outputs(TypedEvalOutputs(typed_eval_output=e))
-    return g
+    return g.finish_with_outputs(TypedEvalOutputs(typed_eval_output=e))

docs/source/examples/errors_and_debugging.ipynb

@@ -27,18 +27,17 @@
       "metadata": {},
       "outputs": [],
       "source": [
-        "from tierkreis.builder import GraphBuilder\n",
+        "from tierkreis.builder import Graph, Workflow\n",
         "from tierkreis.controller.data.core import EmptyModel\n",
         "from tierkreis.controller.data.models import TKR\n",
         "\n",
         "from error_worker import fail\n",
         "\n",
         "\n",
-        "def error_graph() -> GraphBuilder:\n",
-        "    g = GraphBuilder(EmptyModel, TKR[str])\n",
+        "def error_graph() -> Workflow:\n",
+        "    g = Graph(EmptyModel, TKR[str])\n",
         "    output = g.task(fail())\n",
-        "    g.outputs(output)\n",
-        "    return g"
+        "    return g.finish_with_outputs(output)"
       ]
     },
     {

docs/source/examples/hamiltonian.ipynb

@@ -69,7 +69,7 @@
       "metadata": {},
       "outputs": [],
       "source": [
-        "from tierkreis.builder import GraphBuilder\n",
+        "from tierkreis.builder import Graph\n",
         "from tierkreis.controller.data.models import TKR\n",
         "from typing import NamedTuple, Literal\n",
         "\n",
@@ -84,7 +84,7 @@
         "    ansatz: TKR[Literal[\"pytket._tket.circuit.Circuit\"]]\n",
         "\n",
         "\n",
-        "simulation_graph = GraphBuilder(SymbolicExecutionInputs, TKR[float])\n",
+        "simulation_graph = Graph(SymbolicExecutionInputs, TKR[float])\n",
         "substituted_circuit = simulation_graph.task(\n",
         "    substitute(\n",
         "        simulation_graph.inputs.ansatz,\n",
@@ -125,7 +125,7 @@
         "\n",
         "\n",
         "def exp_val():\n",
-        "    g = GraphBuilder(SubmitInputs, TKR[float])\n",
+        "    g = Graph(SubmitInputs, TKR[float])\n",
         "\n",
         "    circuit = g.inputs.circuit\n",
         "    pauli_string = g.inputs.pauli_string\n",
@@ -137,8 +137,7 @@
         "\n",
         "    backend_result = g.task(submit_single(compiled_circuit, n_shots))\n",
         "    av = g.task(expectation(backend_result))\n",
-        "    g.outputs(av)\n",
-        "    return g"
+        "    return g.finish_with_outputs(av)"
       ]
     },
     {
@@ -195,14 +194,13 @@
         "\n",
         "\n",
         "def compute_terms():\n",
-        "    g = GraphBuilder(ComputeTermsInputs, TKR[float])\n",
+        "    g = Graph(ComputeTermsInputs, TKR[float])\n",
         "\n",
         "    res_0, res_1 = g.task(untuple(g.inputs.value))\n",
         "    prod = g.task(times(res_0, res_1))\n",
         "    sum = g.task(add(g.inputs.accum, prod))\n",
         "\n",
-        "    g.outputs(sum)\n",
-        "    return g"
+        "    return g.finish_with_outputs(sum)"
       ]
     },
     {
@@ -243,7 +241,7 @@
       "outputs": [],
       "source": [
         "computed = simulation_graph.eval(fold_graph(compute_terms()), fold_inputs)\n",
-        "simulation_graph.outputs(computed)"
+        "workflow = simulation_graph.finish_with_outputs(computed)"
       ]
     },
     {
@@ -340,11 +338,11 @@
         "run_graph(\n",
         "    storage,\n",
         "    multi_executor,\n",
-        "    simulation_graph,\n",
+        "    workflow,\n",
         "    inputs,\n",
         "    polling_interval_seconds=0.2,\n",
         ")\n",
-        "output = read_outputs(simulation_graph, storage)\n",
+        "output = read_outputs(workflow, storage)\n",
         "print(output)"
       ]
     }

docs/source/examples/hello_world.py

@@ -1,10 +1,10 @@
-from tierkreis.builder import GraphBuilder
+from tierkreis.builder import Graph
 from tierkreis.controller.data.models import TKR
 
 from hello_world_worker import greet
 
 
-graph = GraphBuilder(inputs_type=TKR[str], outputs_type=TKR[str])
+graph = Graph(inputs_type=TKR[str], outputs_type=TKR[str])
 hello = graph.const("Hello ")
 output = graph.task(greet(greeting=hello, subject=graph.inputs))
-graph.outputs(output)
+graph.finish_with_outputs(output)

docs/source/examples/hello_world_graph.ipynb

@@ -29,7 +29,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from tierkreis.builder import GraphBuilder\n",
+    "from tierkreis.builder import Graph\n",
     "from tierkreis.controller.data.models import TKR"
    ]
   },
@@ -50,7 +50,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "graph = GraphBuilder(inputs_type=TKR[str], outputs_type=TKR[str])"
+    "graph = Graph(inputs_type=TKR[str], outputs_type=TKR[str])"
    ]
   },
   {
@@ -116,7 +116,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "graph.outputs(output)"
+    "workflow = graph.finish_with_outputs(output)"
    ]
   },
   {
@@ -148,7 +148,7 @@
     "\n",
     "def main(input_value: str) -> None:\n",
     "    run_workflow(\n",
-    "        graph.data,\n",
+    "        workflow,\n",
     "        {\"value\": input_value},\n",
     "        name=\"hello_world\",\n",
     "        run_id=100,  # Assign a fixed uuid for our workflow.\n",

docs/source/examples/hpc.ipynb

@@ -62,7 +62,7 @@
       "metadata": {},
       "outputs": [],
       "source": [
-        "from tierkreis.builder import GraphBuilder\n",
+        "from tierkreis.builder import Graph, Workflow\n",
         "from substitution_worker import substitute\n",
         "from tierkreis.pytket_worker import (\n",
         "    add_measure_all,\n",
@@ -72,9 +72,9 @@
         "from tierkreis.aer_worker import submit_single\n",
         "\n",
         "\n",
-        "def symbolic_execution() -> GraphBuilder:\n",
+        "def symbolic_execution() -> Workflow:\n",
         "    \"\"\"A graph that substitutes 3 parameters into a circuit and gets an expectation value.\"\"\"\n",
-        "    g = GraphBuilder(SymbolicCircuitsInputs, SymbolicCircuitsOutputs)\n",
+        "    g = Graph(SymbolicCircuitsInputs, SymbolicCircuitsOutputs)\n",
         "    a = g.inputs.a\n",
         "    b = g.inputs.b\n",
         "    c = g.inputs.c\n",
@@ -88,8 +88,7 @@
         "    backend_result = g.task(submit_single(circuit=compiled_circuit, n_shots=n_shots))\n",
         "    av = g.task(expectation(backend_result=backend_result))\n",
         "\n",
-        "    g.outputs(SymbolicCircuitsOutputs(expectation=av))\n",
-        "    return g"
+        "    return g.finish_with_outputs(SymbolicCircuitsOutputs(expectation=av))"
       ]
     },
     {

docs/source/examples/multiple_outputs.ipynb

@@ -56,17 +56,17 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from tierkreis.builder import GraphBuilder\n",
+    "from tierkreis.builder import Graph\n",
     "from tierkreis.controller.data.models import TKR\n",
     "from multiple_outputs_worker import new_opaque_point, OpaquePoint  # noqa: F811\n",
     "\n",
-    "g = GraphBuilder(TKR[float], TKR[OpaquePoint])\n",
+    "g = Graph(TKR[float], TKR[OpaquePoint])\n",
     "diag = g.task(new_opaque_point(g.inputs, g.inputs, g.inputs))\n",
     "\n",
     "# Uncommenting the following line will give an error.\n",
     "# diag.x ## Cannot access attribute \"x\" for class \"TKR[OpaquePoint]\"\n",
     "\n",
-    "g.outputs(diag)"
+    "workflow = g.finish_with_outputs(diag)"
    ]
   },
   {
@@ -92,8 +92,8 @@
     "\n",
     "storage = FileStorage(UUID(int=400), do_cleanup=True)\n",
     "executor = UvExecutor(Path().parent / \"example_workers\", storage.logs_path)\n",
-    "run_graph(storage, executor, g, 4)\n",
-    "outputs = read_outputs(g, storage)\n",
+    "run_graph(storage, executor, workflow, 4)\n",
+    "outputs = read_outputs(workflow, storage)\n",
     "assert outputs == {\"x\": 4, \"y\": 4, \"z\": 4}"
    ]
   },
@@ -144,15 +144,15 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from tierkreis.builder import GraphBuilder\n",
+    "from tierkreis.builder import Graph\n",
     "from tierkreis.controller.data.models import TKR\n",
     "from tierkreis.builtins.stubs import add\n",
     "from multiple_outputs_worker import new_point  # noqa: F811\n",
     "\n",
-    "g = GraphBuilder(TKR[float], TKR[float])\n",
+    "g = Graph(TKR[float], TKR[float])\n",
     "diag = g.task(new_point(g.inputs, g.inputs, g.inputs))\n",
     "sum = g.task(add(diag.x, g.task(add(diag.y, diag.z))))\n",
-    "g.outputs(sum)"
+    "workflow = g.finish_with_outputs(sum)"
    ]
   },
   {
@@ -178,8 +178,8 @@
     "\n",
     "storage = FileStorage(UUID(int=400), do_cleanup=True)\n",
     "executor = UvExecutor(Path().parent / \"example_workers\", storage.logs_path)\n",
-    "run_graph(storage, executor, g, 4)\n",
-    "outputs = read_outputs(g, storage)\n",
+    "run_graph(storage, executor, workflow, 4)\n",
+    "outputs = read_outputs(workflow, storage)\n",
     "assert outputs == 12"
    ]
   }