.. CodeFlare SDK documentation master file, created by
   sphinx-quickstart on Thu Oct 10 11:27:58 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

CodeFlare SDK documentation
===========================

The CodeFlare SDK is an intuitive, easy-to-use python interface for batch resource requesting, access, job submission, and observation. Simplifying the developer's life while enabling access to high-performance compute resources, either in the cloud or on-prem.


.. toctree::
   :maxdepth: 2
   :caption: Code Documentation:

   modules

.. toctree::
   :maxdepth: 1
   :caption: User Documentation:

   user-docs/authentication
   user-docs/cluster-configuration
   user-docs/ray-cluster-interaction
   user-docs/e2e
   user-docs/s3-compatible-storage
   user-docs/setup-kueue
   user-docs/ui-widgets

Quick Links
===========
- `PyPi <https://pypi.org/project/codeflare-sdk/>`__
- `GitHub <https://github.com/project-codeflare/codeflare-sdk>`__
- `OpenShift AI Documentation <https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed/2.13/html/working_with_distributed_workloads/index>`__