Skip to main content

Kubeflow Python SDK to manage ML workloads and to interact with Kubeflow APIs.

Project description

Kubeflow SDK

PyPI version PyPI Downloads Join Slack Coverage Status Ask DeepWiki

Overview

Kubeflow SDK is a unified Python SDK that streamlines the user experience for AI Practitioners to interact with various Kubeflow projects. It provides simple, consistent APIs across the Kubeflow ecosystem, enabling users to focus on building ML applications rather than managing complex infrastrutcure.

Kubeflow SDK Benefits

  • Unified Experience: Single SDK to interact with multiple Kubeflow projects through consistent Python APIs
  • Simplified AI Workflows: Abstract away Kubernetes complexity, allowing AI practitioners to work in familiar Python environments
  • Seamless Integration: Designed to work together with all Kubeflow projects for end-to-end ML pipelines
  • Local Development: First-class support for local development requiring only pip installation
Kubeflow SDK Personas

Get Started

Install Kubeflow SDK

pip install git+https://github.com/kubeflow/sdk.git@main

Run your first PyTorch distributed job

from kubeflow.trainer import TrainerClient, CustomTrainer

def get_torch_dist():
    import os
    import torch
    import torch.distributed as dist

    dist.init_process_group(backend="gloo")
    print("PyTorch Distributed Environment")
    print(f"WORLD_SIZE: {dist.get_world_size()}")
    print(f"RANK: {dist.get_rank()}")
    print(f"LOCAL_RANK: {os.environ['LOCAL_RANK']}")

# Create the TrainJob
job_id = TrainerClient().train(
    runtime=TrainerClient().get_runtime("torch-distributed"),
    trainer=CustomTrainer(
        func=get_torch_dist,
        num_nodes=3,
        resources_per_node={
            "cpu": 2,
        },
    ),
)

# Wait for TrainJob to complete
TrainerClient().wait_for_job_status(job_id)

# Print TrainJob logs
print("\n".join(TrainerClient().get_job_logs(name=job_id)))

Supported Kubeflow Projects

Project Status Description
Kubeflow Trainer Available Train and fine-tune AI models with various frameworks
Kubeflow Katib 🚧 Planned Hyperparameter optimization
Kubeflow Pipelines 🚧 Planned Build, run, and track AI workflows
Kubeflow Model Registry 🚧 Planned Manage model artifacts, versions and ML artifacts metadata

Community

Getting Involved

Contributing

Kubeflow SDK is a community project and is still under active development. We welcome contributions! Please see our CONTRIBUTING Guide for details.

Documentation

✨ Contributors

We couldn't have done it without these incredible people:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kubeflow_test-0.9.1.tar.gz (606.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kubeflow_test-0.9.1-py3-none-any.whl (39.9 kB view details)

Uploaded Python 3

File details

Details for the file kubeflow_test-0.9.1.tar.gz.

File metadata

  • Download URL: kubeflow_test-0.9.1.tar.gz
  • Upload date:
  • Size: 606.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for kubeflow_test-0.9.1.tar.gz
Algorithm Hash digest
SHA256 63a6f41d41df52f10a0c1580c1a6529c0225c5bfc74109b5fd5efb4d5e185660
MD5 9e6ed668985be53d5db12dd6fc377a42
BLAKE2b-256 5b7df81db05cac88ff225a9e0987276ba241708b3786078fc312c95e40204b64

See more details on using hashes here.

Provenance

The following attestation bundles were made for kubeflow_test-0.9.1.tar.gz:

Publisher: release.yml on kramaranya/sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file kubeflow_test-0.9.1-py3-none-any.whl.

File metadata

  • Download URL: kubeflow_test-0.9.1-py3-none-any.whl
  • Upload date:
  • Size: 39.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for kubeflow_test-0.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e0a4d245a1e5d7415c0ea1ded3d5281daea9c8353d8d438817f6961e3692e213
MD5 6a1114094a9d0a3bd3858bfc7c3804bb
BLAKE2b-256 0ad502808d56d40fcff716345a00b4e10191dbf7f1d59c0d27ff70bc9bc0929c

See more details on using hashes here.

Provenance

The following attestation bundles were made for kubeflow_test-0.9.1-py3-none-any.whl:

Publisher: release.yml on kramaranya/sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page