CodeFlare SDK

Code Documentation:

  • codeflare_sdk
    • codeflare_sdk package

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
  • codeflare_sdk
  • View page source

codeflare_sdk

  • codeflare_sdk package
    • Subpackages
      • codeflare_sdk.common package
        • Subpackages
        • Module contents
      • codeflare_sdk.ray package
        • Subpackages
        • Module contents
      • codeflare_sdk.vendored package
        • Subpackages
        • Module contents
    • Submodules
    • codeflare_sdk.codeflare module
      • ClusterHandler
        • ClusterHandler.create()
        • ClusterHandler.get()
        • ClusterHandler.list()
        • ClusterHandler.list_queued()
      • Codeflare
        • Codeflare.client
      • JobHandler
        • JobHandler.create()
        • JobHandler.submit()
      • JobOptions
        • JobOptions.active_deadline_seconds
        • JobOptions.local_queue
        • JobOptions.priority_class
        • JobOptions.runtime_env
        • JobOptions.ttl_seconds_after_finished
      • SDKConfig
        • SDKConfig.auth
        • SDKConfig.log_level
        • SDKConfig.namespace
    • codeflare_sdk.conftest module
    • Module contents
Previous Next

© Copyright 2026, Project CodeFlare.

Built with Sphinx using a theme provided by Read the Docs.