CodeFlare SDK

Code Documentation:

  • codeflare_sdk
    • codeflare_sdk package
      • Subpackages
        • codeflare_sdk.common package
        • codeflare_sdk.ray package
      • Module contents

User Documentation:

  • Authentication via the CodeFlare SDK
  • Ray Cluster Configuration
  • Ray Cluster Interaction
  • Running e2e tests locally
  • S3 compatible storage with Ray Train examples
  • Basic Kueue Resources configuration
  • Jupyter UI Widgets
CodeFlare SDK
  • codeflare_sdk
  • codeflare_sdk package
  • codeflare_sdk.common package
  • View page source

codeflare_sdk.common package

Subpackages

  • codeflare_sdk.common.kubernetes_cluster package
    • Submodules
    • codeflare_sdk.common.kubernetes_cluster.auth module
      • Authentication
        • Authentication.login()
        • Authentication.logout()
      • KubeConfigFileAuthentication
        • KubeConfigFileAuthentication.load_kube_config()
      • KubeConfiguration
        • KubeConfiguration.load_kube_config()
        • KubeConfiguration.logout()
      • TokenAuthentication
        • TokenAuthentication.login()
        • TokenAuthentication.logout()
      • config_check()
      • get_api_client()
    • codeflare_sdk.common.kubernetes_cluster.kube_api_helpers module
    • Module contents
  • codeflare_sdk.common.kueue package
    • Submodules
    • codeflare_sdk.common.kueue.kueue module
      • add_queue_label()
      • get_default_kueue_name()
      • list_local_queues()
      • local_queue_exists()
    • Module contents
  • codeflare_sdk.common.utils package
    • Submodules
    • codeflare_sdk.common.utils.constants module
    • codeflare_sdk.common.utils.demos module
      • copy_demo_nbs()
    • codeflare_sdk.common.utils.generate_cert module
      • export_env()
      • generate_ca_cert()
      • generate_tls_cert()
      • get_secret_name()
    • Module contents
  • codeflare_sdk.common.widgets package
    • Submodules
    • codeflare_sdk.common.widgets.widgets module
      • RayClusterManagerWidgets
        • RayClusterManagerWidgets.display_widgets()
      • cluster_up_down_buttons()
      • is_notebook()
      • view_clusters()
    • Module contents

Module contents

Previous Next

© Copyright 2024, Project CodeFlare.

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