Skip to content

Update deployer docs to work with the new inheritance based deployer #132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+1,459 −1,398
Open

Update deployer docs to work with the new inheritance based deployer #132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
366 changes: 183 additions & 183 deletions docs/api/S3.ipynb
View file
Open in desktop

Large diffs are not rendered by default.

24 changes: 12 additions & 12 deletions docs/api/S3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ For instructions how to use the class, see [Loading and Storing Data](/scaling/d



<DocSection type="method" name="S3.close" module="metaflow" show_import="False" heading_level="4" link="https://github.com/Netflix/metaflow/tree/master/metaflow/plugins/datatools/s3/s3.py#L582">
<DocSection type="method" name="S3.close" module="metaflow" show_import="False" heading_level="4" link="https://github.com/Netflix/metaflow/tree/master/metaflow/plugins/datatools/s3/s3.py#L584">
<SigArgSection>
<SigArg name="self" />
</SigArgSection>
Expand All @@ -43,7 +43,7 @@ For instructions how to use the class, see [Loading and Storing Data](/scaling/d
## Downloading data


<DocSection type="method" name="S3.get" module="metaflow" show_import="False" heading_level="4" link="https://github.com/Netflix/metaflow/tree/master/metaflow/plugins/datatools/s3/s3.py#L859">
<DocSection type="method" name="S3.get" module="metaflow" show_import="False" heading_level="4" link="https://github.com/Netflix/metaflow/tree/master/metaflow/plugins/datatools/s3/s3.py#L861">
<SigArgSection>
<SigArg name="self" /><SigArg name="key" type="Union" default="None" /><SigArg name="return_missing" type="bool" default="False" /><SigArg name="return_info" type="bool" default="True" />
</SigArgSection>
Expand All @@ -60,7 +60,7 @@ For instructions how to use the class, see [Loading and Storing Data](/scaling/d



<DocSection type="method" name="S3.get_many" module="metaflow" show_import="False" heading_level="4" link="https://github.com/Netflix/metaflow/tree/master/metaflow/plugins/datatools/s3/s3.py#L964">
<DocSection type="method" name="S3.get_many" module="metaflow" show_import="False" heading_level="4" link="https://github.com/Netflix/metaflow/tree/master/metaflow/plugins/datatools/s3/s3.py#L966">
<SigArgSection>
<SigArg name="self" /><SigArg name="keys" type="Iterable" /><SigArg name="return_missing" type="bool" default="False" /><SigArg name="return_info" type="bool" default="True" />
</SigArgSection>
Expand All @@ -77,7 +77,7 @@ For instructions how to use the class, see [Loading and Storing Data](/scaling/d



<DocSection type="method" name="S3.get_recursive" module="metaflow" show_import="False" heading_level="4" link="https://github.com/Netflix/metaflow/tree/master/metaflow/plugins/datatools/s3/s3.py#L1039">
<DocSection type="method" name="S3.get_recursive" module="metaflow" show_import="False" heading_level="4" link="https://github.com/Netflix/metaflow/tree/master/metaflow/plugins/datatools/s3/s3.py#L1041">
<SigArgSection>
<SigArg name="self" /><SigArg name="keys" type="Iterable" /><SigArg name="return_info" type="bool" default="False" />
</SigArgSection>
Expand All @@ -93,7 +93,7 @@ For instructions how to use the class, see [Loading and Storing Data](/scaling/d



<DocSection type="method" name="S3.get_all" module="metaflow" show_import="False" heading_level="4" link="https://github.com/Netflix/metaflow/tree/master/metaflow/plugins/datatools/s3/s3.py#L1095">
<DocSection type="method" name="S3.get_all" module="metaflow" show_import="False" heading_level="4" link="https://github.com/Netflix/metaflow/tree/master/metaflow/plugins/datatools/s3/s3.py#L1097">
<SigArgSection>
<SigArg name="self" /><SigArg name="return_info" type="bool" default="False" />
</SigArgSection>
Expand All @@ -110,7 +110,7 @@ For instructions how to use the class, see [Loading and Storing Data](/scaling/d
## Listing objects


<DocSection type="method" name="S3.list_paths" module="metaflow" show_import="False" heading_level="4" link="https://github.com/Netflix/metaflow/tree/master/metaflow/plugins/datatools/s3/s3.py#L647">
<DocSection type="method" name="S3.list_paths" module="metaflow" show_import="False" heading_level="4" link="https://github.com/Netflix/metaflow/tree/master/metaflow/plugins/datatools/s3/s3.py#L649">
<SigArgSection>
<SigArg name="self" /><SigArg name="keys" type="Optional" default="None" />
</SigArgSection>
Expand All @@ -125,7 +125,7 @@ For instructions how to use the class, see [Loading and Storing Data](/scaling/d



<DocSection type="method" name="S3.list_recursive" module="metaflow" show_import="False" heading_level="4" link="https://github.com/Netflix/metaflow/tree/master/metaflow/plugins/datatools/s3/s3.py#L697">
<DocSection type="method" name="S3.list_recursive" module="metaflow" show_import="False" heading_level="4" link="https://github.com/Netflix/metaflow/tree/master/metaflow/plugins/datatools/s3/s3.py#L699">
<SigArgSection>
<SigArg name="self" /><SigArg name="keys" type="Optional" default="None" />
</SigArgSection>
Expand All @@ -142,7 +142,7 @@ For instructions how to use the class, see [Loading and Storing Data](/scaling/d
## Uploading data


<DocSection type="method" name="S3.put" module="metaflow" show_import="False" heading_level="4" link="https://github.com/Netflix/metaflow/tree/master/metaflow/plugins/datatools/s3/s3.py#L1121">
<DocSection type="method" name="S3.put" module="metaflow" show_import="False" heading_level="4" link="https://github.com/Netflix/metaflow/tree/master/metaflow/plugins/datatools/s3/s3.py#L1123">
<SigArgSection>
<SigArg name="self" /><SigArg name="key" type="Union" /><SigArg name="obj" type="Union" /><SigArg name="overwrite" type="bool" default="True" /><SigArg name="content_type" type="Optional" default="None" /><SigArg name="metadata" type="Optional" default="None" />
</SigArgSection>
Expand All @@ -161,7 +161,7 @@ For instructions how to use the class, see [Loading and Storing Data](/scaling/d



<DocSection type="method" name="S3.put_many" module="metaflow" show_import="False" heading_level="4" link="https://github.com/Netflix/metaflow/tree/master/metaflow/plugins/datatools/s3/s3.py#L1216">
<DocSection type="method" name="S3.put_many" module="metaflow" show_import="False" heading_level="4" link="https://github.com/Netflix/metaflow/tree/master/metaflow/plugins/datatools/s3/s3.py#L1218">
<SigArgSection>
<SigArg name="self" /><SigArg name="key_objs" type="List" /><SigArg name="overwrite" type="bool" default="True" />
</SigArgSection>
Expand All @@ -177,7 +177,7 @@ For instructions how to use the class, see [Loading and Storing Data](/scaling/d



<DocSection type="method" name="S3.put_files" module="metaflow" show_import="False" heading_level="4" link="https://github.com/Netflix/metaflow/tree/master/metaflow/plugins/datatools/s3/s3.py#L1290">
<DocSection type="method" name="S3.put_files" module="metaflow" show_import="False" heading_level="4" link="https://github.com/Netflix/metaflow/tree/master/metaflow/plugins/datatools/s3/s3.py#L1292">
<SigArgSection>
<SigArg name="self" /><SigArg name="key_paths" type="List" /><SigArg name="overwrite" type="bool" default="True" />
</SigArgSection>
Expand All @@ -195,7 +195,7 @@ For instructions how to use the class, see [Loading and Storing Data](/scaling/d
## Querying metadata


<DocSection type="method" name="S3.info" module="metaflow" show_import="False" heading_level="4" link="https://github.com/Netflix/metaflow/tree/master/metaflow/plugins/datatools/s3/s3.py#L743">
<DocSection type="method" name="S3.info" module="metaflow" show_import="False" heading_level="4" link="https://github.com/Netflix/metaflow/tree/master/metaflow/plugins/datatools/s3/s3.py#L745">
<SigArgSection>
<SigArg name="self" /><SigArg name="key" type="Optional" default="None" /><SigArg name="return_missing" type="bool" default="False" />
</SigArgSection>
Expand All @@ -211,7 +211,7 @@ For instructions how to use the class, see [Loading and Storing Data](/scaling/d



<DocSection type="method" name="S3.info_many" module="metaflow" show_import="False" heading_level="4" link="https://github.com/Netflix/metaflow/tree/master/metaflow/plugins/datatools/s3/s3.py#L799">
<DocSection type="method" name="S3.info_many" module="metaflow" show_import="False" heading_level="4" link="https://github.com/Netflix/metaflow/tree/master/metaflow/plugins/datatools/s3/s3.py#L801">
<SigArgSection>
<SigArg name="self" /><SigArg name="keys" type="Iterable" /><SigArg name="return_missing" type="bool" default="False" />
</SigArgSection>
Expand Down
50 changes: 25 additions & 25 deletions docs/api/argoevent.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@
"id": "623be2bc",
"metadata": {
"execution": {
"iopub.execute_input": "2024-07-25T06:16:57.861281Z",
"iopub.status.busy": "2024-07-25T06:16:57.861167Z",
"iopub.status.idle": "2024-07-25T06:16:58.142243Z",
"shell.execute_reply": "2024-07-25T06:16:58.141916Z"
"iopub.execute_input": "2024-11-05T04:49:38.992658Z",
"iopub.status.busy": "2024-11-05T04:49:38.992468Z",
"iopub.status.idle": "2024-11-05T04:49:39.292418Z",
"shell.execute_reply": "2024-11-05T04:49:39.292092Z"
}
},
"outputs": [],
Expand All @@ -43,10 +43,10 @@
"id": "1bf3f08e",
"metadata": {
"execution": {
"iopub.execute_input": "2024-07-25T06:16:58.144720Z",
"iopub.status.busy": "2024-07-25T06:16:58.144574Z",
"iopub.status.idle": "2024-07-25T06:16:58.150537Z",
"shell.execute_reply": "2024-07-25T06:16:58.150220Z"
"iopub.execute_input": "2024-11-05T04:49:39.295375Z",
"iopub.status.busy": "2024-11-05T04:49:39.295113Z",
"iopub.status.idle": "2024-11-05T04:49:39.301562Z",
"shell.execute_reply": "2024-11-05T04:49:39.301310Z"
}
},
"outputs": [
Expand All @@ -69,7 +69,7 @@
"</DocSection>"
],
"text/plain": [
"<nbdoc.showdoc.ShowDoc at 0x11320a350>"
"<nbdoc.showdoc.ShowDoc at 0x113902c80>"
]
},
"execution_count": 2,
Expand All @@ -87,10 +87,10 @@
"id": "380eb9ac",
"metadata": {
"execution": {
"iopub.execute_input": "2024-07-25T06:16:58.152753Z",
"iopub.status.busy": "2024-07-25T06:16:58.152639Z",
"iopub.status.idle": "2024-07-25T06:16:58.155420Z",
"shell.execute_reply": "2024-07-25T06:16:58.155095Z"
"iopub.execute_input": "2024-11-05T04:49:39.304666Z",
"iopub.status.busy": "2024-11-05T04:49:39.304329Z",
"iopub.status.idle": "2024-11-05T04:49:39.307422Z",
"shell.execute_reply": "2024-11-05T04:49:39.307057Z"
}
},
"outputs": [
Expand All @@ -112,7 +112,7 @@
"</DocSection>"
],
"text/plain": [
"<nbdoc.showdoc.ShowDoc at 0x113233dd0>"
"<nbdoc.showdoc.ShowDoc at 0x11393f370>"
]
},
"execution_count": 3,
Expand All @@ -130,10 +130,10 @@
"id": "31916bae",
"metadata": {
"execution": {
"iopub.execute_input": "2024-07-25T06:16:58.157788Z",
"iopub.status.busy": "2024-07-25T06:16:58.157687Z",
"iopub.status.idle": "2024-07-25T06:16:58.160981Z",
"shell.execute_reply": "2024-07-25T06:16:58.160604Z"
"iopub.execute_input": "2024-11-05T04:49:39.310391Z",
"iopub.status.busy": "2024-11-05T04:49:39.310263Z",
"iopub.status.idle": "2024-11-05T04:49:39.313769Z",
"shell.execute_reply": "2024-11-05T04:49:39.313512Z"
}
},
"outputs": [
Expand All @@ -155,7 +155,7 @@
"</DocSection>"
],
"text/plain": [
"<nbdoc.showdoc.ShowDoc at 0x110e321d0>"
"<nbdoc.showdoc.ShowDoc at 0x11393f1f0>"
]
},
"execution_count": 4,
Expand All @@ -173,10 +173,10 @@
"id": "305678d7",
"metadata": {
"execution": {
"iopub.execute_input": "2024-07-25T06:16:58.163921Z",
"iopub.status.busy": "2024-07-25T06:16:58.163779Z",
"iopub.status.idle": "2024-07-25T06:16:58.166454Z",
"shell.execute_reply": "2024-07-25T06:16:58.166148Z"
"iopub.execute_input": "2024-11-05T04:49:39.316992Z",
"iopub.status.busy": "2024-11-05T04:49:39.316882Z",
"iopub.status.idle": "2024-11-05T04:49:39.319433Z",
"shell.execute_reply": "2024-11-05T04:49:39.319145Z"
}
},
"outputs": [
Expand All @@ -198,7 +198,7 @@
"</DocSection>"
],
"text/plain": [
"<nbdoc.showdoc.ShowDoc at 0x113231a10>"
"<nbdoc.showdoc.ShowDoc at 0x11393f3a0>"
]
},
"execution_count": 5,
Expand Down Expand Up @@ -235,7 +235,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.0"
"version": "3.10.13"
}
},
"nbformat": 4,
Expand Down
Loading
Loading