Utilities

Version info, health checks, and model loading.

All methods are accessed via client.misc.

get_xplainable_version()

Get the installed xplainable package version.

Returns

str — Version string

Example

1result = client.misc.get_xplainable_version()

---

get_version_info()

Get comprehensive version information.

Returns

VersionInfo — Version information for all components

Example

1result = client.misc.get_version_info()

---

ping_server()

Ping the compute server to check connectivity.

Parameters

hostnamestrdefault: None

Optional hostname to ping (uses session hostname if not provided)

Returns

PingResponse — Ping response with success status

Example

1result = client.misc.ping_server(

2 hostname="..."

3)

---

ping_gateway()

Ping the API gateway to check connectivity.

Parameters

hostnamestrdefault: None

Optional hostname to ping (uses session hostname if not provided)

Returns

PingResponse — Ping response with success status

Example

1result = client.misc.ping_gateway(

2 hostname="..."

3)

---

get_organisation_usage()

Get org-wide quota usage for every limited resource. Covers six resources: models, preprocessors, deployments, monitors, reports and ai_credits. Each item has count, limit, remaining and has_space. Check has_space before creating a resource to avoid a 429 quota rejection — but always still handle 429: the check is advisory and another user may consume the last slot first.

Parameters

org_idstrdefault: None

Organisation to inspect (defaults to the session org).

Returns

OrganisationUsage — OrganisationUsage with a UsageItem per resource.

Example

1result = client.misc.get_organisation_usage(

2 org_id="..."

3)

---

load_classifier()

Load a binary classification model.

Parameters

model_idstrRequired

Model ID

version_idstrRequired

Version ID

modeldefault: None

Existing model to add partitions to

Returns

Loaded xplainable classifier

Example

1result = client.misc.load_classifier(

2 model_id="model_abc123",

3 version_id="version_xyz789",

4 model=model

5)

---

load_regressor()

Load a regression model.

Parameters

model_idstrRequired

Model ID

version_idstrRequired

Version ID

modeldefault: None

Existing model to add partitions to

Returns

Loaded xplainable regressor

Example

1result = client.misc.load_regressor(

2 model_id="model_abc123",

3 version_id="version_xyz789",

4 model=model

5)

---

get_model_info()

Get information about a model without loading it.

Parameters

model_idstrRequired

Model ID

version_idstrRequired

Version ID

Returns

LoadedModelInfo — Model information

Example

1result = client.misc.get_model_info(

2 model_id="model_abc123",

3 version_id="version_xyz789"

4)

---

health_check()

Perform a comprehensive health check.

Parameters

check_databasebooldefault: True

Whether to check database connectivity

check_storagebooldefault: True

Whether to check storage systems

check_computebooldefault: True

Whether to check compute resources

Returns

HealthCheckResponse — Health check results

Example

1result = client.misc.health_check(

2 check_database=True,

3 check_storage=True,

4 check_compute=True

5)

---