Skip to main content

Cyberwave is in Private Beta.

Request early access to get access to the Cyberwave dashboard.

Overview

cw.models is the unified surface for ML model management in the Cyberwave Python SDK. It combines responsibilities behind one namespace:

Installation

The ML inference extras require the [ml] optional dependency group:
For edge development, install in editable mode from the repository:

Catalog API

List models

cw.models.create() and cw.models.update() are not implemented yet — use POST / PUT on /api/v1/mlmodels, or generated cw.api.* helpers, until typed wrappers ship.
Each record exposes:

Get a single record

Delete a model

Deletion removes the catalog record. Local weight files on your device are unaffected.

Runtime API

Load a model

cw.models.load() accepts a catalog entry or a string: Passing a catalog entry directly is the preferred pattern — no need to inspect which field to use:
Both return an object with the same .predict() interface (unless a list was passed).

Cloud playground (cw.models.playground)

For full control over the playground HTTP payload (conversation history, structured_task, async workloads), bind a slug and call run():
This returns typed REST schemas (MLModelRunResultSchema or MLModelRunQueuedSchema), not PredictionResult.

Run inference

predict() returns a concrete PredictionResult subclass — e.g. DetectionResult, ClassificationResult, TextResult, PoseResult, InstanceSegmentationResult, OBBResult, EmbeddingResult. Use type-specific fields (.detections, .top, .text, …) rather than a wrapper.

Catalog-to-runtime workflow

Discover a model in the catalog, then load it by passing the entry directly:
The same pattern works for cloud models — the entry’s slug is used instead:

MCP tools

When using the Cyberwave MCP Server, AI agents can query the model catalog with:

Python SDK

Full Python SDK reference

MCP Server

Let AI agents query the model catalog

ML Models (UI)

Manage models from the Cyberwave dashboard

Edge Workers

Run models on edge hardware