proxyml 0.1.7__tar.gz → 0.1.8__tar.gz

{proxyml-0.1.7 → proxyml-0.1.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: proxyml
-Version: 0.1.7
+Version: 0.1.8
 Summary: Python SDK for calling the ProxyML API
 Author-email: ProxyML <contact@proxyml.ai>
 License:                                  Apache License

{proxyml-0.1.7 → proxyml-0.1.8}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "proxyml"
-version = "0.1.7"
+version = "0.1.8"
 description = "Python SDK for calling the ProxyML API"
 readme = "README.md"
 license = {file = "LICENSE"}

{proxyml-0.1.7 → proxyml-0.1.8}/src/proxyml/client.py

@@ -270,6 +270,26 @@ def train_surrogate(
     return None
 
 
+def export_surrogate(version: str) -> Any:
+    """
+    Exports a surrogate model to JSON e.g., classes, intercept, per_class_intercepts, features, scalers, etc.; everything required
+    to reconstruct the surrogate.
+    
+    Args:
+        version (str): name of the surrogate to export
+    Returns:
+        JSON object representing the surrogate, or None if an error occurred. 
+    """
+    r = get(endpoint=f'/surrogate/models/{version}/export', params=dict())
+    if r.status_code == 200:
+        return r.json()
+    logger.error(                                                                                                                                                            
+        "Surrogate export failed (version=%s, status=%s): %s",                                                                                                             
+        version, r.status_code, r.text,                                                                                                                                      
+    )
+    return None
+
+
 def predict(sample: list, version: str | None = None) -> Any:
     """
     Calls a surrogate model to make a single prediction.

{proxyml-0.1.7 → proxyml-0.1.8}/src/proxyml.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: proxyml
-Version: 0.1.7
+Version: 0.1.8
 Summary: Python SDK for calling the ProxyML API
 Author-email: ProxyML <contact@proxyml.ai>
 License:                                  Apache License

{proxyml-0.1.7 → proxyml-0.1.8}/tests/test_client.py

@@ -10,6 +10,7 @@ from proxyml.client import (
     delete_model,
     delete_schema,
     diff_models,
+    export_surrogate,
     fetch_schema,
     find_counterfactuals,
     get_model_summary,
@@ -552,3 +553,37 @@ def test_rotate_key_success(mock_post):
 def test_rotate_key_failure_returns_none(mock_post):
     mock_post.return_value = _mock_response(403, {"detail": "Key rotation is not available for test accounts"})
     assert rotate_key() is None
+
+
+# ---------------------------------------------------------------------------
+# export_surrogate
+# ---------------------------------------------------------------------------
+
+_EXPORT_RESPONSE = {
+    "version": "abc-123",
+    "classes": [0, 1],
+    "intercept": [0.5],
+    "per_class_intercepts": None,
+    "features": [{"name": "age", "type": "continuous"}],
+    "scalers": {"age": {"mean": 35.0, "scale": 10.0}},
+}
+
+
+@patch("proxyml.client.get")
+def test_export_surrogate_success(mock_get):
+    mock_get.return_value = _mock_response(200, _EXPORT_RESPONSE)
+    result = export_surrogate(version="abc-123")
+    assert result == _EXPORT_RESPONSE
+
+
+@patch("proxyml.client.get")
+def test_export_surrogate_calls_correct_endpoint(mock_get):
+    mock_get.return_value = _mock_response(200, _EXPORT_RESPONSE)
+    export_surrogate(version="abc-123")
+    mock_get.assert_called_once_with(endpoint="/surrogate/models/abc-123/export", params={})
+
+
+@patch("proxyml.client.get")
+def test_export_surrogate_failure_returns_none(mock_get):
+    mock_get.return_value = _mock_response(404, {"detail": "model not found"})
+    assert export_surrogate(version="no-such-version") is None