Skip to content

add docs for branches and conditionals #155

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

Merged
merged 3 commits into from
Aug 30, 2025
Merged

add docs for branches and conditionals #155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ae4015e
add docs for branches and conditionals
tuulos Aug 30, 2025
d72e30d
update api docs
tuulos Aug 30, 2025
7b9b2de
high-res version of dag pics
tuulos Aug 30, 2025
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
372 changes: 186 additions & 186 deletions docs/api/S3.ipynb
View file
Open in desktop

Large diffs are not rendered by default.

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


<DocSection type="class" name="S3" module="metaflow" show_import="True" heading_level="3" link="https://github.com/Netflix/metaflow/tree/master/metaflow/plugins/datatools/s3/s3.py#L452">
<DocSection type="class" name="S3" module="metaflow" show_import="True" heading_level="3" link="https://github.com/Netflix/metaflow/tree/master/metaflow/plugins/datatools/s3/s3.py#L458">
<SigArgSection>
<SigArg name="tmproot='.', bucket=None, prefix=None, run=None, s3root=None" />
</SigArgSection>
Expand All @@ -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#L590">
<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#L871">
<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#L978">
<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#L1053">
<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#L1109">
<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#L657">
<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#L707">
<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#L1135">
<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#L1232">
<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#L1306">
<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#L753">
<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#L811">
<SigArgSection>
<SigArg name="self" /><SigArg name="keys" type="Iterable" /><SigArg name="return_missing" type="bool" default="False" />
</SigArgSection>
Expand All @@ -233,7 +233,7 @@ Most operations above return `S3Object`s that encapsulate information about S3 p
Note that the data itself is not kept in these objects but it is stored in a temporary directory which is accessible through the properties of this object.


<DocSection type="class" name="S3Object" module="metaflow" show_import="False" heading_level="3" link="https://github.com/Netflix/metaflow/tree/master/metaflow/plugins/datatools/s3/s3.py#L139">
<DocSection type="class" name="S3Object" module="metaflow" show_import="False" heading_level="3" link="https://github.com/Netflix/metaflow/tree/master/metaflow/plugins/datatools/s3/s3.py#L145">
<SigArgSection>
<SigArg name="" />
</SigArgSection>
Expand Down
48 changes: 24 additions & 24 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": "2025-08-30T21:15:35.980208Z",
"iopub.status.busy": "2025-08-30T21:15:35.980109Z",
"iopub.status.idle": "2025-08-30T21:15:36.215677Z",
"shell.execute_reply": "2025-08-30T21:15:36.215432Z"
}
},
"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": "2025-08-30T21:15:36.217828Z",
"iopub.status.busy": "2025-08-30T21:15:36.217681Z",
"iopub.status.idle": "2025-08-30T21:15:36.223338Z",
"shell.execute_reply": "2025-08-30T21:15:36.223136Z"
}
},
"outputs": [
Expand All @@ -69,7 +69,7 @@
"</DocSection>"
],
"text/plain": [
"<nbdoc.showdoc.ShowDoc at 0x11320a350>"
"<nbdoc.showdoc.ShowDoc at 0x1079011d0>"
]
},
"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": "2025-08-30T21:15:36.225225Z",
"iopub.status.busy": "2025-08-30T21:15:36.225147Z",
"iopub.status.idle": "2025-08-30T21:15:36.227365Z",
"shell.execute_reply": "2025-08-30T21:15:36.227159Z"
}
},
"outputs": [
Expand All @@ -112,7 +112,7 @@
"</DocSection>"
],
"text/plain": [
"<nbdoc.showdoc.ShowDoc at 0x113233dd0>"
"<nbdoc.showdoc.ShowDoc at 0x107107b50>"
]
},
"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": "2025-08-30T21:15:36.229396Z",
"iopub.status.busy": "2025-08-30T21:15:36.229326Z",
"iopub.status.idle": "2025-08-30T21:15:36.231974Z",
"shell.execute_reply": "2025-08-30T21:15:36.231765Z"
}
},
"outputs": [
Expand All @@ -155,7 +155,7 @@
"</DocSection>"
],
"text/plain": [
"<nbdoc.showdoc.ShowDoc at 0x110e321d0>"
"<nbdoc.showdoc.ShowDoc at 0x107903550>"
]
},
"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": "2025-08-30T21:15:36.234080Z",
"iopub.status.busy": "2025-08-30T21:15:36.233990Z",
"iopub.status.idle": "2025-08-30T21:15:36.236173Z",
"shell.execute_reply": "2025-08-30T21:15:36.235982Z"
}
},
"outputs": [
Expand All @@ -198,7 +198,7 @@
"</DocSection>"
],
"text/plain": [
"<nbdoc.showdoc.ShowDoc at 0x113231a10>"
"<nbdoc.showdoc.ShowDoc at 0x107901a10>"
]
},
"execution_count": 5,
Expand Down
Loading
Loading