Submissions

class indico.queries.submission.ListSubmissions(*, submission_ids=None, workflow_ids=None, filters=None, limit=1000, order_by='ID', desc=True)

List all Submissions visible to the authenticated user by most recent. Supports pagination (limit becomes page_size)

Options:

submission_ids (List[int]): Submission ids to filter by workflow_ids (List[int]): Workflow ids to filter by filters (SubmissionFilter or Dict): Submission attributes to filter by limit (int, default=1000): Maximum number of Submissions to return orderBy (str, default=”ID”): Submission attribute to filter by desc: (bool, default=True): List in descending order

Returns

All the found Submission objects If paginated, yields results one at a time

Return type

List[Submission]

class indico.queries.submission.GetSubmission(submission_id)

Retrieve a Submission by id

Parameters

submission_id (int) – Submission id

Returns

Found Submission object

Return type

Submission

class indico.queries.submission.UpdateSubmission(submission_id, retrieved)

Update the retrieval status of a Submission by id

Parameters

  • submission_id (int) – Submission id

  • retrieved (bool) – Bool to indicate if you have retrieved prediction results

Returns

Found Submission object

Return type

Submission

class indico.queries.submission.SubmissionResult(submission, check_status=None, wait=False, timeout=30)

Generate a result file for a Submission

Parameters

  • submission (int or Submission) – Id of the submission or Submission object

  • check_status (str, optional) – Submission status to check for. Defaults to any status other than PROCESSING

  • wait (bool, optional) – Wait until the submission is check_status and wait for the result file to be generated. Defaults to False

  • timeout (int or float, optional) – Maximum number of seconds to wait before timing out. Ignored if not wait. Defaults to 30

Returns

A Job that can be watched for results

Return type

Job

Raises

  • if wait – IndicoTimeoutError: Submission was not check_status or result file Job did not complete within `timeout seconds.

  • If not wait – IndicoInputError: The requested Submission is not check_status

class indico.queries.submission.SubmitReview(submission, changes=None, rejected=False, force_complete=None)

Submit an “Auto” Review for a submission. Requires that the submission be in PENDING_AUTO_REVIEW status.

Parameters

submission_id (int) – Id of submission to submit reviewEnabled for

Options:

changes (dict or JSONString): changes to make to raw predictions

rejected (boolean): reject the predictions and place the submission

in the review queue. Must be True if $changes not provided

force_complete (boolean): have this submission bypass the Review queue

(or exceptions queue if <rejected> is True) and mark as Complete. NOT RECOMMENDED

Returns

A Job that can be watched for status of review

Return type

Job

class indico.queries.submission.RetrySubmission(submission_ids)

Given a list of submission ids, retry those failed submissions. Submissions must be in a failed state and cannot be requested before the cool-off period (typically 180ms).

Parameters

submission_ids (List[int]) – the given submission ids to retry.

Options:

Raises

IndicoInputError –

class indico.queries.submission.WaitForSubmissions(submission_ids, timeout=60)

Given submission_ids, wait for all to finish processing

class indico.queries.submission.GenerateSubmissionResult(submission)