idmtools_platform_local.internals.ui.controllers.experiments module

idmtools local platform experiment controller(API).

Copyright 2021, Bill & Melinda Gates Foundation. All rights reserved.

idmtools_platform_local.internals.ui.controllers.experiments.progress_to_status_str(progress)

Convert progress to status.

idmtools_platform_local.internals.ui.controllers.experiments.handle_backoff_exc(details)

Log backoff exceptions to our app logger and restart db connection.

idmtools_platform_local.internals.ui.controllers.experiments.experiment_filter(id: Optional[str], tags: Optional[List[Tuple[str, str]]], page: int = 1, per_page: int = 10) → Tuple[Dict, int]

List the status of experiment(s) with the ability to filter by experiment id and tags.

Parameters:

  • id (Optional[str]) – Optional ID of the experiment you want to filter by

  • tags (Optional[List[Tuple[str, str]]]) – Optional list of tuples in form of tag_name tag_value to user to filter experiments with

  • page (int) – Which page to load. Defaults to 1

  • per_page (int) – Experiments per page. Defaults to 50

class idmtools_platform_local.internals.ui.controllers.experiments.Experiments

Bases: Resource

Experiment API controller.

get(id=None)

Get experiment.

delete(id)

Delete an experiment.

endpoint = 'experiments'
mediatypes()
methods: ClassVar[Optional[Collection[str]]] = {'DELETE', 'GET'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.