From a2261af98c4a9e2751597111c6a502fd46a49201 Mon Sep 17 00:00:00 2001 From: Sam Watts Date: Tue, 17 Jan 2023 15:45:52 +0100 Subject: [PATCH 1/3] add parameter_names to current docs --- docs/api/current.ipynb | 48 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 47 insertions(+), 1 deletion(-) diff --git a/docs/api/current.ipynb b/docs/api/current.ipynb index 02f9104d..f7401912 100644 --- a/docs/api/current.ipynb +++ b/docs/api/current.ipynb @@ -20,7 +20,7 @@ }, { "cell_type": "code", - "execution_count": 1, + "execution_count": 24, "id": "d4c02781", "metadata": { "execution": { @@ -66,6 +66,19 @@ " pass\n", " def extend(self):\n", " pass\n", + " \n", + " # TODO: move this doc to an appropriate place, maybe task.py?\n", + " @property\n", + " def parameter_names(self):\n", + " \"\"\"\n", + " The names of the Parameters defined in the current flow.\n", + "\n", + " Returns\n", + " -------\n", + " List[str]\n", + " Parameter names.\n", + " \"\"\"\n", + " pass\n", "\n", " # TODO: Move these docs to project_decorator.py\n", " @property\n", @@ -557,6 +570,39 @@ "ShowDoc(current.username)" ] }, + { + "cell_type": "code", + "execution_count": 25, + "id": "d7b320dd", + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "\n", + "

property current.parameter_names

The names of the Parameters defined in the current flow.

Returns
-------
List[str]
    Parameter names.

\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "\n", + "" + ], + "text/plain": [ + "" + ] + }, + "execution_count": 25, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "ShowDoc(current.parameter_names)" + ] + }, { "cell_type": "markdown", "id": "12733ec9", From 9f3baeea8cb5fb5f3ca4ef2736da1afa765586c9 Mon Sep 17 00:00:00 2001 From: Sam Watts Date: Tue, 17 Jan 2023 15:56:16 +0100 Subject: [PATCH 2/3] update and build to md --- docs/api/current.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/api/current.md b/docs/api/current.md index 7d3f210a..54f77bd0 100644 --- a/docs/api/current.md +++ b/docs/api/current.md @@ -110,6 +110,16 @@ These attributes are always available in the `current` object. + + + + + + + + + + ## Decorator-specific attributes These attributes are only available when the decorator is present. From 24ab3f2487fe24b5d0d69e8fdb117f15ed5dc5c9 Mon Sep 17 00:00:00 2001 From: Sam Watts Date: Tue, 17 Jan 2023 15:59:16 +0100 Subject: [PATCH 3/3] remove word --- docs/api/current.ipynb | 263 +++++++++++++++++++++-------------------- docs/api/current.md | 2 +- 2 files changed, 136 insertions(+), 129 deletions(-) diff --git a/docs/api/current.ipynb b/docs/api/current.ipynb index f7401912..65998bf5 100644 --- a/docs/api/current.ipynb +++ b/docs/api/current.ipynb @@ -20,14 +20,14 @@ }, { "cell_type": "code", - "execution_count": 24, + "execution_count": 1, "id": "d4c02781", "metadata": { "execution": { - "iopub.execute_input": "2022-07-23T21:47:14.300870Z", - "iopub.status.busy": "2022-07-23T21:47:14.298481Z", - "iopub.status.idle": "2022-07-23T21:47:15.030724Z", - "shell.execute_reply": "2022-07-23T21:47:15.031601Z" + "iopub.execute_input": "2023-01-17T14:58:35.186859Z", + "iopub.status.busy": "2023-01-17T14:58:35.186515Z", + "iopub.status.idle": "2023-01-17T14:58:37.824263Z", + "shell.execute_reply": "2023-01-17T14:58:37.823521Z" } }, "outputs": [], @@ -71,7 +71,7 @@ " @property\n", " def parameter_names(self):\n", " \"\"\"\n", - " The names of the Parameters defined in the current flow.\n", + " The names of the Parameters defined in the flow.\n", "\n", " Returns\n", " -------\n", @@ -176,10 +176,10 @@ "id": "7fdb7184", "metadata": { "execution": { - "iopub.execute_input": "2022-07-23T21:47:15.037672Z", - "iopub.status.busy": "2022-07-23T21:47:15.036144Z", - "iopub.status.idle": "2022-07-23T21:47:15.044700Z", - "shell.execute_reply": "2022-07-23T21:47:15.045561Z" + "iopub.execute_input": "2023-01-17T14:58:37.831200Z", + "iopub.status.busy": "2023-01-17T14:58:37.830800Z", + "iopub.status.idle": "2023-01-17T14:58:37.855834Z", + "shell.execute_reply": "2023-01-17T14:58:37.855035Z" } }, "outputs": [ @@ -198,7 +198,7 @@ "" ], "text/plain": [ - "" + "" ] }, "execution_count": 2, @@ -216,10 +216,10 @@ "id": "fa61bd9b", "metadata": { "execution": { - "iopub.execute_input": "2022-07-23T21:47:15.051426Z", - "iopub.status.busy": "2022-07-23T21:47:15.050098Z", - "iopub.status.idle": "2022-07-23T21:47:15.055614Z", - "shell.execute_reply": "2022-07-23T21:47:15.054028Z" + "iopub.execute_input": "2023-01-17T14:58:37.862844Z", + "iopub.status.busy": "2023-01-17T14:58:37.862533Z", + "iopub.status.idle": "2023-01-17T14:58:37.867983Z", + "shell.execute_reply": "2023-01-17T14:58:37.867026Z" } }, "outputs": [ @@ -238,7 +238,7 @@ "" ], "text/plain": [ - "" + "" ] }, "execution_count": 3, @@ -256,10 +256,10 @@ "id": "16a90815", "metadata": { "execution": { - "iopub.execute_input": "2022-07-23T21:47:15.062339Z", - "iopub.status.busy": "2022-07-23T21:47:15.060545Z", - "iopub.status.idle": "2022-07-23T21:47:15.066178Z", - "shell.execute_reply": "2022-07-23T21:47:15.065246Z" + "iopub.execute_input": "2023-01-17T14:58:37.875610Z", + "iopub.status.busy": "2023-01-17T14:58:37.875290Z", + "iopub.status.idle": "2023-01-17T14:58:37.880727Z", + "shell.execute_reply": "2023-01-17T14:58:37.879768Z" } }, "outputs": [ @@ -278,7 +278,7 @@ "" ], "text/plain": [ - "" + "" ] }, "execution_count": 4, @@ -296,10 +296,10 @@ "id": "f278667f", "metadata": { "execution": { - "iopub.execute_input": "2022-07-23T21:47:15.072011Z", - "iopub.status.busy": "2022-07-23T21:47:15.070608Z", - "iopub.status.idle": "2022-07-23T21:47:15.075673Z", - "shell.execute_reply": "2022-07-23T21:47:15.074797Z" + "iopub.execute_input": "2023-01-17T14:58:37.887747Z", + "iopub.status.busy": "2023-01-17T14:58:37.887453Z", + "iopub.status.idle": "2023-01-17T14:58:37.891981Z", + "shell.execute_reply": "2023-01-17T14:58:37.891376Z" } }, "outputs": [ @@ -318,7 +318,7 @@ "" ], "text/plain": [ - "" + "" ] }, "execution_count": 5, @@ -336,10 +336,10 @@ "id": "f4be98ad", "metadata": { "execution": { - "iopub.execute_input": "2022-07-23T21:47:15.081136Z", - "iopub.status.busy": "2022-07-23T21:47:15.080058Z", - "iopub.status.idle": "2022-07-23T21:47:15.083743Z", - "shell.execute_reply": "2022-07-23T21:47:15.084583Z" + "iopub.execute_input": "2023-01-17T14:58:37.898783Z", + "iopub.status.busy": "2023-01-17T14:58:37.898277Z", + "iopub.status.idle": "2023-01-17T14:58:37.903614Z", + "shell.execute_reply": "2023-01-17T14:58:37.902578Z" } }, "outputs": [ @@ -358,7 +358,7 @@ "" ], "text/plain": [ - "" + "" ] }, "execution_count": 6, @@ -376,10 +376,10 @@ "id": "a97ad305", "metadata": { "execution": { - "iopub.execute_input": "2022-07-23T21:47:15.090674Z", - "iopub.status.busy": "2022-07-23T21:47:15.089335Z", - "iopub.status.idle": "2022-07-23T21:47:15.095744Z", - "shell.execute_reply": "2022-07-23T21:47:15.094713Z" + "iopub.execute_input": "2023-01-17T14:58:37.913563Z", + "iopub.status.busy": "2023-01-17T14:58:37.913008Z", + "iopub.status.idle": "2023-01-17T14:58:37.918576Z", + "shell.execute_reply": "2023-01-17T14:58:37.917662Z" } }, "outputs": [ @@ -387,18 +387,18 @@ "data": { "text/html": [ "\n", - "

property current.retry_count

The index of the task exeuction attempt.

This property returns 0 for the first attempt to execute the task.
If the @retry decorator is used and the first attempt fails, this
property returns the number of times the task was attempted prior
to the current attempt.

Returns
-------
int
    The retry count.

\n", + "

property current.retry_count

The index of the task execution attempt.

This property returns 0 for the first attempt to execute the task.
If the @retry decorator is used and the first attempt fails, this
property returns the number of times the task was attempted prior
to the current attempt.

Returns
-------
int
    The retry count.

\n", "\n", "\n", "\n", - "\n", + "\n", "\n", "\n", "\n", "" ], "text/plain": [ - "" + "" ] }, "execution_count": 7, @@ -416,10 +416,10 @@ "id": "b73e163c", "metadata": { "execution": { - "iopub.execute_input": "2022-07-23T21:47:15.102434Z", - "iopub.status.busy": "2022-07-23T21:47:15.100166Z", - "iopub.status.idle": "2022-07-23T21:47:15.106241Z", - "shell.execute_reply": "2022-07-23T21:47:15.105068Z" + "iopub.execute_input": "2023-01-17T14:58:37.927445Z", + "iopub.status.busy": "2023-01-17T14:58:37.927095Z", + "iopub.status.idle": "2023-01-17T14:58:37.933463Z", + "shell.execute_reply": "2023-01-17T14:58:37.932646Z" } }, "outputs": [ @@ -438,7 +438,7 @@ "" ], "text/plain": [ - "" + "" ] }, "execution_count": 8, @@ -456,10 +456,10 @@ "id": "16dd0a74", "metadata": { "execution": { - "iopub.execute_input": "2022-07-23T21:47:15.112362Z", - "iopub.status.busy": "2022-07-23T21:47:15.110660Z", - "iopub.status.idle": "2022-07-23T21:47:15.116832Z", - "shell.execute_reply": "2022-07-23T21:47:15.115714Z" + "iopub.execute_input": "2023-01-17T14:58:37.941155Z", + "iopub.status.busy": "2023-01-17T14:58:37.940414Z", + "iopub.status.idle": "2023-01-17T14:58:37.945777Z", + "shell.execute_reply": "2023-01-17T14:58:37.944984Z" } }, "outputs": [ @@ -478,7 +478,7 @@ "" ], "text/plain": [ - "" + "" ] }, "execution_count": 9, @@ -496,10 +496,10 @@ "id": "8f758f03", "metadata": { "execution": { - "iopub.execute_input": "2022-07-23T21:47:15.122853Z", - "iopub.status.busy": "2022-07-23T21:47:15.121495Z", - "iopub.status.idle": "2022-07-23T21:47:15.126437Z", - "shell.execute_reply": "2022-07-23T21:47:15.125469Z" + "iopub.execute_input": "2023-01-17T14:58:37.956046Z", + "iopub.status.busy": "2023-01-17T14:58:37.954882Z", + "iopub.status.idle": "2023-01-17T14:58:37.966475Z", + "shell.execute_reply": "2023-01-17T14:58:37.964318Z" } }, "outputs": [ @@ -518,7 +518,7 @@ "" ], "text/plain": [ - "" + "" ] }, "execution_count": 10, @@ -536,10 +536,10 @@ "id": "feaa6830", "metadata": { "execution": { - "iopub.execute_input": "2022-07-23T21:47:15.132123Z", - "iopub.status.busy": "2022-07-23T21:47:15.130900Z", - "iopub.status.idle": "2022-07-23T21:47:15.136152Z", - "shell.execute_reply": "2022-07-23T21:47:15.134956Z" + "iopub.execute_input": "2023-01-17T14:58:37.974436Z", + "iopub.status.busy": "2023-01-17T14:58:37.974052Z", + "iopub.status.idle": "2023-01-17T14:58:37.980825Z", + "shell.execute_reply": "2023-01-17T14:58:37.979118Z" } }, "outputs": [ @@ -558,7 +558,7 @@ "" ], "text/plain": [ - "" + "" ] }, "execution_count": 11, @@ -572,29 +572,36 @@ }, { "cell_type": "code", - "execution_count": 25, + "execution_count": 12, "id": "d7b320dd", - "metadata": {}, + "metadata": { + "execution": { + "iopub.execute_input": "2023-01-17T14:58:37.988343Z", + "iopub.status.busy": "2023-01-17T14:58:37.987998Z", + "iopub.status.idle": "2023-01-17T14:58:37.993120Z", + "shell.execute_reply": "2023-01-17T14:58:37.992377Z" + } + }, "outputs": [ { "data": { "text/html": [ "\n", - "

property current.parameter_names

The names of the Parameters defined in the current flow.

Returns
-------
List[str]
    Parameter names.

\n", + "

property current.parameter_names

The names of the Parameters defined in the flow.

Returns
-------
List[str]
    Parameter names.

\n", "\n", "\n", "\n", - "\n", + "\n", "\n", "\n", "\n", "" ], "text/plain": [ - "" + "" ] }, - "execution_count": 25, + "execution_count": 12, "metadata": {}, "output_type": "execute_result" } @@ -625,14 +632,14 @@ }, { "cell_type": "code", - "execution_count": 12, + "execution_count": 13, "id": "437b253d", "metadata": { "execution": { - "iopub.execute_input": "2022-07-23T21:47:15.141588Z", - "iopub.status.busy": "2022-07-23T21:47:15.140514Z", - "iopub.status.idle": "2022-07-23T21:47:15.144568Z", - "shell.execute_reply": "2022-07-23T21:47:15.145624Z" + "iopub.execute_input": "2023-01-17T14:58:38.002210Z", + "iopub.status.busy": "2023-01-17T14:58:38.001825Z", + "iopub.status.idle": "2023-01-17T14:58:38.009106Z", + "shell.execute_reply": "2023-01-17T14:58:38.007559Z" } }, "outputs": [ @@ -651,10 +658,10 @@ "" ], "text/plain": [ - "" + "" ] }, - "execution_count": 12, + "execution_count": 13, "metadata": {}, "output_type": "execute_result" } @@ -665,14 +672,14 @@ }, { "cell_type": "code", - "execution_count": 13, + "execution_count": 14, "id": "fe5e9e0a", "metadata": { "execution": { - "iopub.execute_input": "2022-07-23T21:47:15.152143Z", - "iopub.status.busy": "2022-07-23T21:47:15.150619Z", - "iopub.status.idle": "2022-07-23T21:47:15.156329Z", - "shell.execute_reply": "2022-07-23T21:47:15.154706Z" + "iopub.execute_input": "2023-01-17T14:58:38.017607Z", + "iopub.status.busy": "2023-01-17T14:58:38.016823Z", + "iopub.status.idle": "2023-01-17T14:58:38.024153Z", + "shell.execute_reply": "2023-01-17T14:58:38.023156Z" } }, "outputs": [ @@ -691,10 +698,10 @@ "" ], "text/plain": [ - "" + "" ] }, - "execution_count": 13, + "execution_count": 14, "metadata": {}, "output_type": "execute_result" } @@ -705,14 +712,14 @@ }, { "cell_type": "code", - "execution_count": 14, + "execution_count": 15, "id": "1097fb92", "metadata": { "execution": { - "iopub.execute_input": "2022-07-23T21:47:15.162060Z", - "iopub.status.busy": "2022-07-23T21:47:15.160943Z", - "iopub.status.idle": "2022-07-23T21:47:15.165662Z", - "shell.execute_reply": "2022-07-23T21:47:15.164766Z" + "iopub.execute_input": "2023-01-17T14:58:38.033300Z", + "iopub.status.busy": "2023-01-17T14:58:38.032944Z", + "iopub.status.idle": "2023-01-17T14:58:38.038079Z", + "shell.execute_reply": "2023-01-17T14:58:38.037367Z" } }, "outputs": [ @@ -731,10 +738,10 @@ "" ], "text/plain": [ - "" + "" ] }, - "execution_count": 14, + "execution_count": 15, "metadata": {}, "output_type": "execute_result" } @@ -745,14 +752,14 @@ }, { "cell_type": "code", - "execution_count": 15, + "execution_count": 16, "id": "836d028b", "metadata": { "execution": { - "iopub.execute_input": "2022-07-23T21:47:15.171591Z", - "iopub.status.busy": "2022-07-23T21:47:15.170490Z", - "iopub.status.idle": "2022-07-23T21:47:15.175622Z", - "shell.execute_reply": "2022-07-23T21:47:15.174397Z" + "iopub.execute_input": "2023-01-17T14:58:38.064827Z", + "iopub.status.busy": "2023-01-17T14:58:38.064428Z", + "iopub.status.idle": "2023-01-17T14:58:38.074322Z", + "shell.execute_reply": "2023-01-17T14:58:38.072386Z" } }, "outputs": [ @@ -771,10 +778,10 @@ "" ], "text/plain": [ - "" + "" ] }, - "execution_count": 15, + "execution_count": 16, "metadata": {}, "output_type": "execute_result" } @@ -785,14 +792,14 @@ }, { "cell_type": "code", - "execution_count": 16, + "execution_count": 17, "id": "96348e52", "metadata": { "execution": { - "iopub.execute_input": "2022-07-23T21:47:15.181192Z", - "iopub.status.busy": "2022-07-23T21:47:15.180121Z", - "iopub.status.idle": "2022-07-23T21:47:15.184133Z", - "shell.execute_reply": "2022-07-23T21:47:15.185183Z" + "iopub.execute_input": "2023-01-17T14:58:38.084647Z", + "iopub.status.busy": "2023-01-17T14:58:38.084301Z", + "iopub.status.idle": "2023-01-17T14:58:38.089605Z", + "shell.execute_reply": "2023-01-17T14:58:38.088866Z" } }, "outputs": [ @@ -811,10 +818,10 @@ "" ], "text/plain": [ - "" + "" ] }, - "execution_count": 16, + "execution_count": 17, "metadata": {}, "output_type": "execute_result" } @@ -836,14 +843,14 @@ }, { "cell_type": "code", - "execution_count": 17, + "execution_count": 18, "id": "640602e7", "metadata": { "execution": { - "iopub.execute_input": "2022-07-23T21:47:15.192111Z", - "iopub.status.busy": "2022-07-23T21:47:15.191035Z", - "iopub.status.idle": "2022-07-23T21:47:15.195118Z", - "shell.execute_reply": "2022-07-23T21:47:15.195984Z" + "iopub.execute_input": "2023-01-17T14:58:38.098495Z", + "iopub.status.busy": "2023-01-17T14:58:38.097518Z", + "iopub.status.idle": "2023-01-17T14:58:38.108185Z", + "shell.execute_reply": "2023-01-17T14:58:38.106326Z" } }, "outputs": [ @@ -867,10 +874,10 @@ "" ], "text/plain": [ - "" + "" ] }, - "execution_count": 17, + "execution_count": 18, "metadata": {}, "output_type": "execute_result" } @@ -881,14 +888,14 @@ }, { "cell_type": "code", - "execution_count": 18, + "execution_count": 19, "id": "0709cf75", "metadata": { "execution": { - "iopub.execute_input": "2022-07-23T21:47:15.203240Z", - "iopub.status.busy": "2022-07-23T21:47:15.201693Z", - "iopub.status.idle": "2022-07-23T21:47:15.206861Z", - "shell.execute_reply": "2022-07-23T21:47:15.205967Z" + "iopub.execute_input": "2023-01-17T14:58:38.117897Z", + "iopub.status.busy": "2023-01-17T14:58:38.117332Z", + "iopub.status.idle": "2023-01-17T14:58:38.126185Z", + "shell.execute_reply": "2023-01-17T14:58:38.124129Z" } }, "outputs": [ @@ -910,10 +917,10 @@ "" ], "text/plain": [ - "" + "" ] }, - "execution_count": 18, + "execution_count": 19, "metadata": {}, "output_type": "execute_result" } @@ -924,14 +931,14 @@ }, { "cell_type": "code", - "execution_count": 19, + "execution_count": 20, "id": "7ef69ab6", "metadata": { "execution": { - "iopub.execute_input": "2022-07-23T21:47:15.212958Z", - "iopub.status.busy": "2022-07-23T21:47:15.211826Z", - "iopub.status.idle": "2022-07-23T21:47:15.216875Z", - "shell.execute_reply": "2022-07-23T21:47:15.215909Z" + "iopub.execute_input": "2023-01-17T14:58:38.136699Z", + "iopub.status.busy": "2023-01-17T14:58:38.136360Z", + "iopub.status.idle": "2023-01-17T14:58:38.142355Z", + "shell.execute_reply": "2023-01-17T14:58:38.141609Z" } }, "outputs": [ @@ -952,10 +959,10 @@ "" ], "text/plain": [ - "" + "" ] }, - "execution_count": 19, + "execution_count": 20, "metadata": {}, "output_type": "execute_result" } @@ -966,14 +973,14 @@ }, { "cell_type": "code", - "execution_count": 20, + "execution_count": 21, "id": "f667ebcd", "metadata": { "execution": { - "iopub.execute_input": "2022-07-23T21:47:15.223853Z", - "iopub.status.busy": "2022-07-23T21:47:15.221991Z", - "iopub.status.idle": "2022-07-23T21:47:15.228194Z", - "shell.execute_reply": "2022-07-23T21:47:15.227225Z" + "iopub.execute_input": "2023-01-17T14:58:38.153887Z", + "iopub.status.busy": "2023-01-17T14:58:38.153247Z", + "iopub.status.idle": "2023-01-17T14:58:38.162831Z", + "shell.execute_reply": "2023-01-17T14:58:38.160884Z" } }, "outputs": [ @@ -994,10 +1001,10 @@ "" ], "text/plain": [ - "" + "" ] }, - "execution_count": 20, + "execution_count": 21, "metadata": {}, "output_type": "execute_result" } @@ -1031,7 +1038,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.9.1" + "version": "3.10.1" } }, "nbformat": 4, diff --git a/docs/api/current.md b/docs/api/current.md index 54f77bd0..276acdc9 100644 --- a/docs/api/current.md +++ b/docs/api/current.md @@ -113,7 +113,7 @@ These attributes are always available in the `current` object. - +