codeflare_sdk.ray package

Subpackages

• codeflare_sdk.ray.appwrapper package
  • Submodules
  • codeflare_sdk.ray.appwrapper.awload module
    • AWManager
      • AWManager.remove()
      • AWManager.submit()
  • codeflare_sdk.ray.appwrapper.status module
    • AppWrapper
      • AppWrapper.name
      • AppWrapper.status
    • AppWrapperStatus
      • AppWrapperStatus.FAILED
      • AppWrapperStatus.RESETTING
      • AppWrapperStatus.RESUMING
      • AppWrapperStatus.RUNNING
      • AppWrapperStatus.SUCCEEDED
      • AppWrapperStatus.SUSPENDED
      • AppWrapperStatus.SUSPENDING
      • AppWrapperStatus.TERMINATING
  • Module contents
• codeflare_sdk.ray.client package
  • Submodules
  • codeflare_sdk.ray.client.ray_jobs module
    • RayJobClient
      • RayJobClient.delete_job()
      • RayJobClient.get_address()
      • RayJobClient.get_job_info()
      • RayJobClient.get_job_logs()
      • RayJobClient.get_job_status()
      • RayJobClient.list_jobs()
      • RayJobClient.stop_job()
      • RayJobClient.submit_job()
      • RayJobClient.tail_job_logs()
  • Module contents
• codeflare_sdk.ray.cluster package
  • Submodules
  • codeflare_sdk.ray.cluster.build_ray_cluster module
    • add_queue_label()
    • build_ray_cluster()
    • gen_names()
    • generate_custom_storage()
    • generate_env_vars()
    • generate_image_pull_secrets()
    • get_default_local_queue()
    • get_head_container_spec()
    • get_labels()
    • get_metadata()
    • get_pod_spec()
    • get_resources()
    • get_worker_container_spec()
    • head_worker_extended_resources_from_cluster()
    • head_worker_gpu_count_from_cluster()
    • local_queue_exists()
    • with_nb_annotations()
    • wrap_cluster()
    • write_to_file()
  • codeflare_sdk.ray.cluster.cluster module
    • Cluster
      • Cluster.apply()
      • Cluster.cluster_dashboard_uri()
      • Cluster.cluster_uri()
      • Cluster.config_check()
      • Cluster.create_resource()
      • Cluster.details()
      • Cluster.down()
      • Cluster.get_dynamic_client()
      • Cluster.is_dashboard_ready()
      • Cluster.job_client
      • Cluster.job_logs()
      • Cluster.job_status()
      • Cluster.list_jobs()
      • Cluster.local_client_url()
      • Cluster.status()
      • Cluster.up()
      • Cluster.wait_ready()
    • get_cluster()
    • list_all_clusters()
    • list_all_queued()
    • remove_autogenerated_fields()
  • codeflare_sdk.ray.cluster.config module
    • ClusterConfiguration
      • ClusterConfiguration.annotations
      • ClusterConfiguration.appwrapper
      • ClusterConfiguration.enable_gcs_ft
      • ClusterConfiguration.enable_usage_stats
      • ClusterConfiguration.envs
      • ClusterConfiguration.extended_resource_mapping
      • ClusterConfiguration.external_storage_namespace
      • ClusterConfiguration.head_cpu_limits
      • ClusterConfiguration.head_cpu_requests
      • ClusterConfiguration.head_extended_resource_requests
      • ClusterConfiguration.head_memory_limits
      • ClusterConfiguration.head_memory_requests
      • ClusterConfiguration.head_tolerations
      • ClusterConfiguration.image
      • ClusterConfiguration.image_pull_secrets
      • ClusterConfiguration.labels
      • ClusterConfiguration.local_queue
      • ClusterConfiguration.name
      • ClusterConfiguration.namespace
      • ClusterConfiguration.num_workers
      • ClusterConfiguration.overwrite_default_resource_mapping
      • ClusterConfiguration.redis_address
      • ClusterConfiguration.redis_password_secret
      • ClusterConfiguration.verify_tls
      • ClusterConfiguration.volume_mounts
      • ClusterConfiguration.volumes
      • ClusterConfiguration.worker_cpu_limits
      • ClusterConfiguration.worker_cpu_requests
      • ClusterConfiguration.worker_extended_resource_requests
      • ClusterConfiguration.worker_memory_limits
      • ClusterConfiguration.worker_memory_requests
      • ClusterConfiguration.worker_tolerations
      • ClusterConfiguration.write_to_file
  • codeflare_sdk.ray.cluster.pretty_print module
    • print_app_wrappers_status()
    • print_cluster_status()
    • print_clusters()
    • print_no_resources_found()
    • print_ray_clusters_status()
  • codeflare_sdk.ray.cluster.status module
    • CodeFlareClusterStatus
      • CodeFlareClusterStatus.FAILED
      • CodeFlareClusterStatus.QUEUED
      • CodeFlareClusterStatus.QUEUEING
      • CodeFlareClusterStatus.READY
      • CodeFlareClusterStatus.STARTING
      • CodeFlareClusterStatus.SUSPENDED
      • CodeFlareClusterStatus.UNKNOWN
    • RayCluster
      • RayCluster.dashboard
      • RayCluster.head_cpu_limits
      • RayCluster.head_cpu_requests
      • RayCluster.head_extended_resources
      • RayCluster.head_mem_limits
      • RayCluster.head_mem_requests
      • RayCluster.name
      • RayCluster.namespace
      • RayCluster.num_workers
      • RayCluster.status
      • RayCluster.worker_cpu_limits
      • RayCluster.worker_cpu_requests
      • RayCluster.worker_extended_resources
      • RayCluster.worker_mem_limits
      • RayCluster.worker_mem_requests
    • RayClusterStatus
      • RayClusterStatus.FAILED
      • RayClusterStatus.READY
      • RayClusterStatus.SUSPENDED
      • RayClusterStatus.UNHEALTHY
      • RayClusterStatus.UNKNOWN
  • Module contents
• codeflare_sdk.ray.rayjobs package
  • Submodules
  • codeflare_sdk.ray.rayjobs.config module
    • ManagedClusterConfig
      • ManagedClusterConfig.accelerator_configs
      • ManagedClusterConfig.add_file_volumes()
      • ManagedClusterConfig.annotations
      • ManagedClusterConfig.build_file_secret_spec()
      • ManagedClusterConfig.build_file_volume_specs()
      • ManagedClusterConfig.build_ray_cluster_spec()
      • ManagedClusterConfig.envs
      • ManagedClusterConfig.head_accelerators
      • ManagedClusterConfig.head_cpu_limits
      • ManagedClusterConfig.head_cpu_requests
      • ManagedClusterConfig.head_memory_limits
      • ManagedClusterConfig.head_memory_requests
      • ManagedClusterConfig.head_tolerations
      • ManagedClusterConfig.image
      • ManagedClusterConfig.image_pull_secrets
      • ManagedClusterConfig.labels
      • ManagedClusterConfig.num_workers
      • ManagedClusterConfig.validate_secret_size()
      • ManagedClusterConfig.volume_mounts
      • ManagedClusterConfig.volumes
      • ManagedClusterConfig.worker_accelerators
      • ManagedClusterConfig.worker_cpu_limits
      • ManagedClusterConfig.worker_cpu_requests
      • ManagedClusterConfig.worker_memory_limits
      • ManagedClusterConfig.worker_memory_requests
      • ManagedClusterConfig.worker_tolerations
  • codeflare_sdk.ray.rayjobs.pretty_print module
    • print_job_status()
    • print_no_job_found()
  • codeflare_sdk.ray.rayjobs.rayjob module
    • RayJob
      • RayJob.delete()
      • RayJob.resubmit()
      • RayJob.status()
      • RayJob.stop()
      • RayJob.submit()
  • codeflare_sdk.ray.rayjobs.runtime_env module
    • create_file_secret()
    • create_secret_from_spec()
    • extract_all_local_files()
    • parse_requirements_file()
    • process_pip_dependencies()
    • process_runtime_env()
  • codeflare_sdk.ray.rayjobs.status module
    • CodeflareRayJobStatus
      • CodeflareRayJobStatus.COMPLETE
      • CodeflareRayJobStatus.FAILED
      • CodeflareRayJobStatus.RUNNING
      • CodeflareRayJobStatus.SUSPENDED
      • CodeflareRayJobStatus.UNKNOWN
    • RayJobDeploymentStatus
      • RayJobDeploymentStatus.COMPLETE
      • RayJobDeploymentStatus.FAILED
      • RayJobDeploymentStatus.RUNNING
      • RayJobDeploymentStatus.SUSPENDED
      • RayJobDeploymentStatus.UNKNOWN
    • RayJobInfo
      • RayJobInfo.cluster_name
      • RayJobInfo.end_time
      • RayJobInfo.failed_attempts
      • RayJobInfo.job_id
      • RayJobInfo.name
      • RayJobInfo.namespace
      • RayJobInfo.start_time
      • RayJobInfo.status
      • RayJobInfo.succeeded_attempts
  • Module contents

Module contents