API reference

Python API

Parameter reference for all methods in the Modelbit Python package. These functions are called on the modelbit module (e.g. import modelbit) or on the logged in instance (e.g. mb = modelbit.login()).

Authentication

• modelbit.login: Authenticating with Modelbit

Deployments

• mb.deploy: Creating and updating Modelbit deployments
• modelbit.get_inference: An easy way to call your deployments

Inference-time helpers

• mb.get_dataset: Fetching datasets and filtering feature stores
• mb.get_secret: Fetching a secret stored in Modelbit
• mb.log_image: Log images to Modelbit logs
• modelbit.setup: Run code during import time and reduce cold starts
• modelbit.trace: Add performance tracing to your deployments

Deployment settings

• mb.add_files: Adding new pkl files to deployments
• mb.restart_deployment: Restart running deployments
• mb.get_snowflake_mock_return_value: Fetch the Snowflake mock return value
• mb.set_snowflake_mock_return_value: Set the Snowflake mock return value

Training jobs

• mb.add_job: Adding and updating training jobs to deployments
• mb.run_job: Start a training job

Model Registry

• mb.add_metrics: Add metrics to a model in the registry
• mb.add_model: Adds one model to the registry
• mb.add_models: Adds multiple models to the registry
• mb.delete_models: Remove one or more models from the registry
• mb.get_metrics: Fetches a model's metrics from the registry
• mb.get_model: Fetches a model from the registry
• mb.get_models: Fetches multiple models from the registry
• mb.models: Lists models in the registry

Common files & packages

• mb.add_common_files: Adding common files
• mb.add_package: Uploading local packages as shared code to Modelbit
• mb.common_files: Listing common files
• mb.delete_common_files: Deleting common files
• mb.delete_package: Remove packages from Modelbit

Git Branches

• mb.create_branch: Create a new git branch
• mb.get_branch: Get the current git branch
• mb.merge_deployment: Merge deployments between branches
• mb.switch_branch: Change the current git branch

Management

• mb.datasets: Listing available datasets and feature stores
• mb.get_deployment_info: Get the name of version of the current deployment
• mb.in_modelbit: Check if this code is running in Modelbit or locally
• mb.warehouses: List the warehouses connected to Modelbit

Command line interface (CLI)

CLI reference for interacting with modelbit on the command line. The CLI is installed as part of the Modelbit Python package.

• add_common_files: Link files in common into your deployment
• clone: Configures and clones a git repository of your workspace
• deployment: Manage deployments
• model: Manage file-based models in the model registry
• package: Add private packages to your Modelbit workspace
• validate: Check for missing files or configuration files in your deployments
• version: Return the version of the currently installed modelbit package