kumoai 2.10.0.dev202509281831__cp313-cp313-win_amd64.whl → 2.13.0.dev202511211730__cp313-cp313-win_amd64.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
kumoai/__init__.py CHANGED
@@ -184,15 +184,12 @@ def init(
184
184
  snowflake_credentials
185
185
  ) if not api_key and snowflake_credentials else None
186
186
  client = KumoClient(url=url, api_key=api_key, spcs_token=spcs_token)
187
- if client.authenticate():
188
- global_state._url = client._url
189
- global_state._api_key = client._api_key
190
- global_state._snowflake_credentials = snowflake_credentials
191
- global_state._spcs_token = client._spcs_token
192
- global_state._snowpark_session = snowpark_session
193
- else:
194
- raise ValueError("Client authentication failed. Please check if you "
195
- "have a valid API key.")
187
+ client.authenticate()
188
+ global_state._url = client._url
189
+ global_state._api_key = client._api_key
190
+ global_state._snowflake_credentials = snowflake_credentials
191
+ global_state._spcs_token = client._spcs_token
192
+ global_state._snowpark_session = snowpark_session
196
193
 
197
194
  if not api_key and snowflake_credentials:
198
195
  # Refresh token every 10 minutes (expires in 1 hour):
@@ -200,9 +197,11 @@ def init(
200
197
 
201
198
  logger = logging.getLogger('kumoai')
202
199
  log_level = logging.getLevelName(logger.getEffectiveLevel())
200
+
203
201
  logger.info(
204
- "Successfully initialized the Kumo SDK against deployment %s, with "
205
- "log level %s.", url, log_level)
202
+ f"Successfully initialized the Kumo SDK (version {__version__}) "
203
+ f"against deployment {url}, with "
204
+ f"log level {log_level}.")
206
205
 
207
206
 
208
207
  def set_log_level(level: str) -> None:
kumoai/_version.py CHANGED
@@ -1 +1 @@
1
- __version__ = '2.10.0.dev202509281831'
1
+ __version__ = '2.13.0.dev202511211730'
kumoai/client/client.py CHANGED
@@ -20,7 +20,6 @@ if TYPE_CHECKING:
20
20
  )
21
21
  from kumoai.client.online import OnlineServingEndpointAPI
22
22
  from kumoai.client.pquery import PQueryAPI
23
- from kumoai.client.rfm import RFMAPI
24
23
  from kumoai.client.source_table import SourceTableAPI
25
24
  from kumoai.client.table import TableAPI
26
25
 
@@ -33,6 +32,7 @@ class KumoClient:
33
32
  url: str,
34
33
  api_key: Optional[str],
35
34
  spcs_token: Optional[str] = None,
35
+ verify_ssl: bool = True,
36
36
  ) -> None:
37
37
  r"""Creates a client against the Kumo public API, provided a URL of
38
38
  the endpoint and an authentication token.
@@ -42,11 +42,14 @@ class KumoClient:
42
42
  api_key: the public API authentication token.
43
43
  spcs_token: the SPCS token used for authentication to access the
44
44
  Kumo API endpoint.
45
+ verify_ssl: whether to verify SSL certificates. Set to False to
46
+ skip SSL certificate verification (equivalent to curl -k).
45
47
  """
46
48
  self._url = url
47
49
  self._api_url = f"{url}/{API_VERSION}"
48
50
  self._api_key = api_key
49
51
  self._spcs_token = spcs_token
52
+ self._verify_ssl = verify_ssl
50
53
 
51
54
  retry_strategy = Retry(
52
55
  total=10, # Maximum number of retries
@@ -69,11 +72,15 @@ class KumoClient:
69
72
  self._session.headers.update(
70
73
  {'Authorization': f'Snowflake Token={self._spcs_token}'})
71
74
 
72
- def authenticate(self) -> bool:
73
- r"""Raises an exception if authentication fails. Succeeds if the
74
- client is properly formed.
75
- """
76
- return self._session.get(f"{self._url}/v1/connectors").ok
75
+ def authenticate(self) -> None:
76
+ """Raises an exception if authentication fails."""
77
+ try:
78
+ self._session.get(self._url + '/v1/connectors',
79
+ verify=self._verify_ssl).raise_for_status()
80
+ except Exception:
81
+ raise ValueError(
82
+ "Client authentication failed. Please check if you "
83
+ "have a valid API key/credentials.")
77
84
 
78
85
  def set_spcs_token(self, spcs_token: str) -> None:
79
86
  r"""Sets the SPCS token for the client and updates the session
@@ -158,12 +165,6 @@ class KumoClient:
158
165
  from kumoai.client.online import OnlineServingEndpointAPI
159
166
  return OnlineServingEndpointAPI(self)
160
167
 
161
- @property
162
- def rfm_api(self) -> 'RFMAPI':
163
- r"""Returns the typed RFM API."""
164
- from kumoai.client.rfm import RFMAPI
165
- return RFMAPI(self)
166
-
167
168
  def _request(self, endpoint: Endpoint, **kwargs: Any) -> requests.Response:
168
169
  r"""Send a HTTP request to the specified endpoint."""
169
170
  endpoint_str = endpoint.get_path()
@@ -184,7 +185,7 @@ class KumoClient:
184
185
  :meth:`requests.Session.get`.
185
186
  """
186
187
  url = self._format_endpoint_url(endpoint)
187
- return self._session.get(url=url, **kwargs)
188
+ return self._session.get(url=url, verify=self._verify_ssl, **kwargs)
188
189
 
189
190
  def _post(self, endpoint: str, **kwargs: Any) -> requests.Response:
190
191
  r"""Send a POST request to the specified endpoint, with keyword
@@ -192,7 +193,7 @@ class KumoClient:
192
193
  :meth:`requests.Session.post`.
193
194
  """
194
195
  url = self._format_endpoint_url(endpoint)
195
- return self._session.post(url=url, **kwargs)
196
+ return self._session.post(url=url, verify=self._verify_ssl, **kwargs)
196
197
 
197
198
  def _patch(self, endpoint: str, **kwargs: Any) -> requests.Response:
198
199
  r"""Send a PATCH request to the specified endpoint, with keyword
@@ -200,7 +201,7 @@ class KumoClient:
200
201
  :meth:`requests.Session.patch`.
201
202
  """
202
203
  url = self._format_endpoint_url(endpoint)
203
- return self._session.patch(url=url, **kwargs)
204
+ return self._session.patch(url=url, verify=self._verify_ssl, **kwargs)
204
205
 
205
206
  def _delete(self, endpoint: str, **kwargs: Any) -> requests.Response:
206
207
  r"""Send a DELETE request to the specified endpoint, with keyword
@@ -208,7 +209,7 @@ class KumoClient:
208
209
  :meth:`requests.Session.delete`.
209
210
  """
210
211
  url = self._format_endpoint_url(endpoint)
211
- return self._session.delete(url=url, **kwargs)
212
+ return self._session.delete(url=url, verify=self._verify_ssl, **kwargs)
212
213
 
213
214
  def _format_endpoint_url(self, endpoint: str) -> str:
214
215
  if endpoint[0] == "/":
@@ -147,3 +147,4 @@ class RFMEndpoints:
147
147
  explain = Endpoint(f"{BASE}/explain", HTTPMethod.POST)
148
148
  evaluate = Endpoint(f"{BASE}/evaluate", HTTPMethod.POST)
149
149
  validate_query = Endpoint(f"{BASE}/validate_query", HTTPMethod.POST)
150
+ parse_query = Endpoint(f"{BASE}/parse_query", HTTPMethod.POST)
kumoai/client/rfm.py CHANGED
@@ -1,6 +1,11 @@
1
+ from typing import Any
2
+
1
3
  from kumoapi.json_serde import to_json_dict
2
4
  from kumoapi.rfm import (
3
5
  RFMEvaluateResponse,
6
+ RFMExplanationResponse,
7
+ RFMParseQueryRequest,
8
+ RFMParseQueryResponse,
4
9
  RFMPredictResponse,
5
10
  RFMValidateQueryRequest,
6
11
  RFMValidateQueryResponse,
@@ -25,28 +30,35 @@ class RFMAPI:
25
30
  Returns:
26
31
  RFMPredictResponse containing the predictions
27
32
  """
28
- # Send binary data to the predict endpoint
29
33
  response = self._client._request(
30
- RFMEndpoints.predict, data=request,
31
- headers={'Content-Type': 'application/x-protobuf'})
34
+ RFMEndpoints.predict,
35
+ data=request,
36
+ headers={'Content-Type': 'application/x-protobuf'},
37
+ )
32
38
  raise_on_error(response)
33
39
  return parse_response(RFMPredictResponse, response)
34
40
 
35
- def explain(self, request: bytes) -> RFMPredictResponse:
41
+ def explain(
42
+ self,
43
+ request: bytes,
44
+ skip_summary: bool = False,
45
+ ) -> RFMExplanationResponse:
36
46
  """Explain the RFM model on the given context.
37
47
 
38
48
  Args:
39
49
  request: The predict request as serialized protobuf.
50
+ skip_summary: Whether to skip generating a human-readable summary
51
+ of the explanation.
40
52
 
41
53
  Returns:
42
54
  RFMPredictResponse containing the explanations
43
55
  """
44
- # Send binary data to the explain endpoint
56
+ params: dict[str, Any] = {'generate_summary': not skip_summary}
45
57
  response = self._client._request(
46
- RFMEndpoints.explain, data=request,
58
+ RFMEndpoints.explain, data=request, params=params,
47
59
  headers={'Content-Type': 'application/x-protobuf'})
48
60
  raise_on_error(response)
49
- return parse_response(RFMPredictResponse, response)
61
+ return parse_response(RFMExplanationResponse, response)
50
62
 
51
63
  def evaluate(self, request: bytes) -> RFMEvaluateResponse:
52
64
  """Evaluate the RFM model on the given context.
@@ -57,7 +69,6 @@ class RFMAPI:
57
69
  Returns:
58
70
  RFMEvaluateResponse containing the computed metrics
59
71
  """
60
- # Send binary data to the evaluate endpoint
61
72
  response = self._client._request(
62
73
  RFMEndpoints.evaluate, data=request,
63
74
  headers={'Content-Type': 'application/x-protobuf'})
@@ -81,3 +92,21 @@ class RFMAPI:
81
92
  json=to_json_dict(request))
82
93
  raise_on_error(response)
83
94
  return parse_response(RFMValidateQueryResponse, response)
95
+
96
+ def parse_query(
97
+ self,
98
+ request: RFMParseQueryRequest,
99
+ ) -> RFMParseQueryResponse:
100
+ """Validate a predictive query against a graph.
101
+
102
+ Args:
103
+ request: The request object containing
104
+ the query and graph definition
105
+
106
+ Returns:
107
+ RFMParseQueryResponse containing the QueryDefinition
108
+ """
109
+ response = self._client._request(RFMEndpoints.parse_query,
110
+ json=to_json_dict(request))
111
+ raise_on_error(response)
112
+ return parse_response(RFMParseQueryResponse, response)
@@ -12,7 +12,7 @@ CPU architecture: {platform.machine()}
12
12
  glibc version: {platform.libc_ver()[1]}
13
13
 
14
14
  ✅ Supported Environments:
15
- * Python versions: 3.9, 3.10, 3.11, 3.12, 3.13
15
+ * Python versions: 3.10, 3.11, 3.12, 3.13
16
16
  * Operating systems and CPU architectures:
17
17
  * Linux (x86_64)
18
18
  * macOS (arm64)
@@ -20,7 +20,7 @@ glibc version: {platform.libc_ver()[1]}
20
20
  * glibc versions: >=2.28
21
21
 
22
22
  ❌ Unsupported Environments:
23
- * Python versions: 3.8, 3.14
23
+ * Python versions: 3.8, 3.9, 3.14
24
24
  * Operating systems and CPU architectures:
25
25
  * Linux (arm64)
26
26
  * macOS (x86_64)
@@ -31,14 +31,122 @@ Please create a feature request at 'https://github.com/kumo-ai/kumo-rfm'."""
31
31
 
32
32
  raise RuntimeError(_msg) from e
33
33
 
34
- from typing import Optional, Dict
34
+ from dataclasses import dataclass
35
+ from enum import Enum
36
+ import ipaddress
37
+ import logging
38
+ import re
39
+ import socket
40
+ import threading
41
+ from typing import Optional, Dict, Tuple
35
42
  import os
43
+ from urllib.parse import urlparse
36
44
  import kumoai
45
+ from kumoai.client.client import KumoClient
46
+ from .sagemaker import (KumoClient_SageMakerAdapter,
47
+ KumoClient_SageMakerProxy_Local)
37
48
  from .local_table import LocalTable
38
49
  from .local_graph import LocalGraph
39
- from .rfm import KumoRFM
50
+ from .rfm import ExplainConfig, Explanation, KumoRFM
40
51
  from .authenticate import authenticate
41
52
 
53
+ logger = logging.getLogger('kumoai_rfm')
54
+
55
+
56
+ def _is_local_address(host: str | None) -> bool:
57
+ """Return True if the hostname/IP refers to the local machine."""
58
+ if not host:
59
+ return False
60
+ try:
61
+ infos = socket.getaddrinfo(host, None)
62
+ for _, _, _, _, sockaddr in infos:
63
+ ip = sockaddr[0]
64
+ ip_obj = ipaddress.ip_address(ip)
65
+ if ip_obj.is_loopback or ip_obj.is_unspecified:
66
+ return True
67
+ return False
68
+ except Exception:
69
+ return False
70
+
71
+
72
+ class InferenceBackend(str, Enum):
73
+ REST = "REST"
74
+ LOCAL_SAGEMAKER = "LOCAL_SAGEMAKER"
75
+ AWS_SAGEMAKER = "AWS_SAGEMAKER"
76
+ UNKNOWN = "UNKNOWN"
77
+
78
+
79
+ def _detect_backend(
80
+ url: str) -> Tuple[InferenceBackend, Optional[str], Optional[str]]:
81
+ parsed = urlparse(url)
82
+
83
+ # Remote SageMaker
84
+ if ("runtime.sagemaker" in parsed.netloc
85
+ and parsed.path.endswith("/invocations")):
86
+ # Example: https://runtime.sagemaker.us-west-2.amazonaws.com/
87
+ # endpoints/Name/invocations
88
+ match = re.search(r"runtime\.sagemaker\.([a-z0-9-]+)\.amazonaws\.com",
89
+ parsed.netloc)
90
+ region = match.group(1) if match else None
91
+ m = re.search(r"/endpoints/([^/]+)/invocations", parsed.path)
92
+ endpoint_name = m.group(1) if m else None
93
+ return InferenceBackend.AWS_SAGEMAKER, region, endpoint_name
94
+
95
+ # Local SageMaker
96
+ if parsed.port == 8080 and parsed.path.endswith(
97
+ "/invocations") and _is_local_address(parsed.hostname):
98
+ return InferenceBackend.LOCAL_SAGEMAKER, None, None
99
+
100
+ # Default: regular REST
101
+ return InferenceBackend.REST, None, None
102
+
103
+
104
+ @dataclass
105
+ class RfmGlobalState:
106
+ _url: str = '__url_not_provided__'
107
+ _backend: InferenceBackend = InferenceBackend.UNKNOWN
108
+ _region: Optional[str] = None
109
+ _endpoint_name: Optional[str] = None
110
+ _thread_local = threading.local()
111
+
112
+ # Thread-safe init-once.
113
+ _initialized: bool = False
114
+ _lock: threading.Lock = threading.Lock()
115
+
116
+ @property
117
+ def client(self) -> KumoClient:
118
+ if self._backend == InferenceBackend.REST:
119
+ return kumoai.global_state.client
120
+
121
+ if hasattr(self._thread_local, '_sagemaker'):
122
+ # Set the spcs token in the client to ensure it has the latest.
123
+ return self._thread_local._sagemaker
124
+
125
+ sagemaker_client: KumoClient
126
+ if self._backend == InferenceBackend.LOCAL_SAGEMAKER:
127
+ sagemaker_client = KumoClient_SageMakerProxy_Local(self._url)
128
+ else:
129
+ assert self._backend == InferenceBackend.AWS_SAGEMAKER
130
+ assert self._region
131
+ assert self._endpoint_name
132
+ sagemaker_client = KumoClient_SageMakerAdapter(
133
+ self._region, self._endpoint_name)
134
+
135
+ self._thread_local._sagemaker = sagemaker_client
136
+ return sagemaker_client
137
+
138
+ def reset(self) -> None: # For testing only.
139
+ with self._lock:
140
+ self._initialized = False
141
+ self._url = '__url_not_provided__'
142
+ self._backend = InferenceBackend.UNKNOWN
143
+ self._region = None
144
+ self._endpoint_name = None
145
+ self._thread_local = threading.local()
146
+
147
+
148
+ global_state = RfmGlobalState()
149
+
42
150
 
43
151
  def init(
44
152
  url: Optional[str] = None,
@@ -47,19 +155,54 @@ def init(
47
155
  snowflake_application: Optional[str] = None,
48
156
  log_level: str = "INFO",
49
157
  ) -> None:
50
- if url is None:
51
- url = os.getenv("KUMO_API_URL", "https://kumorfm.ai/api")
158
+ with global_state._lock:
159
+ if global_state._initialized:
160
+ if url != global_state._url:
161
+ raise ValueError(
162
+ "Kumo RFM has already been initialized with a different "
163
+ "URL. Re-initialization with a different URL is not "
164
+ "supported.")
165
+ return
166
+
167
+ if url is None:
168
+ url = os.getenv("RFM_API_URL", "https://kumorfm.ai/api")
169
+
170
+ backend, region, endpoint_name = _detect_backend(url)
171
+ if backend == InferenceBackend.REST:
172
+ # Initialize kumoai.global_state
173
+ if (kumoai.global_state.initialized
174
+ and kumoai.global_state._url != url):
175
+ raise ValueError(
176
+ "Kumo AI SDK has already been initialized with different "
177
+ "API URL. Please restart Python interpreter and "
178
+ "initialize via kumoai.rfm.init()")
179
+ kumoai.init(url=url, api_key=api_key,
180
+ snowflake_credentials=snowflake_credentials,
181
+ snowflake_application=snowflake_application,
182
+ log_level=log_level)
183
+ elif backend == InferenceBackend.AWS_SAGEMAKER:
184
+ assert region
185
+ assert endpoint_name
186
+ KumoClient_SageMakerAdapter(region, endpoint_name).authenticate()
187
+ else:
188
+ assert backend == InferenceBackend.LOCAL_SAGEMAKER
189
+ KumoClient_SageMakerProxy_Local(url).authenticate()
52
190
 
53
- kumoai.init(url=url, api_key=api_key,
54
- snowflake_credentials=snowflake_credentials,
55
- snowflake_application=snowflake_application,
56
- log_level=log_level)
191
+ global_state._url = url
192
+ global_state._backend = backend
193
+ global_state._region = region
194
+ global_state._endpoint_name = endpoint_name
195
+ global_state._initialized = True
196
+ logger.info("Kumo RFM initialized with backend: %s, url: %s", backend,
197
+ url)
57
198
 
58
199
 
59
200
  __all__ = [
60
201
  'LocalTable',
61
202
  'LocalGraph',
62
203
  'KumoRFM',
204
+ 'ExplainConfig',
205
+ 'Explanation',
63
206
  'authenticate',
64
207
  'init',
65
208
  ]
@@ -2,6 +2,7 @@ import re
2
2
  import warnings
3
3
 
4
4
  import pandas as pd
5
+ from dateutil.parser import UnknownTimezoneWarning
5
6
  from kumoapi.typing import Dtype, Stype
6
7
 
7
8
 
@@ -20,9 +21,7 @@ def contains_timestamp(ser: pd.Series, column_name: str, dtype: Dtype) -> bool:
20
21
  column_name,
21
22
  re.IGNORECASE,
22
23
  )
23
-
24
- if match is not None:
25
- return True
24
+ score = 0.3 if match is not None else 0.0
26
25
 
27
26
  ser = ser.iloc[:100]
28
27
  ser = ser.dropna()
@@ -34,5 +33,9 @@ def contains_timestamp(ser: pd.Series, column_name: str, dtype: Dtype) -> bool:
34
33
  ser = ser.astype(str) # Avoid parsing numbers as unix timestamps.
35
34
 
36
35
  with warnings.catch_warnings():
36
+ warnings.simplefilter('ignore', UnknownTimezoneWarning)
37
37
  warnings.filterwarnings('ignore', message='Could not infer format')
38
- return pd.to_datetime(ser, errors='coerce').notna().all()
38
+ mask = pd.to_datetime(ser, errors='coerce').notna()
39
+ score += int(mask.sum()) / len(mask)
40
+
41
+ return score >= 1.0