CodeFlare SDK
Code Documentation:
codeflare_sdk
User Documentation:
Authentication via the CodeFlare SDK
Ray Cluster Configuration
Ray Cluster Interaction
Submitting RayJobs
Running e2e tests locally
S3 compatible storage with Ray Train examples
Basic Kueue Resources configuration
Heterogeneous Ray clusters with Kueue
Jupyter UI Widgets
CodeFlare SDK
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
A
active_deadline_seconds (codeflare_sdk.codeflare.JobOptions attribute)
add_file_volumes() (in module codeflare_sdk.ray.rayjobs.config)
add_queue_label() (in module codeflare_sdk.common.kueue.kueue)
(in module codeflare_sdk.ray.cluster.build_ray_cluster)
additional_worker_groups (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)
annotations (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)
apply() (codeflare_sdk.ray.cluster.cluster.Cluster method)
auth (codeflare_sdk.codeflare.SDKConfig attribute)
AuthConfig (class in codeflare_sdk.common.kubernetes_cluster)
Authentication (class in codeflare_sdk.common.kubernetes_cluster)
(class in codeflare_sdk.common.kubernetes_cluster.deprecated_auth)
B
build_basic_cluster() (codeflare_sdk.vendored.python_client.utils.kuberay_cluster_builder.Director method)
build_file_secret_spec() (in module codeflare_sdk.ray.rayjobs.config)
build_file_volume_specs() (in module codeflare_sdk.ray.rayjobs.config)
build_head() (codeflare_sdk.vendored.python_client.utils.kuberay_cluster_builder.ClusterBuilder method)
(codeflare_sdk.vendored.python_client.utils.kuberay_cluster_builder.IClusterBuilder static method)
build_head_container() (in module codeflare_sdk.ray.cluster.raycluster_spec)
build_large_cluster() (codeflare_sdk.vendored.python_client.utils.kuberay_cluster_builder.Director method)
build_medium_cluster() (codeflare_sdk.vendored.python_client.utils.kuberay_cluster_builder.Director method)
build_meta() (codeflare_sdk.vendored.python_client.utils.kuberay_cluster_builder.ClusterBuilder method)
(codeflare_sdk.vendored.python_client.utils.kuberay_cluster_builder.IClusterBuilder static method)
build_ray_cluster() (in module codeflare_sdk.ray.cluster.build_ray_cluster)
build_ray_cluster_spec() (in module codeflare_sdk.ray.rayjobs.config)
build_resource_requirements() (in module codeflare_sdk.ray.cluster.raycluster_spec)
build_small_cluster() (codeflare_sdk.vendored.python_client.utils.kuberay_cluster_builder.Director method)
build_worker() (codeflare_sdk.vendored.python_client.utils.kuberay_cluster_builder.ClusterBuilder method)
(codeflare_sdk.vendored.python_client.utils.kuberay_cluster_builder.IClusterBuilder static method)
build_worker_container() (in module codeflare_sdk.ray.cluster.raycluster_spec)
C
ca_cert (codeflare_sdk.common.kubernetes_cluster.AuthConfig attribute)
cleanup_expired_certificates() (in module codeflare_sdk.common.utils.generate_cert)
cleanup_old_certificates() (in module codeflare_sdk.common.utils.generate_cert)
cleanup_tls_cert() (in module codeflare_sdk.common.utils.generate_cert)
client (codeflare_sdk.codeflare.Codeflare property)
client_id (codeflare_sdk.common.kubernetes_cluster.AuthConfig attribute)
client_secret (codeflare_sdk.common.kubernetes_cluster.AuthConfig attribute)
Cluster (class in codeflare_sdk.ray.cluster.cluster)
cluster_apply_down_buttons() (in module codeflare_sdk.common.widgets.widgets)
cluster_dashboard_uri() (codeflare_sdk.ray.cluster.cluster.Cluster method)
cluster_name (codeflare_sdk.ray.rayjobs.status.RayJobInfo attribute)
cluster_uri() (codeflare_sdk.ray.cluster.cluster.Cluster method)
ClusterBuilder (class in codeflare_sdk.vendored.python_client.utils.kuberay_cluster_builder)
ClusterConfiguration (class in codeflare_sdk.ray.cluster.config)
ClusterHandler (class in codeflare_sdk.codeflare)
ClusterUtils (class in codeflare_sdk.vendored.python_client.utils.kuberay_cluster_utils)
Codeflare (class in codeflare_sdk.codeflare)
codeflare_sdk
module
codeflare_sdk.codeflare
module
codeflare_sdk.common
module
codeflare_sdk.common.kubernetes_cluster
module
codeflare_sdk.common.kubernetes_cluster.auth
module
codeflare_sdk.common.kubernetes_cluster.deprecated_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.constants
module
codeflare_sdk.common.utils.demos
module
codeflare_sdk.common.utils.generate_cert
module
codeflare_sdk.common.utils.k8s_utils
module
codeflare_sdk.common.utils.utils
module
codeflare_sdk.common.utils.validation
module
codeflare_sdk.common.widgets
module
codeflare_sdk.common.widgets.widgets
module
codeflare_sdk.ray
module
codeflare_sdk.ray.client
module
codeflare_sdk.ray.client.ray_jobs
module
codeflare_sdk.ray.cluster
module
codeflare_sdk.ray.cluster.build_ray_cluster
module
codeflare_sdk.ray.cluster.cluster
module
codeflare_sdk.ray.cluster.config
module
codeflare_sdk.ray.cluster.pretty_print
module
codeflare_sdk.ray.cluster.raycluster_spec
module
codeflare_sdk.ray.cluster.status
module
codeflare_sdk.ray.rayjobs
module
codeflare_sdk.ray.rayjobs.config
module
codeflare_sdk.ray.rayjobs.pretty_print
module
codeflare_sdk.ray.rayjobs.rayjob
module
codeflare_sdk.ray.rayjobs.runtime_env
module
codeflare_sdk.ray.rayjobs.status
module
codeflare_sdk.vendored
module
codeflare_sdk.vendored.python_client
module
codeflare_sdk.vendored.python_client.constants
module
codeflare_sdk.vendored.python_client.kuberay_cluster_api
module
codeflare_sdk.vendored.python_client.kuberay_job_api
module
codeflare_sdk.vendored.python_client.utils
module
codeflare_sdk.vendored.python_client.utils.kuberay_cluster_builder
module
codeflare_sdk.vendored.python_client.utils.kuberay_cluster_utils
module
CodeFlareClusterStatus (class in codeflare_sdk.ray.cluster.status)
CodeflareRayJobStatus (class in codeflare_sdk.ray.rayjobs.status)
COMPLETE (codeflare_sdk.ray.rayjobs.status.CodeflareRayJobStatus attribute)
(codeflare_sdk.ray.rayjobs.status.RayJobDeploymentStatus attribute)
config_check() (codeflare_sdk.ray.cluster.cluster.Cluster method)
(in module codeflare_sdk.common.kubernetes_cluster)
(in module codeflare_sdk.common.kubernetes_cluster.auth)
copy_demo_nbs() (in module codeflare_sdk.common.utils.demos)
cpu_limit_to_num_cpus() (in module codeflare_sdk.ray.cluster.raycluster_spec)
cpu_limits (codeflare_sdk.ray.cluster.config.WorkerGroup attribute)
(codeflare_sdk.ray.cluster.status.WorkerGroupStatus attribute)
cpu_requests (codeflare_sdk.ray.cluster.config.WorkerGroup attribute)
(codeflare_sdk.ray.cluster.status.WorkerGroupStatus attribute)
create() (codeflare_sdk.codeflare.ClusterHandler method)
(codeflare_sdk.codeflare.JobHandler method)
create_file_secret() (in module codeflare_sdk.ray.rayjobs.runtime_env)
create_ray_cluster() (codeflare_sdk.vendored.python_client.kuberay_cluster_api.RayClusterApi method)
create_resource() (codeflare_sdk.ray.cluster.cluster.Cluster method)
create_secret_from_spec() (in module codeflare_sdk.ray.rayjobs.runtime_env)
D
dashboard (codeflare_sdk.ray.cluster.status.RayCluster attribute)
delete() (codeflare_sdk.ray.rayjobs.rayjob.RayJob method)
delete_job() (codeflare_sdk.ray.client.ray_jobs.RayJobClient method)
(codeflare_sdk.vendored.python_client.kuberay_job_api.RayjobApi method)
delete_ray_cluster() (codeflare_sdk.vendored.python_client.kuberay_cluster_api.RayClusterApi method)
delete_worker_group() (codeflare_sdk.vendored.python_client.utils.kuberay_cluster_utils.ClusterUtils method)
details() (codeflare_sdk.ray.cluster.cluster.Cluster method)
Director (class in codeflare_sdk.vendored.python_client.utils.kuberay_cluster_builder)
display_widgets() (codeflare_sdk.common.widgets.widgets.RayClusterManagerWidgets method)
down() (codeflare_sdk.ray.cluster.cluster.Cluster method)
duplicate_worker_group() (codeflare_sdk.vendored.python_client.utils.kuberay_cluster_utils.ClusterUtils method)
E
enable_autoscaling (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)
enable_gcs_ft (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)
enable_usage_stats (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)
end_time (codeflare_sdk.ray.rayjobs.status.RayJobInfo attribute)
env_vars() (in module codeflare_sdk.ray.cluster.raycluster_spec)
envs (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)
(codeflare_sdk.ray.cluster.config.WorkerGroup attribute)
export_env() (in module codeflare_sdk.common.utils.generate_cert)
extended_resource_limits (codeflare_sdk.ray.cluster.status.WorkerGroupStatus attribute)
extended_resource_mapping (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)
extended_resource_requests (codeflare_sdk.ray.cluster.config.WorkerGroup attribute)
extended_resources() (in module codeflare_sdk.ray.cluster.raycluster_spec)
external_storage_namespace (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)
extract_all_local_files() (in module codeflare_sdk.ray.rayjobs.runtime_env)
extract_ray_version_from_image() (in module codeflare_sdk.common.utils.validation)
F
FAILED (codeflare_sdk.ray.cluster.status.CodeFlareClusterStatus attribute)
(codeflare_sdk.ray.cluster.status.RayClusterStatus attribute)
(codeflare_sdk.ray.rayjobs.status.CodeflareRayJobStatus attribute)
(codeflare_sdk.ray.rayjobs.status.RayJobDeploymentStatus attribute)
failed_attempts (codeflare_sdk.ray.rayjobs.status.RayJobInfo attribute)
format_resources_param() (in module codeflare_sdk.ray.cluster.raycluster_spec)
from_dict() (codeflare_sdk.common.kubernetes_cluster.AuthConfig class method)
G
gcs_fault_tolerance_options() (in module codeflare_sdk.ray.cluster.raycluster_spec)
gen_names() (in module codeflare_sdk.ray.cluster.build_ray_cluster)
generate_ca_cert() (in module codeflare_sdk.common.utils.generate_cert)
generate_env_vars() (in module codeflare_sdk.ray.cluster.build_ray_cluster)
generate_image_pull_secrets() (in module codeflare_sdk.ray.cluster.build_ray_cluster)
generate_tls_cert() (in module codeflare_sdk.common.utils.generate_cert)
get() (codeflare_sdk.codeflare.ClusterHandler method)
get_address() (codeflare_sdk.ray.client.ray_jobs.RayJobClient method)
get_api_client() (in module codeflare_sdk.common.kubernetes_cluster)
(in module codeflare_sdk.common.kubernetes_cluster.auth)
get_cluster() (codeflare_sdk.vendored.python_client.utils.kuberay_cluster_builder.ClusterBuilder method)
(codeflare_sdk.vendored.python_client.utils.kuberay_cluster_builder.IClusterBuilder static method)
(in module codeflare_sdk.ray.cluster.cluster)
get_current_namespace() (in module codeflare_sdk.common.utils)
(in module codeflare_sdk.common.utils.k8s_utils)
get_default_kueue_name() (in module codeflare_sdk.common.kueue.kueue)
get_default_local_queue() (in module codeflare_sdk.ray.cluster.build_ray_cluster)
get_dynamic_client() (codeflare_sdk.ray.cluster.cluster.Cluster method)
get_head_container_spec() (in module codeflare_sdk.ray.cluster.build_ray_cluster)
get_job() (codeflare_sdk.vendored.python_client.kuberay_job_api.RayjobApi method)
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)
(codeflare_sdk.vendored.python_client.kuberay_job_api.RayjobApi method)
get_k8s_client() (in module codeflare_sdk.common.kubernetes_cluster)
get_kueue_operator_version() (in module codeflare_sdk.common.kueue.kueue)
get_labels() (in module codeflare_sdk.ray.cluster.build_ray_cluster)
get_metadata() (in module codeflare_sdk.ray.cluster.build_ray_cluster)
get_pod_spec() (in module codeflare_sdk.ray.cluster.build_ray_cluster)
get_ray_cluster() (codeflare_sdk.vendored.python_client.kuberay_cluster_api.RayClusterApi method)
get_ray_cluster_status() (codeflare_sdk.vendored.python_client.kuberay_cluster_api.RayClusterApi method)
get_ray_image_for_python_version() (in module codeflare_sdk.common.utils.utils)
get_secret_name() (in module codeflare_sdk.common.utils.generate_cert)
get_worker_container_spec() (in module codeflare_sdk.ray.cluster.build_ray_cluster)
gpu_count (codeflare_sdk.ray.cluster.config.WorkerGroup attribute)
gpu_counts() (in module codeflare_sdk.ray.cluster.raycluster_spec)
gpu_type (codeflare_sdk.ray.cluster.config.WorkerGroup attribute)
group_name (codeflare_sdk.ray.cluster.config.WorkerGroup attribute)
(codeflare_sdk.ray.cluster.status.WorkerGroupStatus attribute)
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_extended_resource_requests (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)
head_extended_resources (codeflare_sdk.ray.cluster.status.RayCluster attribute)
head_mem_limits (codeflare_sdk.ray.cluster.status.RayCluster attribute)
head_mem_requests (codeflare_sdk.ray.cluster.status.RayCluster attribute)
head_memory_limits (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)
head_memory_requests (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)
head_tolerations (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)
head_worker_extended_resources_from_cluster() (in module codeflare_sdk.ray.cluster.build_ray_cluster)
head_worker_gpu_count_from_cluster() (in module codeflare_sdk.ray.cluster.build_ray_cluster)
I
IClusterBuilder (class in codeflare_sdk.vendored.python_client.utils.kuberay_cluster_builder)
image (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)
(codeflare_sdk.ray.cluster.config.WorkerGroup attribute)
image_pull_secrets (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)
image_pull_secrets() (in module codeflare_sdk.ray.cluster.raycluster_spec)
is_dashboard_ready() (codeflare_sdk.ray.cluster.cluster.Cluster method)
is_notebook() (in module codeflare_sdk.common.widgets.widgets)
is_rhoai_kueue_managed() (in module codeflare_sdk.common.kueue.kueue)
is_valid_label() (codeflare_sdk.vendored.python_client.utils.kuberay_cluster_utils.ClusterUtils method)
is_valid_name() (codeflare_sdk.vendored.python_client.utils.kuberay_cluster_utils.ClusterUtils method)
J
job_client (codeflare_sdk.ray.cluster.cluster.Cluster property)
job_id (codeflare_sdk.ray.rayjobs.status.RayJobInfo attribute)
job_logs() (codeflare_sdk.ray.cluster.cluster.Cluster method)
job_status() (codeflare_sdk.ray.cluster.cluster.Cluster method)
JobHandler (class in codeflare_sdk.codeflare)
JobOptions (class in codeflare_sdk.codeflare)
K
k8s_api_host (codeflare_sdk.common.kubernetes_cluster.AuthConfig attribute)
kubeconfig_path (codeflare_sdk.common.kubernetes_cluster.AuthConfig attribute)
KubeConfigFileAuthentication (class in codeflare_sdk.common.kubernetes_cluster)
(class in codeflare_sdk.common.kubernetes_cluster.deprecated_auth)
KubeConfiguration (class in codeflare_sdk.common.kubernetes_cluster)
(class in codeflare_sdk.common.kubernetes_cluster.deprecated_auth)
kueue_supports_elastic_workloads() (in module codeflare_sdk.common.kueue.kueue)
L
labels (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)
(codeflare_sdk.ray.cluster.config.WorkerGroup attribute)
list() (codeflare_sdk.codeflare.ClusterHandler method)
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)
(codeflare_sdk.vendored.python_client.kuberay_job_api.RayjobApi method)
list_local_queues() (in module codeflare_sdk.common.kueue.kueue)
list_queued() (codeflare_sdk.codeflare.ClusterHandler method)
list_ray_clusters() (codeflare_sdk.vendored.python_client.kuberay_cluster_api.RayClusterApi method)
list_tls_certificates() (in module codeflare_sdk.common.utils.generate_cert)
load_kube_config() (codeflare_sdk.common.kubernetes_cluster.deprecated_auth.KubeConfigFileAuthentication method)
(codeflare_sdk.common.kubernetes_cluster.deprecated_auth.KubeConfiguration method)
(codeflare_sdk.common.kubernetes_cluster.KubeConfigFileAuthentication method)
(codeflare_sdk.common.kubernetes_cluster.KubeConfiguration method)
local_client_url() (codeflare_sdk.ray.cluster.cluster.Cluster method)
local_queue (codeflare_sdk.codeflare.JobOptions attribute)
(codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)
local_queue_exists() (in module codeflare_sdk.common.kueue.kueue)
(in module codeflare_sdk.ray.cluster.build_ray_cluster)
log_level (codeflare_sdk.codeflare.SDKConfig attribute)
login() (codeflare_sdk.common.kubernetes_cluster.Authentication method)
(codeflare_sdk.common.kubernetes_cluster.deprecated_auth.Authentication method)
(codeflare_sdk.common.kubernetes_cluster.deprecated_auth.TokenAuthentication method)
(codeflare_sdk.common.kubernetes_cluster.TokenAuthentication method)
logout() (codeflare_sdk.common.kubernetes_cluster.Authentication method)
(codeflare_sdk.common.kubernetes_cluster.deprecated_auth.Authentication method)
(codeflare_sdk.common.kubernetes_cluster.deprecated_auth.KubeConfigFileAuthentication method)
(codeflare_sdk.common.kubernetes_cluster.deprecated_auth.KubeConfiguration method)
(codeflare_sdk.common.kubernetes_cluster.deprecated_auth.TokenAuthentication method)
(codeflare_sdk.common.kubernetes_cluster.KubeConfigFileAuthentication method)
(codeflare_sdk.common.kubernetes_cluster.KubeConfiguration method)
(codeflare_sdk.common.kubernetes_cluster.TokenAuthentication method)
M
max_replicas (codeflare_sdk.ray.cluster.config.WorkerGroup attribute)
(codeflare_sdk.ray.cluster.status.WorkerGroupStatus attribute)
max_workers (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)
memory_limits (codeflare_sdk.ray.cluster.config.WorkerGroup attribute)
(codeflare_sdk.ray.cluster.status.WorkerGroupStatus attribute)
memory_requests (codeflare_sdk.ray.cluster.config.WorkerGroup attribute)
(codeflare_sdk.ray.cluster.status.WorkerGroupStatus attribute)
merge_storage() (in module codeflare_sdk.ray.cluster.raycluster_spec)
method (codeflare_sdk.common.kubernetes_cluster.AuthConfig attribute)
min_replicas (codeflare_sdk.ray.cluster.config.WorkerGroup attribute)
(codeflare_sdk.ray.cluster.status.WorkerGroupStatus attribute)
min_workers (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)
module
codeflare_sdk
codeflare_sdk.codeflare
codeflare_sdk.common
codeflare_sdk.common.kubernetes_cluster
codeflare_sdk.common.kubernetes_cluster.auth
codeflare_sdk.common.kubernetes_cluster.deprecated_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.constants
codeflare_sdk.common.utils.demos
codeflare_sdk.common.utils.generate_cert
codeflare_sdk.common.utils.k8s_utils
codeflare_sdk.common.utils.utils
codeflare_sdk.common.utils.validation
codeflare_sdk.common.widgets
codeflare_sdk.common.widgets.widgets
codeflare_sdk.ray
codeflare_sdk.ray.client
codeflare_sdk.ray.client.ray_jobs
codeflare_sdk.ray.cluster
codeflare_sdk.ray.cluster.build_ray_cluster
codeflare_sdk.ray.cluster.cluster
codeflare_sdk.ray.cluster.config
codeflare_sdk.ray.cluster.pretty_print
codeflare_sdk.ray.cluster.raycluster_spec
codeflare_sdk.ray.cluster.status
codeflare_sdk.ray.rayjobs
codeflare_sdk.ray.rayjobs.config
codeflare_sdk.ray.rayjobs.pretty_print
codeflare_sdk.ray.rayjobs.rayjob
codeflare_sdk.ray.rayjobs.runtime_env
codeflare_sdk.ray.rayjobs.status
codeflare_sdk.vendored
codeflare_sdk.vendored.python_client
codeflare_sdk.vendored.python_client.constants
codeflare_sdk.vendored.python_client.kuberay_cluster_api
codeflare_sdk.vendored.python_client.kuberay_job_api
codeflare_sdk.vendored.python_client.utils
codeflare_sdk.vendored.python_client.utils.kuberay_cluster_builder
codeflare_sdk.vendored.python_client.utils.kuberay_cluster_utils
N
name (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)
(codeflare_sdk.ray.cluster.status.RayCluster attribute)
(codeflare_sdk.ray.rayjobs.status.RayJobInfo attribute)
namespace (codeflare_sdk.codeflare.SDKConfig attribute)
(codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)
(codeflare_sdk.ray.cluster.status.RayCluster attribute)
(codeflare_sdk.ray.rayjobs.status.RayJobInfo attribute)
num_workers (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)
(codeflare_sdk.ray.cluster.status.RayCluster attribute)
O
oidc_callback_port (codeflare_sdk.common.kubernetes_cluster.AuthConfig attribute)
oidc_issuer (codeflare_sdk.common.kubernetes_cluster.AuthConfig attribute)
overwrite_default_resource_mapping (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)
P
parse_requirements_file() (in module codeflare_sdk.ray.rayjobs.runtime_env)
patch_ray_cluster() (codeflare_sdk.vendored.python_client.kuberay_cluster_api.RayClusterApi method)
populate_meta() (codeflare_sdk.vendored.python_client.utils.kuberay_cluster_utils.ClusterUtils method)
populate_ray_head() (codeflare_sdk.vendored.python_client.utils.kuberay_cluster_utils.ClusterUtils method)
populate_worker_group() (codeflare_sdk.vendored.python_client.utils.kuberay_cluster_utils.ClusterUtils method)
print_cluster_status() (in module codeflare_sdk.ray.cluster.pretty_print)
print_clusters() (in module codeflare_sdk.ray.cluster.pretty_print)
print_job_status() (in module codeflare_sdk.ray.rayjobs.pretty_print)
print_no_job_found() (in module codeflare_sdk.ray.rayjobs.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)
priority_class (codeflare_sdk.codeflare.JobOptions attribute)
priority_class_exists() (in module codeflare_sdk.common.kueue.kueue)
process_pip_dependencies() (in module codeflare_sdk.ray.rayjobs.runtime_env)
process_runtime_env() (in module codeflare_sdk.ray.rayjobs.runtime_env)
Q
QUEUED (codeflare_sdk.ray.cluster.status.CodeFlareClusterStatus attribute)
QUEUEING (codeflare_sdk.ray.cluster.status.CodeFlareClusterStatus attribute)
R
RAY_VERSION (in module codeflare_sdk.common.utils.constants)
RayCluster (class in codeflare_sdk.ray.cluster.status)
RayClusterApi (class in codeflare_sdk.vendored.python_client.kuberay_cluster_api)
RayClusterManagerWidgets (class in codeflare_sdk.common.widgets.widgets)
RayClusterStatus (class in codeflare_sdk.ray.cluster.status)
RayJob (class in codeflare_sdk.ray.rayjobs.rayjob)
RayjobApi (class in codeflare_sdk.vendored.python_client.kuberay_job_api)
RayJobClient (class in codeflare_sdk.ray.client.ray_jobs)
RayJobDeploymentStatus (class in codeflare_sdk.ray.rayjobs.status)
RayJobInfo (class in codeflare_sdk.ray.rayjobs.status)
READY (codeflare_sdk.ray.cluster.status.CodeFlareClusterStatus attribute)
(codeflare_sdk.ray.cluster.status.RayClusterStatus attribute)
redis_address (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)
redis_password_secret (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)
refresh_certificates() (codeflare_sdk.ray.cluster.cluster.Cluster method)
refresh_tls_cert() (in module codeflare_sdk.common.utils.generate_cert)
remove_autogenerated_fields() (in module codeflare_sdk.ray.cluster.cluster)
replicas (codeflare_sdk.ray.cluster.config.WorkerGroup attribute)
(codeflare_sdk.ray.cluster.status.WorkerGroupStatus attribute)
resubmit() (codeflare_sdk.ray.rayjobs.rayjob.RayJob method)
resubmit_job() (codeflare_sdk.vendored.python_client.kuberay_job_api.RayjobApi method)
RUNNING (codeflare_sdk.ray.rayjobs.status.CodeflareRayJobStatus attribute)
(codeflare_sdk.ray.rayjobs.status.RayJobDeploymentStatus attribute)
runtime_env (codeflare_sdk.codeflare.JobOptions attribute)
S
scopes (codeflare_sdk.common.kubernetes_cluster.AuthConfig attribute)
SDKConfig (class in codeflare_sdk.codeflare)
set_api_client() (in module codeflare_sdk.common.kubernetes_cluster)
(in module codeflare_sdk.common.kubernetes_cluster.auth)
start_time (codeflare_sdk.ray.rayjobs.status.RayJobInfo attribute)
STARTING (codeflare_sdk.ray.cluster.status.CodeFlareClusterStatus attribute)
status (codeflare_sdk.ray.cluster.status.RayCluster attribute)
(codeflare_sdk.ray.rayjobs.status.RayJobInfo attribute)
status() (codeflare_sdk.ray.cluster.cluster.Cluster method)
(codeflare_sdk.ray.rayjobs.rayjob.RayJob method)
stop() (codeflare_sdk.ray.rayjobs.rayjob.RayJob method)
stop_job() (codeflare_sdk.ray.client.ray_jobs.RayJobClient method)
submit() (codeflare_sdk.codeflare.JobHandler method)
(codeflare_sdk.ray.rayjobs.rayjob.RayJob method)
submit_job() (codeflare_sdk.ray.client.ray_jobs.RayJobClient method)
(codeflare_sdk.vendored.python_client.kuberay_job_api.RayjobApi method)
succeeded_attempts (codeflare_sdk.ray.rayjobs.status.RayJobInfo attribute)
suspend_job() (codeflare_sdk.vendored.python_client.kuberay_job_api.RayjobApi method)
SUSPENDED (codeflare_sdk.ray.cluster.status.CodeFlareClusterStatus attribute)
(codeflare_sdk.ray.cluster.status.RayClusterStatus attribute)
(codeflare_sdk.ray.rayjobs.status.CodeflareRayJobStatus attribute)
(codeflare_sdk.ray.rayjobs.status.RayJobDeploymentStatus attribute)
T
tail_job_logs() (codeflare_sdk.ray.client.ray_jobs.RayJobClient method)
token (codeflare_sdk.common.kubernetes_cluster.AuthConfig attribute)
TokenAuthentication (class in codeflare_sdk.common.kubernetes_cluster)
(class in codeflare_sdk.common.kubernetes_cluster.deprecated_auth)
tolerations (codeflare_sdk.ray.cluster.config.WorkerGroup attribute)
ttl_seconds_after_finished (codeflare_sdk.codeflare.JobOptions attribute)
U
UNHEALTHY (codeflare_sdk.ray.cluster.status.RayClusterStatus attribute)
UNKNOWN (codeflare_sdk.ray.cluster.status.CodeFlareClusterStatus attribute)
(codeflare_sdk.ray.cluster.status.RayClusterStatus attribute)
(codeflare_sdk.ray.rayjobs.status.CodeflareRayJobStatus attribute)
(codeflare_sdk.ray.rayjobs.status.RayJobDeploymentStatus attribute)
up() (codeflare_sdk.ray.cluster.cluster.Cluster method)
update_image() (in module codeflare_sdk.common.utils.utils)
update_worker_group_replicas() (codeflare_sdk.vendored.python_client.utils.kuberay_cluster_utils.ClusterUtils method)
update_worker_group_resources() (codeflare_sdk.vendored.python_client.utils.kuberay_cluster_utils.ClusterUtils method)
use_device_flow (codeflare_sdk.common.kubernetes_cluster.AuthConfig attribute)
use_keyring (codeflare_sdk.common.kubernetes_cluster.AuthConfig attribute)
V
validate_autoscaling_with_kueue() (in module codeflare_sdk.common.kueue.kueue)
validate_ray_version_compatibility() (in module codeflare_sdk.common.utils.validation)
validate_secret_size() (in module codeflare_sdk.ray.rayjobs.config)
verify_ssl (codeflare_sdk.common.kubernetes_cluster.AuthConfig attribute)
verify_tls (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)
view_clusters() (in module codeflare_sdk.common.widgets.widgets)
volume_mounts (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)
volumes (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)
W
wait_ready() (codeflare_sdk.ray.cluster.cluster.Cluster method)
wait_until_job_finished() (codeflare_sdk.vendored.python_client.kuberay_job_api.RayjobApi method)
wait_until_job_running() (codeflare_sdk.vendored.python_client.kuberay_job_api.RayjobApi method)
wait_until_ray_cluster_running() (codeflare_sdk.vendored.python_client.kuberay_cluster_api.RayClusterApi method)
with_nb_annotations() (in module codeflare_sdk.ray.cluster.build_ray_cluster)
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_groups (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)
worker_replica_counts() (in module codeflare_sdk.ray.cluster.raycluster_spec)
worker_tolerations (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)
WorkerGroup (class in codeflare_sdk.ray.cluster.config)
WorkerGroupStatus (class in codeflare_sdk.ray.cluster.status)
write_to_file (codeflare_sdk.ray.cluster.config.ClusterConfiguration attribute)
write_to_file() (in module codeflare_sdk.ray.cluster.build_ray_cluster)