[SYNPY-1590] Implement documentation of Submission(+Status, +Bundle) OOP model

docs/reference/experimental/async/submission.md

@@ -0,0 +1,19 @@
+# Submission
+
+Contained within this file are experimental interfaces for working with the Synapse Python
+Client. Unless otherwise noted these interfaces are subject to change at any time. Use
+at your own risk.
+
+## API Reference
+
+::: synapseclient.models.Submission
+    options:
+        inherited_members: true
+        members:
+            - store_async
+            - get_async
+            - delete_async
+            - cancel_async
+            - get_evaluation_submissions_async
+            - get_user_submissions_async
+            - get_submission_count_async

docs/reference/experimental/async/submission_bundle.md

@@ -0,0 +1,14 @@
+# Submission Bundle
+
+Contained within this file are experimental interfaces for working with the Synapse Python
+Client. Unless otherwise noted these interfaces are subject to change at any time. Use
+at your own risk.
+
+## API Reference
+
+::: synapseclient.models.SubmissionBundle
+    options:
+        inherited_members: true
+        members:
+            - get_evaluation_submission_bundles_async
+            - get_user_submission_bundles_async

docs/reference/experimental/async/submission_status.md

@@ -0,0 +1,16 @@
+# Submission Status
+
+Contained within this file are experimental interfaces for working with the Synapse Python
+Client. Unless otherwise noted these interfaces are subject to change at any time. Use
+at your own risk.
+
+## API Reference
+
+::: synapseclient.models.SubmissionStatus
+    options:
+        inherited_members: true
+        members:
+            - get_async
+            - store_async
+            - get_all_submission_statuses_async
+            - batch_update_submission_statuses_async

docs/reference/experimental/sync/submission.md

@@ -0,0 +1,19 @@
+# Submission
+
+Contained within this file are experimental interfaces for working with the Synapse Python
+Client. Unless otherwise noted these interfaces are subject to change at any time. Use
+at your own risk.
+
+## API Reference
+
+::: synapseclient.models.Submission
+    options:
+        inherited_members: true
+        members:
+            - store
+            - get
+            - delete
+            - cancel
+            - get_evaluation_submissions
+            - get_user_submissions
+            - get_submission_count

docs/reference/experimental/sync/submission_bundle.md

@@ -0,0 +1,14 @@
+# Submission Bundle
+
+Contained within this file are experimental interfaces for working with the Synapse Python
+Client. Unless otherwise noted these interfaces are subject to change at any time. Use
+at your own risk.
+
+## API Reference
+
+::: synapseclient.models.SubmissionBundle
+    options:
+        inherited_members: true
+        members:
+            - get_evaluation_submission_bundles
+            - get_user_submission_bundles

docs/reference/experimental/sync/submission_status.md

@@ -0,0 +1,16 @@
+# Submission Status
+
+Contained within this file are experimental interfaces for working with the Synapse Python
+Client. Unless otherwise noted these interfaces are subject to change at any time. Use
+at your own risk.
+
+## API Reference
+
+::: synapseclient.models.SubmissionStatus
+    options:
+        inherited_members: true
+        members:
+            - get
+            - store
+            - get_all_submission_statuses
+            - batch_update_submission_statuses

docs/tutorials/python/submission.md

@@ -0,0 +1,131 @@
+# Submissions, SubmissionStatuses, SubmissionBundles
+Users can work with Submissions on the python client, since these objects are part of the Evaluation API data model. A user in a Synapse Evaluation can submit a Synapse Entity as a Submission to that Evaluation. Submission data is owned by the parent Evaluation, and is immutable.
+
+The data model includes additional objects to support scoring of Submissions and convenient data access:
+
+- **SubmissionStatus**: An object used to track scoring information for a single Submission. This object is intended to be modified by the users (or test harnesses) managing the Evaluation.
+- **SubmissionBundle**: A convenience object to transport a Submission and its accompanying SubmissionStatus in a single web service call.
+
+This tutorial will demonstrate how to work with all 3 object types using the python client for 2 different use-cases:
+
+1. Participating in a Synapse challenge
+1. Organizing a Synapse challenge
+
+
+## Tutorial Purpose
+In this tutorial:
+
+As a participant of a Synapse challenge, you will
+
+1. Make a submission to an existing evaluation queue on Synapse
+1. Fetch your existing submission
+1. Count your submissions
+1. Fetch all of your submissions from an existing evaluation queue on Synapse
+1. Check the status of your submission
+1. Cancel your submission
+
+As an organizer of a Synapse challenge, you will
+
+1. Annotate a submission to score it
+1. Batch-update submission statuses
+1. Fetch the submission bundle for a given submission
+1. Allow cancellation of submissions
+1. Delete submissions
+
+## Prerequisites
+* You have completed the [Evaluation](./evaluation.md) tutorial, or have an existing Evaluation on Synapse to work from
+* You have an existing entity with which to make a submission (can be a [File](./file.md) or Docker Repository)
+* You have the correct permissions on the Evaluation queue for your desired tutorial section (participant or organizer)
+
+## 1. Participating in a Synapse challenge
+
+### 1. Make a submission to an existing evaluation queue on Synapse
+
+```python
+{!docs/tutorials/python/tutorial_scripts/submission_participant.py!lines=30-51}
+```
+
+### 2. Fetch your existing submission
+
+```python
+{!docs/tutorials/python/tutorial_scripts/submission_participant.py!lines=56-71}
+```
+
+### 3. Count your submissions
+
+```python
+{!docs/tutorials/python/tutorial_scripts/submission_participant.py!lines=72-92}
+```
+
+### 4. Fetch all of your submissions from an existing evaluation queue on Synapse
+
+```python
+{!docs/tutorials/python/tutorial_scripts/submission_participant.py!lines=93-107}
+```
+
+### 5. Check the status of your submission
+
+```python
+{!docs/tutorials/python/tutorial_scripts/submission_participant.py!lines=108-130}
+```
+
+### 6. Cancel your submission
+
+```python
+{!docs/tutorials/python/tutorial_scripts/submission_participant.py!lines=131-157}
+```
+
+## 2. Organizing a Synapse challenge
+
+### 1. Annotate a submission to score it
+
+```python
+{!docs/tutorials/python/tutorial_scripts/submission_organizer.py!lines=29-57}
+```
+
+### 2. Batch-update submission statuses
+
+```python
+{!docs/tutorials/python/tutorial_scripts/submission_organizer.py!lines=58-101}
+```
+
+### 3. Fetch the submission bundle for a given submission
+
+```python
+{!docs/tutorials/python/tutorial_scripts/submission_organizer.py!lines=102-142}
+```
+
+### 4. Allow cancellation of submissions
+
+```python
+{!docs/tutorials/python/tutorial_scripts/submission_organizer.py!lines=143-195}
+```
+
+### 5. Delete submissions
+
+```python
+{!docs/tutorials/python/tutorial_scripts/submission_organizer.py!lines=196-229}
+```
+
+## Source code for this tutorial
+
+<details class="quote">
+  <summary>Click to show me (source code for Participant)</summary>
+
+```python
+{!docs/tutorials/python/tutorial_scripts/submission_participant.py!}
+```
+</details>
+
+<details class="quote">
+  <summary>Click to show me (source code for Organizer)</summary>
+
+```python
+{!docs/tutorials/python/tutorial_scripts/submission_organizer.py!}
+```
+</details>
+
+## References
+- [Evaluation][synapseclient.models.Evaluation]
+- [File][synapseclient.models.File]
+- [syn.login][synapseclient.Synapse.login]