ExperimentRunsResource

Experiment run API methods.

Functions

func__init__(self, client) -> None

Initialize the resource.

paramself

paramclientKitaruAPIClient

API client used to send requests.

Returns

None

funcget(self, experiment_run_id) -> ExperimentRunResponse

Get an experiment run by id.

paramself

paramexperiment_run_iduuid.UUID

Id of the run.

Returns

kitaru.api_models.v1.experiment_run.ExperimentRunResponse

Stored experiment run.

funclist(self, params=None) -> Page[ExperimentRunResponse]

List experiment runs.

paramself

paramparamsExperimentRunListParams | None

= None

Experiment run list params.

Returns

kitaru.api_models.v1.base.Page

Page of experiment runs.

funciter(self, params=None) -> AsyncIterator[ExperimentRunResponse]

Iterate over all experiment runs.

paramself

paramparamsExperimentRunListParams | None

= None

Experiment run list params.

Returns

collections.abc.AsyncIterator

Async iterator over every experiment run.

funcdelete(self, experiment_run_id) -> None

Delete an experiment run and its jobs.

paramself

paramexperiment_run_iduuid.UUID

Id of the run.

Returns

None

funclist_jobs(self, experiment_run_id, params=None) -> Page[JobResponse]

List the jobs backing an experiment run's replays.

paramself

paramexperiment_run_iduuid.UUID

Id of the run.

paramparamsExperimentRunJobsListParams | None

= None

Experiment run jobs list params.

Returns

kitaru.api_models.v1.base.Page

Page of jobs.

funciter_jobs(self, experiment_run_id, params=None) -> AsyncIterator[JobResponse]

Iterate over all jobs backing an experiment run's replays.

paramself

paramexperiment_run_iduuid.UUID

Id of the run.

paramparamsExperimentRunJobsListParams | None

= None

Experiment run jobs list params.

Returns

collections.abc.AsyncIterator

Async iterator over every job of the run.

funccancel(self, experiment_run_id) -> ExperimentRunResponse

Request cancellation of a running experiment run.

paramself

paramexperiment_run_iduuid.UUID

Id of the run.

Returns

kitaru.api_models.v1.experiment_run.ExperimentRunResponse

Run carrying the cancel request.

Functions

On this page