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(f"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(TrainerClient().get_job_logs(name=job_id, node_rank=0)["node-0"])

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.4.0.tar.gz (545.6 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.4.0-py3-none-any.whl (37.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for kubeflow_test-0.4.0.tar.gz
Algorithm Hash digest
SHA256 c30715f10da842fdfd7559471dd4310fe686c8902889ca17be1bd75585eeb39e
MD5 b6bface84b922cb6393f3f72ce33d71b
BLAKE2b-256 2e7ab90deb419c8b2ff2d0a8c8c1fd3ae5c796820a4364ad66a322b905d5123f

See more details on using hashes here.

Provenance

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

Publisher: release.yaml 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.4.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for kubeflow_test-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0726a9529036d9b9dda9621af3a659cf4f40801b89e1bd909d832a441d9ebf65
MD5 1b092a827bbb234b37bc7b4c8d20f6ee
BLAKE2b-256 03972e7092678849bfb143b471d0671d0176cf7813429b44ab4203899feb1c42

See more details on using hashes here.

Provenance

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

Publisher: release.yaml 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