About Client 3.x

The Fiddler Python client lets you interact with the Fiddler platform directly from Python notebooks and automated pipelines. It provides methods for onboarding your models, monitoring, sending, or retrieving data, and configuring various features, such as alerts and custom metrics.

Documentation for the Fiddler Python client, including descriptions and example usage, is here. The Fiddler REST API is an alternate API providing many of the same capabilities which are documented here.

Initialization

The Fiddler Python client object is used to communicate with your Fiddler environment.

Import Fiddler

Import the Fiddler Python client as shown below:

import fiddler as fdl
from fiddler import Model, Project

Authenticate and Connect

In order to use the client, you'll need to provide authentication details as shown below.

Usage params

Parameter	Type	Default	Description
url	str	-	The URL of the Fiddler environment.
token	str	-	An authentication token. Tokens are managed in Fiddler settings.
proxies	Optional[dict]	-	Dictionary mapping protocol to the URL of the proxy
timeout	Optional[Union[float, tuple[float, float]]]	-	Seconds to wait for the server to send/receive data before timing out. This configures the connection timeout with a single value or both connection and read timeouts as a tuple of values.
verify	Optional[bool]	True	Controls whether Fiddler verifies the server’s TLS certificate.
validate	Optional[bool]	True	Controls server/client version compatibility check. Some features may not work if the check is disabled.

Return params

None

Usage

fdl.init(
  url: str,
  token: str,
  proxies: dict[str, Any],
  timeout: int,
  verify: bool,
  validate: bool
)

your_url = 'https://xyz.fiddler.ai'
your_token = 'abc'

# Simple connection with your connection details and using default values for all other parameters
fdl.init(url=your_url, token=your_token)

# Set 30-second connection timeout
fdl.init(url=your_url, token=your_token, timeout=30.0)

# Set 30-second connection timeout and 60-second read timeout
fdl.init(url=your_url, token=your_token, timeout=(30.0, 60.0))

Raises

Error code	Issue
ValueError	URL or token missing while initializing the client.
IncompatibleClient	Fiddler Platform version is not compatible with Client version.

📘 Info

To maximize compatibility, please ensure that your client version matches the server version for your Fiddler instance.

When you connect to Fiddler, you'll receive a notification if there is a version mismatch between the client and server.

You can install a specific version of fiddler-client using pip: pip install fiddler-client==X.X.X

---

💡 Need help? Contact support.