ensembles#

The ensemble related routes

Attributes#

Functions#

add_job_fields(ensemble)

Adds the synthetic jobs_metadata field

index()

Gets all ensembles the current user has access to

create()

Create an ensemble

get_comments(ensemble_id)

Get the comments for an ensemble

get_users([ensemble_id])

Get all users that have access to an ensemble

share([ensemble_id, email])

Share an ensemble with another user

add_job_to_ensemble(ensemble_id, job_id)

Add a job to an ensemble

create_comment(ensemble_id)

Create a comment for an ensemble

get(ensemble_id)

Get an ensemble by id

jobs(ensemble_id)

Get all jobs included in an ensemble

delete_job_from_ensemble(ensemble_id, job_id)

Delete a job from an ensemble

delete_ensemble(ensemble_id)

Delete an ensemble by its ID

execute(ensemble_id)

Create and execute the jobs in this ensemble

create_jobs_for_config(config)

Creates the job configurations for an ensemble using

create_jobs(ensemble, auth)

Create the jobs for an ensemble

Module Contents#

ensembles.ensembles#
ensembles.add_job_fields(ensemble: ump.api.models.ensemble.Ensemble)#

Adds the synthetic jobs_metadata field

ensembles.index()#

Gets all ensembles the current user has access to

ensembles.create()#

Create an ensemble

ensembles.get_comments(ensemble_id)#

Get the comments for an ensemble

ensembles.get_users(ensemble_id=None)#

Get all users that have access to an ensemble

ensembles.share(ensemble_id=None, email=None)#

Share an ensemble with another user

ensembles.add_job_to_ensemble(ensemble_id, job_id)#

Add a job to an ensemble

ensembles.create_comment(ensemble_id)#

Create a comment for an ensemble

ensembles.get(ensemble_id)#

Get an ensemble by id

ensembles.jobs(ensemble_id)#

Get all jobs included in an ensemble

ensembles.delete_job_from_ensemble(ensemble_id, job_id)#

Delete a job from an ensemble

ensembles.delete_ensemble(ensemble_id)#

Delete an ensemble by its ID

ensembles.execute(ensemble_id)#

Create and execute the jobs in this ensemble

ensembles.create_jobs_for_config(config)#

Creates the job configurations for an ensemble using the configured parameters and sampling method

ensembles.create_jobs(ensemble: ump.api.models.ensemble.Ensemble, auth)#

Create the jobs for an ensemble