Index

A

add_queue_label() (in module codeflare_sdk.common.kueue.kueue) AppWrapper (class in codeflare_sdk.ray.appwrapper.status) appwrapper (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)

AppWrapperStatus (class in codeflare_sdk.ray.appwrapper.status) augment_labels() (in module codeflare_sdk.ray.cluster.generate_yaml) Authentication (class in codeflare_sdk.common.kubernetes_cluster.auth) AWManager (class in codeflare_sdk.ray.appwrapper.awload)

C

Cluster (class in codeflare_sdk.ray.cluster.cluster) cluster_dashboard_uri() (codeflare_sdk.ray.cluster.cluster.Cluster method) cluster_up_down_buttons() (in module codeflare_sdk.common.widgets.widgets) cluster_uri() (codeflare_sdk.ray.cluster.cluster.Cluster method) ClusterConfiguration (class in codeflare_sdk.ray.cluster.config) codeflare_sdk module codeflare_sdk.common module codeflare_sdk.common.kubernetes_cluster module codeflare_sdk.common.kubernetes_cluster.auth module codeflare_sdk.common.kubernetes_cluster.kube_api_helpers module codeflare_sdk.common.kueue module codeflare_sdk.common.kueue.kueue module codeflare_sdk.common.utils module codeflare_sdk.common.utils.demos module codeflare_sdk.common.utils.generate_cert module codeflare_sdk.common.widgets module codeflare_sdk.common.widgets.widgets module

codeflare_sdk.ray module codeflare_sdk.ray.appwrapper module codeflare_sdk.ray.appwrapper.awload module codeflare_sdk.ray.appwrapper.status module codeflare_sdk.ray.client module codeflare_sdk.ray.client.ray_jobs module codeflare_sdk.ray.cluster module codeflare_sdk.ray.cluster.cluster module codeflare_sdk.ray.cluster.config module codeflare_sdk.ray.cluster.generate_yaml module codeflare_sdk.ray.cluster.pretty_print module codeflare_sdk.ray.cluster.status module CodeFlareClusterStatus (class in codeflare_sdk.ray.cluster.status) config_check() (in module codeflare_sdk.common.kubernetes_cluster.auth) copy_demo_nbs() (in module codeflare_sdk.common.utils.demos) create_app_wrapper() (codeflare_sdk.ray.cluster.cluster.Cluster method)

D

dashboard (codeflare_sdk.ray.cluster.status.RayCluster attribute) del_from_list_by_name() (in module codeflare_sdk.ray.cluster.generate_yaml) delete_job() (codeflare_sdk.ray.client.ray_jobs.RayJobClient method)

details() (codeflare_sdk.ray.cluster.cluster.Cluster method) display_widgets() (codeflare_sdk.common.widgets.widgets.RayClusterManagerWidgets method) down() (codeflare_sdk.ray.cluster.cluster.Cluster method)

E

envs (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)

export_env() (in module codeflare_sdk.common.utils.generate_cert) extended_resource_mapping (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)

F

FAILED (codeflare_sdk.ray.appwrapper.status.AppWrapperStatus attribute) (codeflare_sdk.ray.cluster.status.CodeFlareClusterStatus attribute) (codeflare_sdk.ray.cluster.status.RayClusterStatus attribute)

from_k8_cluster_object() (codeflare_sdk.ray.cluster.cluster.Cluster method)

G

gen_names() (in module codeflare_sdk.ray.cluster.generate_yaml) generate_appwrapper() (in module codeflare_sdk.ray.cluster.generate_yaml) generate_ca_cert() (in module codeflare_sdk.common.utils.generate_cert) generate_tls_cert() (in module codeflare_sdk.common.utils.generate_cert) get_address() (codeflare_sdk.ray.client.ray_jobs.RayJobClient method) get_api_client() (in module codeflare_sdk.common.kubernetes_cluster.auth)

get_cluster() (in module codeflare_sdk.ray.cluster.cluster) get_current_namespace() (in module codeflare_sdk.ray.cluster.cluster) get_default_kueue_name() (in module codeflare_sdk.common.kueue.kueue) get_job_info() (codeflare_sdk.ray.client.ray_jobs.RayJobClient method) get_job_logs() (codeflare_sdk.ray.client.ray_jobs.RayJobClient method) get_job_status() (codeflare_sdk.ray.client.ray_jobs.RayJobClient method) get_secret_name() (in module codeflare_sdk.common.utils.generate_cert)

H

head_cpu_limits (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute) (codeflare_sdk.ray.cluster.status.RayCluster attribute) head_cpu_requests (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute) (codeflare_sdk.ray.cluster.status.RayCluster attribute) head_cpus (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute) head_extended_resource_requests (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute) head_extended_resources (codeflare_sdk.ray.cluster.status.RayCluster attribute) head_gpus (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)

head_info (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute) head_mem_limits (codeflare_sdk.ray.cluster.status.RayCluster attribute) head_mem_requests (codeflare_sdk.ray.cluster.status.RayCluster attribute) head_memory (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute) head_memory_limits (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute) head_memory_requests (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute) head_worker_gpu_count_from_cluster() (in module codeflare_sdk.ray.cluster.generate_yaml) head_worker_resources_from_cluster() (in module codeflare_sdk.ray.cluster.generate_yaml)

I

image (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute) image_pull_secrets (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute) is_dashboard_ready() (codeflare_sdk.ray.cluster.cluster.Cluster method)

is_kind_cluster() (in module codeflare_sdk.ray.cluster.generate_yaml) is_notebook() (in module codeflare_sdk.common.widgets.widgets) is_openshift_cluster() (in module codeflare_sdk.ray.cluster.generate_yaml)

J

job_client (codeflare_sdk.ray.cluster.cluster.Cluster property)

job_logs() (codeflare_sdk.ray.cluster.cluster.Cluster method) job_status() (codeflare_sdk.ray.cluster.cluster.Cluster method)

K

KubeConfigFileAuthentication (class in codeflare_sdk.common.kubernetes_cluster.auth)

KubeConfiguration (class in codeflare_sdk.common.kubernetes_cluster.auth)

L

labels (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute) list_all_clusters() (in module codeflare_sdk.ray.cluster.cluster) list_all_queued() (in module codeflare_sdk.ray.cluster.cluster) list_jobs() (codeflare_sdk.ray.client.ray_jobs.RayJobClient method) (codeflare_sdk.ray.cluster.cluster.Cluster method) load_kube_config() (codeflare_sdk.common.kubernetes_cluster.auth.KubeConfigFileAuthentication method) (codeflare_sdk.common.kubernetes_cluster.auth.KubeConfiguration method)

local_client_url() (codeflare_sdk.ray.cluster.cluster.Cluster method) local_queue (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute) local_queue_exists() (in module codeflare_sdk.common.kueue.kueue) login() (codeflare_sdk.common.kubernetes_cluster.auth.Authentication method) (codeflare_sdk.common.kubernetes_cluster.auth.TokenAuthentication method) logout() (codeflare_sdk.common.kubernetes_cluster.auth.Authentication method) (codeflare_sdk.common.kubernetes_cluster.auth.KubeConfiguration method) (codeflare_sdk.common.kubernetes_cluster.auth.TokenAuthentication method)

M

machine_types (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute) max_cpus (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute) max_memory (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute) min_cpus (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute) min_memory (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute) module codeflare_sdk codeflare_sdk.common codeflare_sdk.common.kubernetes_cluster codeflare_sdk.common.kubernetes_cluster.auth codeflare_sdk.common.kubernetes_cluster.kube_api_helpers codeflare_sdk.common.kueue codeflare_sdk.common.kueue.kueue codeflare_sdk.common.utils codeflare_sdk.common.utils.demos codeflare_sdk.common.utils.generate_cert codeflare_sdk.common.widgets codeflare_sdk.common.widgets.widgets codeflare_sdk.ray codeflare_sdk.ray.appwrapper codeflare_sdk.ray.appwrapper.awload codeflare_sdk.ray.appwrapper.status codeflare_sdk.ray.client codeflare_sdk.ray.client.ray_jobs codeflare_sdk.ray.cluster codeflare_sdk.ray.cluster.cluster codeflare_sdk.ray.cluster.config codeflare_sdk.ray.cluster.generate_yaml codeflare_sdk.ray.cluster.pretty_print codeflare_sdk.ray.cluster.status

N

name (codeflare_sdk.ray.appwrapper.status.AppWrapper attribute) (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute) (codeflare_sdk.ray.cluster.status.RayCluster attribute) namespace (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute) (codeflare_sdk.ray.cluster.status.RayCluster attribute)

notebook_annotations() (in module codeflare_sdk.ray.cluster.generate_yaml) num_gpus (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute) num_workers (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute) (codeflare_sdk.ray.cluster.status.RayCluster attribute)

O

overwrite_default_resource_mapping (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)

P

print_app_wrappers_status() (in module codeflare_sdk.ray.cluster.pretty_print) print_cluster_status() (in module codeflare_sdk.ray.cluster.pretty_print)

print_clusters() (in module codeflare_sdk.ray.cluster.pretty_print) print_no_resources_found() (in module codeflare_sdk.ray.cluster.pretty_print) print_ray_clusters_status() (in module codeflare_sdk.ray.cluster.pretty_print)

Q

QUEUED (codeflare_sdk.ray.cluster.status.CodeFlareClusterStatus attribute)

QUEUEING (codeflare_sdk.ray.cluster.status.CodeFlareClusterStatus attribute)

R

RayCluster (class in codeflare_sdk.ray.cluster.status) RayClusterManagerWidgets (class in codeflare_sdk.common.widgets.widgets) RayClusterStatus (class in codeflare_sdk.ray.cluster.status) RayJobClient (class in codeflare_sdk.ray.client.ray_jobs) read_template() (in module codeflare_sdk.ray.cluster.generate_yaml)

READY (codeflare_sdk.ray.cluster.status.CodeFlareClusterStatus attribute) (codeflare_sdk.ray.cluster.status.RayClusterStatus attribute) remove() (codeflare_sdk.ray.appwrapper.awload.AWManager method) RESETTING (codeflare_sdk.ray.appwrapper.status.AppWrapperStatus attribute) RESUMING (codeflare_sdk.ray.appwrapper.status.AppWrapperStatus attribute) RUNNING (codeflare_sdk.ray.appwrapper.status.AppWrapperStatus attribute)

S

STARTING (codeflare_sdk.ray.cluster.status.CodeFlareClusterStatus attribute) status (codeflare_sdk.ray.appwrapper.status.AppWrapper attribute) (codeflare_sdk.ray.cluster.status.RayCluster attribute) status() (codeflare_sdk.ray.cluster.cluster.Cluster method) stop_job() (codeflare_sdk.ray.client.ray_jobs.RayJobClient method) submit() (codeflare_sdk.ray.appwrapper.awload.AWManager method)

submit_job() (codeflare_sdk.ray.client.ray_jobs.RayJobClient method) SUCCEEDED (codeflare_sdk.ray.appwrapper.status.AppWrapperStatus attribute) SUSPENDED (codeflare_sdk.ray.appwrapper.status.AppWrapperStatus attribute) (codeflare_sdk.ray.cluster.status.CodeFlareClusterStatus attribute) (codeflare_sdk.ray.cluster.status.RayClusterStatus attribute) SUSPENDING (codeflare_sdk.ray.appwrapper.status.AppWrapperStatus attribute)

T

tail_job_logs() (codeflare_sdk.ray.client.ray_jobs.RayJobClient method) template (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)

TERMINATING (codeflare_sdk.ray.appwrapper.status.AppWrapperStatus attribute) TokenAuthentication (class in codeflare_sdk.common.kubernetes_cluster.auth)

U

UNHEALTHY (codeflare_sdk.ray.cluster.status.RayClusterStatus attribute) UNKNOWN (codeflare_sdk.ray.cluster.status.CodeFlareClusterStatus attribute) (codeflare_sdk.ray.cluster.status.RayClusterStatus attribute) up() (codeflare_sdk.ray.cluster.cluster.Cluster method) update_env() (in module codeflare_sdk.ray.cluster.generate_yaml)

update_image() (in module codeflare_sdk.ray.cluster.generate_yaml) update_image_pull_secrets() (in module codeflare_sdk.ray.cluster.generate_yaml) update_names() (in module codeflare_sdk.ray.cluster.generate_yaml) update_nodes() (in module codeflare_sdk.ray.cluster.generate_yaml) update_resources() (in module codeflare_sdk.ray.cluster.generate_yaml)

V

verify_tls (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)

view_clusters() (in module codeflare_sdk.common.widgets.widgets)

W

wait_ready() (codeflare_sdk.ray.cluster.cluster.Cluster method) worker_cpu_limits (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute) (codeflare_sdk.ray.cluster.status.RayCluster attribute) worker_cpu_requests (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute) (codeflare_sdk.ray.cluster.status.RayCluster attribute) worker_extended_resource_requests (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute) worker_extended_resources (codeflare_sdk.ray.cluster.status.RayCluster attribute)

worker_mem_limits (codeflare_sdk.ray.cluster.status.RayCluster attribute) worker_mem_requests (codeflare_sdk.ray.cluster.status.RayCluster attribute) worker_memory_limits (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute) worker_memory_requests (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute) wrap_cluster() (in module codeflare_sdk.ray.cluster.generate_yaml) write_to_file (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute) write_user_yaml() (in module codeflare_sdk.ray.cluster.generate_yaml)