qiskit_serverless.core.RayClient

class RayClient(host)[source]

RayClient.

Ray client

Parameters:

host (str) – ray head node host

Example

>>> ray_provider = RayClient("http://localhost:8265")
__init__(host)[source]

Ray client

Parameters:

host (str) – ray head node host

Example

>>> ray_provider = RayClient("http://localhost:8265")

Methods

__init__(host)

Ray client

filtered_logs(job_id, **kwargs)

Return filtered logs.

from_dict(dictionary)

Converts dict to object.

function(title[, provider])

Returns program based on parameters.

functions(**kwargs)

Returns list of available programs.

get(title[, provider])

Returns program based on parameters.

get_job_by_id(job_id)

Returns job by job id.

get_jobs(**kwargs)

Return list of jobs.

job(job_id)

Returns job by job id.

jobs(**kwargs)

Return list of jobs.

list(**kwargs)

Returns list of available programs.

logs(job_id)

Return logs.

result(job_id)

Return results.

run(program[, arguments, config])

Run a function and return its job.

status(job_id)

Check status.

stop(job_id[, service])

Stops job/program.

to_dict()

Converts class to dict.

upload(program)

Uploads program.

widget()

Widget for information about provider and jobs.