Merge pull request #137 from djarecka/tutorial_keywords

removing splitter and combiner kwargs  in tutorial

Author: djarecka

tutorial/notebooks/intro_task_state.ipynb

@@ -62,7 +62,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "task1.split(splitter=\"x\")"
+    "task1.split(\"x\")"
    ]
   },
   {
@@ -153,6 +153,25 @@
     "![nd_spl_1.png](attachment:nd_spl_1.png)"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Note, that you can set the`splitter` only once, if you try to use `split` method again, you will get an error:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "try:\n",
+    "    task1.split(\"x\")\n",
+    "except(Exception) as err:\n",
+    "    print(f\"Exception: {err}\")"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -186,7 +205,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "task2 = add_var(a=[1, 2, 3], b=10).split(splitter=\"a\")\n",
+    "task2 = add_var(a=[1, 2, 3], b=10).split(\"a\")\n",
     "task2()\n",
     "task2.result()"
    ]
@@ -250,7 +269,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "task3.split(splitter=(\"a\", \"b\"))\n",
+    "task3.split((\"a\", \"b\"))\n",
     "task3()\n",
     "task3.result()"
    ]
@@ -292,7 +311,7 @@
    "outputs": [],
    "source": [
     "task4 = add_var(a=[1, 2], b=[10, 100])\n",
-    "task4.split(splitter=[\"a\", \"b\"])\n",
+    "task4.split([\"a\", \"b\"])\n",
     "task4()\n",
     "task4.result()"
    ]
@@ -367,9 +386,9 @@
    "outputs": [],
    "source": [
     "task5 = add_var(a=[1, 2], b=[10, 100])\n",
-    "task5.split(splitter=[\"a\", \"b\"])\n",
+    "task5.split([\"a\", \"b\"])\n",
     "# adding combiner\n",
-    "task5.combine(combiner=\"b\")\n",
+    "task5.combine(\"b\")\n",
     "task5()\n",
     "task5.result()"
    ]
@@ -407,9 +426,9 @@
    "outputs": [],
    "source": [
     "task6 = add_var(a=[1, 2], b=[10, 100])\n",
-    "task6.split(splitter=[\"a\", \"b\"])\n",
+    "task6.split([\"a\", \"b\"])\n",
     "# changing the combiner\n",
-    "task6.combine(combiner=\"a\")\n",
+    "task6.combine(\"a\")\n",
     "task6()\n",
     "task6.result()"
    ]
@@ -447,9 +466,9 @@
    "outputs": [],
    "source": [
     "task7 = add_var(a=[1, 2], b=[10, 100])\n",
-    "task7.split(splitter=[\"a\", \"b\"])\n",
+    "task7.split([\"a\", \"b\"])\n",
     "# combining all inputs\n",
-    "task7.combine(combiner=[\"a\", \"b\"])\n",
+    "task7.combine([\"a\", \"b\"])\n",
     "task7()\n",
     "task7.result()"
    ]
@@ -524,7 +543,7 @@
    },
    "outputs": [],
    "source": [
-    "task_ex1 = power(x=[2, 3, 4, 5], n=[2, 3]).split(splitter=[\"x\", \"n\"]).combine(\"x\")\n",
+    "task_ex1 = power(x=[2, 3, 4, 5], n=[2, 3]).split([\"x\", \"n\"]).combine(\"x\")\n",
     "task_ex1(plugin=\"cf\")\n",
     "task_ex1.result()"
    ]
@@ -575,7 +594,7 @@
     "    time.sleep(1)\n",
     "    return x + 2\n",
     "\n",
-    "task8 = add_two_sleep(x=[1, 2, 3, 4]).split(splitter=\"x\")\n",
+    "task8 = add_two_sleep(x=[1, 2, 3, 4]).split(\"x\")\n",
     "t0 = time.time()\n",
     "task8()\n",
     "print(f'total time: {time.time() - t0}')\n",
@@ -599,7 +618,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "task9 = add_two_sleep(x=[1, 2, 3, 4]).split(splitter=\"x\")\n",
+    "task9 = add_two_sleep(x=[1, 2, 3, 4]).split(\"x\")\n",
     "\n",
     "t0 = time.time()\n",
     "with pydra.Submitter(plugin=\"cf\") as sub:\n",
@@ -621,7 +640,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "task10 = add_two_sleep(x=[1, 2, 3, 4]).split(splitter=\"x\")\n",
+    "task10 = add_two_sleep(x=[1, 2, 3, 4]).split(\"x\")\n",
     "\n",
     "t0 = time.time()\n",
     "task10(plugin=\"cf\")\n",
@@ -642,7 +661,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "task11 = add_two_sleep(x=[1, 2, 3, 4]).split(splitter=\"x\")\n",
+    "task11 = add_two_sleep(x=[1, 2, 3, 4]).split(\"x\")\n",
     "\n",
     "t0 = time.time()\n",
     "with pydra.Submitter(plugin=\"cf\") as sub:\n",
@@ -664,7 +683,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "task12 = add_two_sleep(x=[1, 2, 3, 4]).split(splitter=\"x\")\n",
+    "task12 = add_two_sleep(x=[1, 2, 3, 4]).split(\"x\")\n",
     "\n",
     "t0 = time.time()\n",
     "with pydra.Submitter(plugin=\"cf\", n_procs=2) as sub:\n",
@@ -680,13 +699,6 @@
     "Now, the total time could be significantly different. For example, if your machine has at least 4 processors, the previous `tasks8` - `task11` took around 1s to run, but the task12 took around 2s.\n",
     "If you have 2 processors or less, you should not see any difference in the execution time."
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {

tutorial/notebooks/intro_workflow.ipynb

@@ -373,7 +373,7 @@
    "source": [
     "wf6 = pydra.Workflow(name=\"wf6\", input_spec=[\"x\"])\n",
     "# setting a plitter for the entire workflow\n",
-    "wf6.split(splitter=\"x\", x=[3, 5])\n",
+    "wf6.split(\"x\", x=[3, 5])\n",
     "wf6.add(add_two(name=\"add_two\", x=wf6.lzin.x))\n",
     "wf6.add(power(name=\"power\", a=wf6.lzin.x))\n",
     "wf6.add(mult_var(name=\"mult\", a=wf6.add_two.lzout.out, b=wf6.power.lzout.out))\n",
@@ -421,7 +421,7 @@
    "outputs": [],
    "source": [
     "wf7 = pydra.Workflow(name=\"wf7\", input_spec=[\"x\", \"y\"])\n",
-    "wf7.split(splitter=[\"x\", \"y\"], x=[3, 5], y=[2, 3])\n",
+    "wf7.split([\"x\", \"y\"], x=[3, 5], y=[2, 3])\n",
     "wf7.add(add_two(name=\"sum\", x=wf7.lzin.x))\n",
     "wf7.add(power(name=\"power\", a=wf7.lzin.y))\n",
     "wf7.add(mult_var(name=\"mult\", a=wf7.sum.lzout.out, b=wf7.power.lzout.out))\n",
@@ -468,7 +468,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "wf7.combine(combiner=\"x\")\n",
+    "wf7.combine(\"x\")\n",
     "\n",
     "with pydra.Submitter(plugin=\"cf\") as sub:\n",
     "    sub(wf7)\n",
@@ -519,7 +519,7 @@
     "wf8 = pydra.Workflow(name=\"wf8\", input_spec=[\"x\"], x=[3, 5, 7])\n",
     "wf8.add(mean(name=\"mean\", x_list=wf8.lzin.x))\n",
     "# adding a task that has its own splitter\n",
-    "wf8.add(power(name=\"power\", a=wf8.lzin.x).split(splitter=\"a\"))\n",
+    "wf8.add(power(name=\"power\", a=wf8.lzin.x).split(\"a\"))\n",
     "\n",
     "wf8.set_output([(\"out_m\", wf8.mean.lzout.out),\n",
     "                (\"out_p\", wf8.power.lzout.out)])\n",
@@ -548,13 +548,6 @@
    "source": [
     "![wf_9.png](attachment:wf_9.png)"
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {