Skip to content
353 changes: 353 additions & 0 deletions docs/guides/extensions/curator/compute_tasks.md

Large diffs are not rendered by default.

56 changes: 56 additions & 0 deletions docs/reference/experimental/async/curator.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
- list_async
- create_grid_session_async
- set_task_state_async
- set_execution_details_async
- execute_async
---

[](){ #RecordSet-reference-async }
Expand All @@ -38,6 +40,12 @@
- validate_schema_async
- get_schema_derived_keys_async
---
[](){ #CurationTaskProperties-reference-async }
::: synapseclient.models.CurationTaskProperties
options:
inherited_members: true
members:
---
[](){ #RecordBasedMetadataTaskProperties-reference-async }
::: synapseclient.models.RecordBasedMetadataTaskProperties
options:
Expand All @@ -50,6 +58,54 @@
inherited_members: true
members:
---
[](){ #SampleSheetGenerationExecutionProperties-reference-async }
::: synapseclient.models.SampleSheetGenerationExecutionProperties
options:
inherited_members: true
members:
---
[](){ #RecordSetGenerationExecutionProperties-reference-async }
::: synapseclient.models.RecordSetGenerationExecutionProperties
options:
inherited_members: true
members:
---
[](){ #UnknownCurationTaskProperties-reference-async }
::: synapseclient.models.UnknownCurationTaskProperties
options:
inherited_members: true
members:
---
[](){ #TaskExecutionDetails-reference-async }
::: synapseclient.models.TaskExecutionDetails
options:
inherited_members: true
members:
---
[](){ #ExecutableTaskExecutionDetails-reference-async }
::: synapseclient.models.ExecutableTaskExecutionDetails
options:
inherited_members: true
members:
---
[](){ #SampleSheetGenerationExecutionDetails-reference-async }
::: synapseclient.models.SampleSheetGenerationExecutionDetails
options:
inherited_members: true
members:
---
[](){ #RecordSetGenerationExecutionDetails-reference-async }
::: synapseclient.models.RecordSetGenerationExecutionDetails
options:
inherited_members: true
members:
---
[](){ #UnknownTaskExecutionDetails-reference-async }
::: synapseclient.models.UnknownTaskExecutionDetails
options:
inherited_members: true
members:
---
[](){ #AuthorizationMode-reference-async }
::: synapseclient.models.AuthorizationMode
options:
Expand Down
56 changes: 56 additions & 0 deletions docs/reference/experimental/sync/curator.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
- list
- create_grid_session
- set_task_state
- set_execution_details
- execute
---

[](){ #RecordSet-reference }
Expand All @@ -38,6 +40,12 @@
- validate_schema
- get_schema_derived_keys
---
[](){ #CurationTaskProperties-reference }
::: synapseclient.models.CurationTaskProperties
options:
inherited_members: true
members:
---
[](){ #RecordBasedMetadataTaskProperties-reference }
::: synapseclient.models.RecordBasedMetadataTaskProperties
options:
Expand All @@ -50,6 +58,54 @@
inherited_members: true
members:
---
[](){ #SampleSheetGenerationExecutionProperties-reference }
::: synapseclient.models.SampleSheetGenerationExecutionProperties
options:
inherited_members: true
members:
---
[](){ #RecordSetGenerationExecutionProperties-reference }
::: synapseclient.models.RecordSetGenerationExecutionProperties
options:
inherited_members: true
members:
---
[](){ #UnknownCurationTaskProperties-reference }
::: synapseclient.models.UnknownCurationTaskProperties
options:
inherited_members: true
members:
---
[](){ #TaskExecutionDetails-reference }
::: synapseclient.models.TaskExecutionDetails
options:
inherited_members: true
members:
---
[](){ #ExecutableTaskExecutionDetails-reference }
::: synapseclient.models.ExecutableTaskExecutionDetails
options:
inherited_members: true
members:
---
[](){ #SampleSheetGenerationExecutionDetails-reference }
::: synapseclient.models.SampleSheetGenerationExecutionDetails
options:
inherited_members: true
members:
---
[](){ #RecordSetGenerationExecutionDetails-reference }
::: synapseclient.models.RecordSetGenerationExecutionDetails
options:
inherited_members: true
members:
---
[](){ #UnknownTaskExecutionDetails-reference }
::: synapseclient.models.UnknownTaskExecutionDetails
options:
inherited_members: true
members:
---
[](){ #AuthorizationMode-reference }
::: synapseclient.models.AuthorizationMode
options:
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ nav:
- Curator JSONschemas: guides/extensions/curator/schema_operations.md
- Curator (administrators): guides/extensions/curator/metadata_curation.md
- Curator (contributors): guides/extensions/curator/metadata_contribution.md
- Curator compute tasks: guides/extensions/curator/compute_tasks.md
# - Expermental Features:
# - Validating Annotations: guides/validate_annotations.md
- API Reference:
Expand Down
19 changes: 19 additions & 0 deletions synapseclient/core/constants/concrete_types.py
Original file line number Diff line number Diff line change
Expand Up @@ -136,9 +136,28 @@
RECORD_BASED_METADATA_TASK_PROPERTIES = (
"org.sagebionetworks.repo.model.curation.metadata.RecordBasedMetadataTaskProperties"
)
SAMPLE_SHEET_GENERATION_EXECUTION_PROPERTIES = (
"org.sagebionetworks.repo.model.curation.execution."
"SampleSheetGenerationExecutionProperties"
)
RECORD_SET_GENERATION_EXECUTION_PROPERTIES = (
"org.sagebionetworks.repo.model.curation.execution."
"RecordSetGenerationExecutionProperties"
)
GRID_EXECUTION_DETAILS = (
"org.sagebionetworks.repo.model.curation.execution.GridExecutionDetails"
)
SAMPLE_SHEET_GENERATION_EXECUTION_DETAILS = (
"org.sagebionetworks.repo.model.curation.execution."
"SampleSheetGenerationExecutionDetails"
)
RECORD_SET_GENERATION_EXECUTION_DETAILS = (
"org.sagebionetworks.repo.model.curation.execution."
"RecordSetGenerationExecutionDetails"
)
COMPUTE_TASK_EXECUTION_REQUEST = (
"org.sagebionetworks.repo.model.curation.ComputeTaskExecutionRequest"
)

# Download List
DOWNLOAD_LIST_MANIFEST_REQUEST = (
Expand Down
2 changes: 1 addition & 1 deletion synapseclient/core/transfer_bar.py
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ def create_progress_bar(
smoothing=0,
postfix=postfix,
leave=None,
disable=silent,
disable=bool(silent),
)


Expand Down
16 changes: 16 additions & 0 deletions synapseclient/models/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,21 @@
from synapseclient.models.curation import (
AuthorizationMode,
CurationTask,
CurationTaskProperties,
CurationTaskStatus,
ExecutableTaskExecutionDetails,
FileBasedMetadataTaskProperties,
Grid,
GridExecutionDetails,
RecordBasedMetadataTaskProperties,
RecordSetGenerationExecutionDetails,
RecordSetGenerationExecutionProperties,
SampleSheetGenerationExecutionDetails,
SampleSheetGenerationExecutionProperties,
TaskExecutionDetails,
TaskState,
UnknownCurationTaskProperties,
UnknownTaskExecutionDetails,
)
from synapseclient.models.dataset import Dataset, DatasetCollection, EntityRef
from synapseclient.models.docker import DockerRepository
Expand Down Expand Up @@ -121,12 +129,20 @@
"AuthorizationMode",
"CurationTask",
"CurationTaskStatus",
"CurationTaskProperties",
"FileBasedMetadataTaskProperties",
"RecordBasedMetadataTaskProperties",
"SampleSheetGenerationExecutionProperties",
"RecordSetGenerationExecutionProperties",
"UnknownCurationTaskProperties",
"TaskState",
"Grid",
"GridExecutionDetails",
"TaskExecutionDetails",
"ExecutableTaskExecutionDetails",
"SampleSheetGenerationExecutionDetails",
"RecordSetGenerationExecutionDetails",
"UnknownTaskExecutionDetails",
"UserProfile",
"UserPreference",
"UserGroupHeader",
Expand Down
Loading
Loading