Kelvin SDK

Welcome to the Kelvin SDK developer documentation.

The Kelvin SDK provides a command-line interface (CLI) and Python library for interacting with the Kelvin platform. It enables developers to build, deploy, and manage applications on the Kelvin ecosystem.

Getting Started

Installation

Install the Kelvin SDK using pip:

pip install kelvin-sdk

For MLflow integration, install with the optional dependency:

pip install kelvin-sdk[mlflow]

Authentication

After installation, authenticate with the Kelvin platform:

kelvin auth login

You can specify a platform URL:

kelvin auth login alpha.kelvininc.com

View Available Commands

Use the --tree flag to see all available commands:

kelvin --tree

Get help for any command:

kelvin --help
kelvin app --help
kelvin app create --help

CLI Reference

Command Line Interface

• CLI Commands
  • kelvin

Library Reference

Core Modules

• Core Modules
  • Entry Point
  • CLI Group
  • Services Container
  • Exceptions
  • Logging

Commands Layer

• Commands
  • Shared Utilities
  • App Commands
  • App Image Commands
  • Apps Commands
  • Auth Commands
  • MLflow Commands
  • Secret Commands
  • Workload Commands

Services Layer

• Services
  • API Client
  • Configuration
  • Credential Store
  • Docker
  • MLflow
  • Schema
  • Session
  • Template
  • Authentication

External Packages

• KRN (Kelvin Resource Names)
  • KRN Module
  • KRN Classes
  • Available KRN Types

License

• Kelvin SDK and API Agreement

Indices and Tables

• Index

• Module Index

• Search Page