maxcembalest commited on
Commit
57b73fd
·
1 Parent(s): faa95b0

Delete files/arthur-docs-markdown/sdk

Browse files
This view is limited to 50 files because it contains too many changes.   See raw diff
Files changed (50) hide show
  1. files/arthur-docs-markdown/sdk/arthurai.client.apiv3.md.txt +0 -419
  2. files/arthur-docs-markdown/sdk/arthurai.client.client.ArthurAI.md.txt +0 -650
  3. files/arthur-docs-markdown/sdk/arthurai.client.client.md.txt +0 -443
  4. files/arthur-docs-markdown/sdk/arthurai.client.client.new_requests_client.md.txt +0 -410
  5. files/arthur-docs-markdown/sdk/arthurai.client.helper.construct_url.md.txt +0 -430
  6. files/arthur-docs-markdown/sdk/arthurai.client.helper.get_auth_info.md.txt +0 -431
  7. files/arthur-docs-markdown/sdk/arthurai.client.helper.get_current_org.md.txt +0 -426
  8. files/arthur-docs-markdown/sdk/arthurai.client.helper.md.txt +0 -416
  9. files/arthur-docs-markdown/sdk/arthurai.client.helper.user_login.md.txt +0 -427
  10. files/arthur-docs-markdown/sdk/arthurai.client.http.arthur.ArthurHTTPClient.md.txt +0 -568
  11. files/arthur-docs-markdown/sdk/arthurai.client.http.base.AbstractHTTPClient.md.txt +0 -424
  12. files/arthur-docs-markdown/sdk/arthurai.client.http.md.txt +0 -411
  13. files/arthur-docs-markdown/sdk/arthurai.client.http.requests.md.txt +0 -412
  14. files/arthur-docs-markdown/sdk/arthurai.client.md.txt +0 -416
  15. files/arthur-docs-markdown/sdk/arthurai.client.validation.md.txt +0 -413
  16. files/arthur-docs-markdown/sdk/arthurai.client.validation.validate_multistatus_response_and_get_failures.md.txt +0 -453
  17. files/arthur-docs-markdown/sdk/arthurai.client.validation.validate_response_status.md.txt +0 -419
  18. files/arthur-docs-markdown/sdk/arthurai.common.constants.AccuracyMetric.md.txt +0 -442
  19. files/arthur-docs-markdown/sdk/arthurai.common.constants.Enrichment.md.txt +0 -445
  20. files/arthur-docs-markdown/sdk/arthurai.common.constants.ImageContentType.md.txt +0 -445
  21. files/arthur-docs-markdown/sdk/arthurai.common.constants.ImageResponseType.md.txt +0 -445
  22. files/arthur-docs-markdown/sdk/arthurai.common.constants.InputType.md.txt +0 -441
  23. files/arthur-docs-markdown/sdk/arthurai.common.constants.OutputType.md.txt +0 -442
  24. files/arthur-docs-markdown/sdk/arthurai.common.constants.Role.md.txt +0 -441
  25. files/arthur-docs-markdown/sdk/arthurai.common.constants.Stage.md.txt +0 -444
  26. files/arthur-docs-markdown/sdk/arthurai.common.constants.TextDelimiter.md.txt +0 -507
  27. files/arthur-docs-markdown/sdk/arthurai.common.constants.ValueType.md.txt +0 -446
  28. files/arthur-docs-markdown/sdk/arthurai.common.constants.md.txt +0 -422
  29. files/arthur-docs-markdown/sdk/arthurai.common.exceptions.arthur_excepted.md.txt +0 -410
  30. files/arthur-docs-markdown/sdk/arthurai.common.exceptions.md.txt +0 -438
  31. files/arthur-docs-markdown/sdk/arthurai.common.log.InfoFilter.md.txt +0 -433
  32. files/arthur-docs-markdown/sdk/arthurai.common.log.disable_debug_logging.md.txt +0 -407
  33. files/arthur-docs-markdown/sdk/arthurai.common.log.enable_debug_logging.md.txt +0 -407
  34. files/arthur-docs-markdown/sdk/arthurai.common.log.initialize_logging.md.txt +0 -406
  35. files/arthur-docs-markdown/sdk/arthurai.common.log.md.txt +0 -441
  36. files/arthur-docs-markdown/sdk/arthurai.common.md.txt +0 -414
  37. files/arthur-docs-markdown/sdk/arthurai.core.alerts.Alert.md.txt +0 -522
  38. files/arthur-docs-markdown/sdk/arthurai.core.alerts.AlertRule.md.txt +0 -522
  39. files/arthur-docs-markdown/sdk/arthurai.core.alerts.AlertRuleBound.md.txt +0 -440
  40. files/arthur-docs-markdown/sdk/arthurai.core.alerts.AlertRuleSeverity.md.txt +0 -440
  41. files/arthur-docs-markdown/sdk/arthurai.core.alerts.AlertStatus.md.txt +0 -440
  42. files/arthur-docs-markdown/sdk/arthurai.core.alerts.Metric.md.txt +0 -518
  43. files/arthur-docs-markdown/sdk/arthurai.core.alerts.md.txt +0 -418
  44. files/arthur-docs-markdown/sdk/arthurai.core.attributes.AttributeBin.md.txt +0 -520
  45. files/arthur-docs-markdown/sdk/arthurai.core.attributes.AttributeCategory.md.txt +0 -517
  46. files/arthur-docs-markdown/sdk/arthurai.core.attributes.md.txt +0 -414
  47. files/arthur-docs-markdown/sdk/arthurai.core.auth_info.AuthInfo.md.txt +0 -521
  48. files/arthur-docs-markdown/sdk/arthurai.core.base.md.txt +0 -412
  49. files/arthur-docs-markdown/sdk/arthurai.core.bias.bias_metrics.BiasMetrics.md.txt +0 -495
  50. files/arthur-docs-markdown/sdk/arthurai.core.bias.bias_metrics.md.txt +0 -412
files/arthur-docs-markdown/sdk/arthurai.client.apiv3.md.txt DELETED
@@ -1,419 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.client.apiv3 - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](#)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.client.apiv3[#](#module-arthurai.client.apiv3 "Permalink to this headline")
360
- ====================================================================================
361
-
362
-
363
- SDK Version 2 backward compatibility
364
-
365
-
366
- This convenience module provides compatibility with the ArthurAI SDK version 2.x, but is considered deprecated. Please
367
- update your import paths according to the following:
368
-
369
-
370
- * arthurai.client.apiv3.InputType → arthurai.common.constants.InputType
371
- * arthurai.client.apiv3.OutputType → arthurai.common.constants.OutputType
372
- * arthurai.client.apiv3.ValueType → arthurai.common.constants.ValueType
373
- * arthurai.client.apiv3.Stage → arthurai.common.constants.Stage
374
- * arthurai.client.apiv3.TextDelimiter → arthurai.common.constants.TextDelimiter
375
- * arthurai.client.apiv3.ListableStrEnum → arthurai.common.constants.ListableStrEnum
376
- * arthurai.client.apiv3.AttributeCategory → arthurai.core.attributes.AttributeCategory
377
- * arthurai.client.apiv3.AttributeBin → arthurai.core.attributes.AttributeBin
378
- * arthurai.client.apiv3.arthur\_explainer → arthurai.explainability.arthur\_explainer
379
- * arthurai.client.apiv3.decorators → arthurai.core.decorators
380
- * arthurai.client.apiv3.explanation\_packager → arthurai.explainability.explanation\_packager
381
-
382
-
383
-
384
-
385
-
386
-
387
-
388
- [Next
389
-
390
- arthurai.client.client](arthurai.client.client.html)
391
- [Previous
392
-
393
- arthurai.client](arthurai.client.html)
394
-
395
-
396
-
397
-
398
- Copyright © 2022, Arthur
399
-
400
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
401
-
402
- [Furo](https://github.com/pradyunsg/furo)
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
-
411
-
412
-
413
-
414
-
415
-
416
-
417
-
418
-
419
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.client.client.ArthurAI.md.txt DELETED
@@ -1,650 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.client.client.ArthurAI - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](#)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.client.client.ArthurAI[#](#arthurai-client-client-arthurai "Permalink to this headline")
360
- =================================================================================================
361
-
362
-
363
-
364
-
365
- *class* arthurai.client.client.ArthurAI(*config=None*, *verify\_ssl=None*, *url=None*, *access\_key=None*, *offline=False*, *login=None*, *password=None*, *organization\_id=None*)[#](#arthurai.client.client.ArthurAI "Permalink to this definition")
366
- Bases: `object`
367
-
368
-
369
- A client that interacts with Arthur’s servers.
370
-
371
-
372
- Methods
373
-
374
-
375
-
376
-
377
-
378
-
379
-
380
-
381
- | [`create\_service\_account`](#arthurai.client.client.ArthurAI.create_service_account "arthurai.client.client.ArthurAI.create_service_account") | Create a new service account |
382
- | [`get\_current\_org`](#arthurai.client.client.ArthurAI.get_current_org "arthurai.client.client.ArthurAI.get_current_org") | Retrieves the current organization that the client is operating in |
383
- | [`get\_model`](#arthurai.client.client.ArthurAI.get_model "arthurai.client.client.ArthurAI.get_model") | Retrieve an existing model by id |
384
- | [`get\_model\_group`](#arthurai.client.client.ArthurAI.get_model_group "arthurai.client.client.ArthurAI.get_model_group") | (BETA) Retrieve an existing model group by id |
385
- | [`get\_service\_accounts`](#arthurai.client.client.ArthurAI.get_service_accounts "arthurai.client.client.ArthurAI.get_service_accounts") | Retrieve service accounts |
386
- | [`model`](#arthurai.client.client.ArthurAI.model "arthurai.client.client.ArthurAI.model") | Create a new multistage model. |
387
- | [`set\_current\_org`](#arthurai.client.client.ArthurAI.set_current_org "arthurai.client.client.ArthurAI.set_current_org") | Sets the current organization that the client's requests apply to |
388
-
389
-
390
-
391
-
392
-
393
- create\_service\_account(*description*, *role*)[#](#arthurai.client.client.ArthurAI.create_service_account "Permalink to this definition")
394
- Create a new service account
395
-
396
-
397
-
398
- Parameters
399
- * **description** (`str`) – the description for the new service account
400
- * **role** ([`Role`](arthurai.common.constants.Role.html#arthurai.common.constants.Role "arthurai.common.constants.Role")) – the Role of the new service account
401
-
402
-
403
-
404
- Returns
405
- parsed response in the following format:
406
-
407
-
408
-
409
- ```
410
- {
411
- "id": "<service account id>",
412
- "organization\_id": "<organization id>",
413
- "description": "<service account description>",
414
- "token": "<service account api key>"
415
- }
416
-
417
- ```
418
-
419
-
420
-
421
-
422
-
423
-
424
-
425
- get\_current\_org()[#](#arthurai.client.client.ArthurAI.get_current_org "Permalink to this definition")
426
- Retrieves the current organization that the client is operating in
427
-
428
-
429
-
430
- Return type
431
- `Dict`[`str`, `str`]
432
-
433
-
434
-
435
- Returns
436
- a string with the UUID of the current organization
437
-
438
-
439
-
440
- Permissions
441
- N/A
442
-
443
-
444
-
445
-
446
-
447
-
448
-
449
- get\_model(*identifier*, *id\_type='id'*)[#](#arthurai.client.client.ArthurAI.get_model "Permalink to this definition")
450
- Retrieve an existing model by id
451
-
452
-
453
-
454
- Param
455
- identifier: Id to get the model by
456
-
457
-
458
-
459
- Param
460
- id\_type: Type of id the identifier is, possible options are [‘id’, ‘partner\_model\_id’]
461
-
462
-
463
-
464
- Raises
465
- * **ArthurUserError** – failed due to user error
466
- * **ArthurInternalError** – failed due to an internal error
467
-
468
-
469
-
470
- Permissions
471
- model read
472
-
473
-
474
-
475
- Return type
476
- [`ArthurModel`](arthurai.core.models.ArthurModel.html#arthurai.core.models.ArthurModel "arthurai.core.models.ArthurModel")
477
-
478
-
479
-
480
-
481
-
482
-
483
-
484
- get\_model\_group(*id\_or\_model*)[#](#arthurai.client.client.ArthurAI.get_model_group "Permalink to this definition")
485
- (BETA) Retrieve an existing model group by id
486
-
487
-
488
-
489
- Param
490
- identifier: Id to get the model group by
491
-
492
-
493
-
494
- Raises
495
- * **ArthurUserError** – failed due to user error
496
- * **ArthurInternalError** – failed due to an internal error
497
-
498
-
499
-
500
- Permissions
501
- model\_group read
502
-
503
-
504
-
505
- Return type
506
- [`ArthurModelGroup`](arthurai.core.models.ArthurModelGroup.html#arthurai.core.models.ArthurModelGroup "arthurai.core.models.ArthurModelGroup")
507
-
508
-
509
-
510
-
511
-
512
-
513
-
514
- get\_service\_accounts(*description=None*)[#](#arthurai.client.client.ArthurAI.get_service_accounts "Permalink to this definition")
515
- Retrieve service accounts
516
-
517
-
518
-
519
- Parameters
520
- **description** (`Optional`[`str`]) – an optional description that returned account should match
521
-
522
-
523
-
524
- Returns
525
- parsed response containing a list of service accounts, in the following format:
526
-
527
-
528
-
529
- ```
530
- [
531
- {
532
- "id": "<service account id>",
533
- "organization\_id": "<organization id>",
534
- "description": "<service account description>",
535
- "token": "<service account api key>"
536
- }
537
- ]
538
-
539
- ```
540
-
541
-
542
-
543
-
544
-
545
-
546
-
547
- model(*partner\_model\_id*, *input\_type*, *output\_type=None*, *model\_type=None*, *display\_name=None*, *description=None*, *tags=None*, *classifier\_threshold=None*, *is\_batch=False*, *text\_delimiter=None*, *expected\_throughput\_gb\_per\_day=None*, *pixel\_height=None*, *pixel\_width=None*)[#](#arthurai.client.client.ArthurAI.model "Permalink to this definition")
548
- Create a new multistage model.
549
-
550
-
551
-
552
- Parameters
553
- * **partner\_model\_id** (`str`) – The string external id of the model
554
- * **input\_type** ([`InputType`](arthurai.common.constants.InputType.html#arthurai.common.constants.InputType "arthurai.common.constants.InputType")) – the [`InputType`](arthurai.common.constants.InputType.html#arthurai.common.constants.InputType "arthurai.common.constants.InputType")
555
- * **output\_type** (`Optional`[[`OutputType`](arthurai.common.constants.OutputType.html#arthurai.common.constants.OutputType "arthurai.common.constants.OutputType")]) – the [`OutputType`](arthurai.common.constants.OutputType.html#arthurai.common.constants.OutputType "arthurai.common.constants.OutputType")
556
- * **model\_type** (`Optional`[[`OutputType`](arthurai.common.constants.OutputType.html#arthurai.common.constants.OutputType "arthurai.common.constants.OutputType")]) –
557
-
558
-
559
- Deprecated since version version: 2.0.0 Use output\_type instead.
560
- * **display\_name** (`Optional`[`str`]) – Optional name to display on dashboard, will default to the external id
561
- * **description** (`Optional`[`str`]) – Optional description for the model
562
- * **tags** (`Optional`[`List`[`str`]]) – A list of string tags to associate with the model
563
- * **classifier\_threshold** (`Optional`[`float`]) – For binary classification models this is the threshold to determine a positive class, defaults to 0.5
564
- * **is\_batch** (`bool`) – boolean value which signifies whether the model sends inferences by batch or streaming
565
- * **text\_delimiter** (`Optional`[[`TextDelimiter`](arthurai.common.constants.TextDelimiter.html#arthurai.common.constants.TextDelimiter "arthurai.common.constants.TextDelimiter")]) – TextDelimiter used in NLP models to split documents into tokens for explanations
566
- * **expected\_throughput\_gb\_per\_day** (`Optional`[`int`]) – Expected amount of throughput. Used to provision resources
567
- * **pixel\_height** (`Optional`[`int`]) – Image height in pixels. Needed for CV models which require images to be one size
568
- * **pixel\_width** (`Optional`[`int`]) – Image width in pixels. Needed for CV models which require images to be one size
569
-
570
-
571
-
572
- Return type
573
- [`ArthurModel`](arthurai.core.models.ArthurModel.html#arthurai.core.models.ArthurModel "arthurai.core.models.ArthurModel")
574
-
575
-
576
-
577
- Returns
578
- An `ArthurModel`
579
-
580
-
581
-
582
-
583
-
584
-
585
-
586
- set\_current\_org(*org\_id*)[#](#arthurai.client.client.ArthurAI.set_current_org "Permalink to this definition")
587
- Sets the current organization that the client’s requests apply to
588
-
589
-
590
-
591
- Parameters
592
- **org\_id** (`str`) – The ID of the organization to set
593
-
594
-
595
-
596
- Return type
597
- `None`
598
-
599
-
600
-
601
- Returns
602
- None
603
-
604
-
605
-
606
- Permissions
607
- N/A
608
-
609
-
610
-
611
-
612
-
613
-
614
-
615
-
616
-
617
-
618
-
619
- [Next
620
-
621
- arthurai.client.helper](arthurai.client.helper.html)
622
- [Previous
623
-
624
- arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
625
-
626
-
627
-
628
-
629
- Copyright © 2022, Arthur
630
-
631
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
632
-
633
- [Furo](https://github.com/pradyunsg/furo)
634
-
635
-
636
-
637
-
638
-
639
-
640
-
641
-
642
-
643
-
644
-
645
-
646
-
647
-
648
-
649
-
650
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.client.client.md.txt DELETED
@@ -1,443 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.client.client - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](#)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.client.client[#](#module-arthurai.client.client "Permalink to this headline")
360
- ======================================================================================
361
-
362
-
363
- Functions
364
-
365
-
366
-
367
-
368
-
369
-
370
-
371
-
372
- | [`new\_requests\_client`](arthurai.client.client.new_requests_client.html#arthurai.client.client.new_requests_client "arthurai.client.client.new_requests_client")([access\_key, url, ...]) |
373
- rtype
374
- [`HTTPClient`](arthurai.client.http.requests.HTTPClient.html#arthurai.client.http.requests.HTTPClient "arthurai.client.http.requests.HTTPClient")
375
-
376
- |
377
-
378
-
379
-
380
- Classes
381
-
382
-
383
-
384
-
385
-
386
-
387
-
388
-
389
- | [`ArthurAI`](arthurai.client.client.ArthurAI.html#arthurai.client.client.ArthurAI "arthurai.client.client.ArthurAI")([config, verify\_ssl, url, ...]) | A client that interacts with Arthur's servers. |
390
-
391
-
392
-
393
-
394
-
395
-
396
-
397
-
398
- [Next
399
-
400
- arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
401
- [Previous
402
-
403
- arthurai.client.apiv3](arthurai.client.apiv3.html)
404
-
405
-
406
-
407
-
408
- Copyright © 2022, Arthur
409
-
410
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
411
-
412
- [Furo](https://github.com/pradyunsg/furo)
413
-
414
-
415
-
416
-
417
-
418
-
419
-
420
-
421
-
422
-
423
-
424
-
425
- On this page
426
-
427
-
428
-
429
-
430
- * [arthurai.client.client](#)
431
-
432
-
433
-
434
-
435
-
436
-
437
-
438
-
439
-
440
-
441
-
442
-
443
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.client.client.new_requests_client.md.txt DELETED
@@ -1,410 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.client.client.new\_requests\_client - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](#)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.client.client.new\_requests\_client[#](#arthurai-client-client-new-requests-client "Permalink to this headline")
360
- =========================================================================================================================
361
-
362
-
363
-
364
-
365
- arthurai.client.client.new\_requests\_client(*access\_key=None*, *url=None*, *verify\_ssl=True*, *offline=False*, *organization\_id=None*)[#](#arthurai.client.client.new_requests_client "Permalink to this definition")
366
-
367
- Return type
368
- [`HTTPClient`](arthurai.client.http.requests.HTTPClient.html#arthurai.client.http.requests.HTTPClient "arthurai.client.http.requests.HTTPClient")
369
-
370
-
371
-
372
-
373
-
374
-
375
-
376
-
377
-
378
-
379
- [Next
380
-
381
- arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
382
- [Previous
383
-
384
- arthurai.client.client](arthurai.client.client.html)
385
-
386
-
387
-
388
-
389
- Copyright © 2022, Arthur
390
-
391
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
392
-
393
- [Furo](https://github.com/pradyunsg/furo)
394
-
395
-
396
-
397
-
398
-
399
-
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.client.helper.construct_url.md.txt DELETED
@@ -1,430 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.client.helper.construct\_url - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](#)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.client.helper.construct\_url[#](#arthurai-client-helper-construct-url "Permalink to this headline")
360
- ============================================================================================================
361
-
362
-
363
-
364
-
365
- arthurai.client.helper.construct\_url(*\*parts*, *validate=True*, *default\_https=True*)[#](#arthurai.client.helper.construct_url "Permalink to this definition")
366
- Construct a url from various parts
367
-
368
-
369
- Useful for joining pieces which may or may not have leading and/or trailing
370
- slashes. e.g. construct\_url(”<http://arthur.ai/>”, “/api/v3”, “/users”) will yield the same valid url as
371
- construct\_url(”<http://arthur.ai>”, “api/v3/”, “users/”).
372
-
373
-
374
-
375
- Parameters
376
- * **validate** – if True, validate that the URL is valid
377
- * **default\_https** – if True, allow urls without a scheme and use https by default
378
- * **parts** (`str`) – strings from which to construct the url
379
-
380
-
381
-
382
- Return type
383
- `str`
384
-
385
-
386
-
387
- Returns
388
- a fully joined url
389
-
390
-
391
-
392
-
393
-
394
-
395
-
396
-
397
-
398
-
399
- [Next
400
-
401
- arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
402
- [Previous
403
-
404
- arthurai.client.helper](arthurai.client.helper.html)
405
-
406
-
407
-
408
-
409
- Copyright © 2022, Arthur
410
-
411
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
412
-
413
- [Furo](https://github.com/pradyunsg/furo)
414
-
415
-
416
-
417
-
418
-
419
-
420
-
421
-
422
-
423
-
424
-
425
-
426
-
427
-
428
-
429
-
430
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.client.helper.get_auth_info.md.txt DELETED
@@ -1,431 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.client.helper.get\_auth\_info - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](#)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.client.helper.get\_auth\_info[#](#arthurai-client-helper-get-auth-info "Permalink to this headline")
360
- =============================================================================================================
361
-
362
-
363
-
364
-
365
- arthurai.client.helper.get\_auth\_info(*api\_http\_host*, *api\_prefix*, *access\_key*, *verify\_ssl=True*)[#](#arthurai.client.helper.get_auth_info "Permalink to this definition")
366
- Get the AuthInfo struct associated with the provided access key
367
-
368
-
369
-
370
- Parameters
371
- * **api\_http\_host** (`str`) – base url of the host to connect to, including protocol (e.g. “<https://app.arthur.ai>”)
372
- * **api\_prefix** (`str`) – prefix of the API to connect to (e.g. “/api/v3”)
373
- * **access\_key** (`str`) – API token to pass to the API
374
- * **verify\_ssl** (`bool`) – Boolean for whether requests should verify that the SSL certificate is valid and not self-signed
375
-
376
-
377
-
378
- Return type
379
- `Optional`[[`AuthInfo`](arthurai.core.auth_info.AuthInfo.html#arthurai.core.auth_info.AuthInfo "arthurai.core.auth_info.AuthInfo")]
380
-
381
-
382
-
383
- Returns
384
- the AuthInfo associated with the provided access key
385
-
386
-
387
-
388
- Permissions
389
- N/A
390
-
391
-
392
-
393
-
394
-
395
-
396
-
397
-
398
-
399
-
400
- [Next
401
-
402
- arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
403
- [Previous
404
-
405
- arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
406
-
407
-
408
-
409
-
410
- Copyright © 2022, Arthur
411
-
412
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
413
-
414
- [Furo](https://github.com/pradyunsg/furo)
415
-
416
-
417
-
418
-
419
-
420
-
421
-
422
-
423
-
424
-
425
-
426
-
427
-
428
-
429
-
430
-
431
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.client.helper.get_current_org.md.txt DELETED
@@ -1,426 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.client.helper.get\_current\_org - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](#)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.client.helper.get\_current\_org[#](#arthurai-client-helper-get-current-org "Permalink to this headline")
360
- =================================================================================================================
361
-
362
-
363
-
364
-
365
- arthurai.client.helper.get\_current\_org(*api\_http\_host*, *api\_prefix*, *access\_key*, *verify\_ssl=True*)[#](#arthurai.client.helper.get_current_org "Permalink to this definition")
366
- Get the current organization for the provided access key
367
-
368
-
369
-
370
- Parameters
371
- * **api\_http\_host** (`str`) – base url of the host to connect to, including protocol (e.g. “<https://app.arthur.ai>”)
372
- * **api\_prefix** (`str`) – prefix of the API to connect to (e.g. “/api/v3”)
373
- * **access\_key** (`str`) – API Key to pass to the API
374
- * **verify\_ssl** (`bool`) – Boolean for whether requests should verify that the SSL certificate is valid and not self-signed
375
-
376
-
377
-
378
- Return type
379
- `Optional`[`str`]
380
-
381
-
382
-
383
- Returns
384
- the organization ID associated with the provided access key, None if no such organization exists
385
-
386
-
387
-
388
-
389
-
390
-
391
-
392
-
393
-
394
-
395
- [Next
396
-
397
- arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
398
- [Previous
399
-
400
- arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
401
-
402
-
403
-
404
-
405
- Copyright © 2022, Arthur
406
-
407
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
408
-
409
- [Furo](https://github.com/pradyunsg/furo)
410
-
411
-
412
-
413
-
414
-
415
-
416
-
417
-
418
-
419
-
420
-
421
-
422
-
423
-
424
-
425
-
426
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.client.helper.md.txt DELETED
@@ -1,416 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.client.helper - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](#)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.client.helper[#](#module-arthurai.client.helper "Permalink to this headline")
360
- ======================================================================================
361
-
362
-
363
- Functions
364
-
365
-
366
-
367
-
368
-
369
-
370
-
371
-
372
- | [`construct\_url`](arthurai.client.helper.construct_url.html#arthurai.client.helper.construct_url "arthurai.client.helper.construct_url")(\*parts[, validate, default\_https]) | Construct a url from various parts |
373
- | [`get\_arthur\_internal\_user\_org`](arthurai.client.helper.get_arthur_internal_user_org.html#arthurai.client.helper.get_arthur_internal_user_org "arthurai.client.helper.get_arthur_internal_user_org")(api\_http\_host, ...) | Get the current organization for the provided Arthur access key belonging to an Arthur internal user |
374
- | [`get\_auth\_info`](arthurai.client.helper.get_auth_info.html#arthurai.client.helper.get_auth_info "arthurai.client.helper.get_auth_info")(api\_http\_host, api\_prefix, ...) | Get the AuthInfo struct associated with the provided access key |
375
- | [`get\_current\_org`](arthurai.client.helper.get_current_org.html#arthurai.client.helper.get_current_org "arthurai.client.helper.get_current_org")(api\_http\_host, api\_prefix, ...) | Get the current organization for the provided access key |
376
- | [`user\_login`](arthurai.client.helper.user_login.html#arthurai.client.helper.user_login "arthurai.client.helper.user_login")(api\_http\_host, api\_prefix, login, ...) | Get the current organization for the provided access key |
377
-
378
-
379
-
380
-
381
-
382
-
383
-
384
-
385
- [Next
386
-
387
- arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
388
- [Previous
389
-
390
- arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
391
-
392
-
393
-
394
-
395
- Copyright © 2022, Arthur
396
-
397
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
398
-
399
- [Furo](https://github.com/pradyunsg/furo)
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
-
411
-
412
-
413
-
414
-
415
-
416
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.client.helper.user_login.md.txt DELETED
@@ -1,427 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.client.helper.user\_login - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](#)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.client.helper.user\_login[#](#arthurai-client-helper-user-login "Permalink to this headline")
360
- ======================================================================================================
361
-
362
-
363
-
364
-
365
- arthurai.client.helper.user\_login(*api\_http\_host*, *api\_prefix*, *login*, *password*, *verify\_ssl=True*)[#](#arthurai.client.helper.user_login "Permalink to this definition")
366
- Get the current organization for the provided access key
367
-
368
-
369
-
370
- Parameters
371
- * **api\_http\_host** (`str`) – base url of the host to connect to, including protocol (e.g. “<https://app.arthur.ai>”)
372
- * **api\_prefix** (`str`) – prefix of the API to connect to (e.g. “/api/v3”)
373
- * **login** (`str`) – the username or password to use to log in
374
- * **password** (`str`) – password for the user
375
- * **verify\_ssl** (`bool`) – Boolean for whether requests should verify that the SSL certificate is valid and not self-signed
376
-
377
-
378
-
379
- Return type
380
- `Tuple`[`str`, `Dict`[`str`, `Any`]]
381
-
382
-
383
-
384
- Returns
385
- a tuple of (access\_key, {user object})
386
-
387
-
388
-
389
-
390
-
391
-
392
-
393
-
394
-
395
-
396
- [Next
397
-
398
- arthurai.client.http](arthurai.client.http.html)
399
- [Previous
400
-
401
- arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
402
-
403
-
404
-
405
-
406
- Copyright © 2022, Arthur
407
-
408
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
409
-
410
- [Furo](https://github.com/pradyunsg/furo)
411
-
412
-
413
-
414
-
415
-
416
-
417
-
418
-
419
-
420
-
421
-
422
-
423
-
424
-
425
-
426
-
427
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.client.http.arthur.ArthurHTTPClient.md.txt DELETED
@@ -1,568 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.client.http.arthur.ArthurHTTPClient - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](#)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.client.http.arthur.ArthurHTTPClient[#](#arthurai-client-http-arthur-arthurhttpclient "Permalink to this headline")
360
- ===========================================================================================================================
361
-
362
-
363
-
364
-
365
- *class* arthurai.client.http.arthur.ArthurHTTPClient(*access\_key=None*, *url=None*, *base\_path=None*, *thread\_workers=10*, *verify\_ssl=True*, *offline=False*)[#](#arthurai.client.http.arthur.ArthurHTTPClient "Permalink to this definition")
366
- Bases: [`arthurai.client.http.base.AbstractHTTPClient`](arthurai.client.http.base.AbstractHTTPClient.html#arthurai.client.http.base.AbstractHTTPClient "arthurai.client.http.base.AbstractHTTPClient")
367
-
368
-
369
- An HTTPClient that uses Arthur-specific parameters
370
-
371
-
372
-
373
- Deprecated since version 3.13.1.
374
-
375
-
376
-
377
- Methods
378
-
379
-
380
-
381
-
382
-
383
-
384
-
385
-
386
- | [`async\_call`](#arthurai.client.http.arthur.ArthurHTTPClient.async_call "arthurai.client.http.arthur.ArthurHTTPClient.async_call") | Starts a new process asynchronously |
387
- | [`delete`](#arthurai.client.http.arthur.ArthurHTTPClient.delete "arthurai.client.http.arthur.ArthurHTTPClient.delete") | Sends a DELETE request to the given url with the given headers |
388
- | [`get`](#arthurai.client.http.arthur.ArthurHTTPClient.get "arthurai.client.http.arthur.ArthurHTTPClient.get") | Sends a GET request to the given url with the given headers :param retries: Number of times to retry the request if it results in a 400 or higher response code :param return\_raw\_response: If true do not filter response, return raw object :param url: url to send request to :param headers: headers to use in the request :return: response of the rest call |
389
- | [`patch`](#arthurai.client.http.arthur.ArthurHTTPClient.patch "arthurai.client.http.arthur.ArthurHTTPClient.patch") | Sends a PATCH request to the given url with the given headers |
390
- | [`post`](#arthurai.client.http.arthur.ArthurHTTPClient.post "arthurai.client.http.arthur.ArthurHTTPClient.post") | Sends a POST request to the given url with the given headers |
391
- | [`put`](#arthurai.client.http.arthur.ArthurHTTPClient.put "arthurai.client.http.arthur.ArthurHTTPClient.put") | Sends a PUT request to the given url with the given headers :param return\_raw\_response: If true do not filter response, return raw object :param url: url to send request to :param headers: headers to use in the request :param retries: Number of times to retry the request if it results in a 400 or higher response code :return: response of the rest call |
392
- | [`send`](#arthurai.client.http.arthur.ArthurHTTPClient.send "arthurai.client.http.arthur.ArthurHTTPClient.send") | Sends the specified data with headers to the given url with the given request type |
393
-
394
-
395
-
396
-
397
-
398
- *static* async\_call(*rest\_call*, *pool*, *\*args*, *callback=None*)[#](#arthurai.client.http.arthur.ArthurHTTPClient.async_call "Permalink to this definition")
399
- Starts a new process asynchronously
400
-
401
-
402
-
403
- Parameters
404
- * **rest\_call** – a pointer to the rest call which should be executed async
405
- * **pool** – python process pool to take processes from
406
- * **callback** – function which will get called given the response of the child thread
407
-
408
-
409
-
410
- Returns
411
- returns a python AsyncResult object
412
-
413
-
414
-
415
-
416
-
417
-
418
-
419
- delete(*url*, *headers=None*, *return\_raw\_response=False*, *retries=0*)[#](#arthurai.client.http.arthur.ArthurHTTPClient.delete "Permalink to this definition")
420
- Sends a DELETE request to the given url with the given headers
421
-
422
-
423
-
424
- Parameters
425
- * **return\_raw\_response** – If true do not filter response, return raw object
426
- * **url** – url to send request to
427
- * **headers** – headers to use in the request
428
- * **retries** – Number of times to retry the request if it results in a 400 or higher response code
429
-
430
-
431
-
432
- Returns
433
- response of the rest call
434
-
435
-
436
-
437
-
438
-
439
-
440
-
441
- get(*url*, *headers=None*, *params=None*, *return\_raw\_response=False*, *retries=0*)[#](#arthurai.client.http.arthur.ArthurHTTPClient.get "Permalink to this definition")
442
- Sends a GET request to the given url with the given headers
443
- :param retries: Number of times to retry the request if it results in a 400 or higher response code
444
- :param return\_raw\_response: If true do not filter response, return raw object
445
- :param url: url to send request to
446
- :param headers: headers to use in the request
447
- :return: response of the rest call
448
-
449
-
450
-
451
-
452
-
453
- patch(*url*, *json=None*, *files=None*, *headers=None*, *return\_raw\_response=False*, *retries=0*)[#](#arthurai.client.http.arthur.ArthurHTTPClient.patch "Permalink to this definition")
454
- Sends a PATCH request to the given url with the given headers
455
-
456
-
457
-
458
- Parameters
459
- * **return\_raw\_response** – If true do not filter response, return raw object
460
- * **url** – url to send request to
461
- * **headers** – headers to use in the request
462
- * **retries** – Number of times to retry the request if it results in a 400 or higher response code
463
-
464
-
465
-
466
- Returns
467
- response of the rest call
468
-
469
-
470
-
471
-
472
-
473
-
474
-
475
- post(*url*, *json=None*, *files=None*, *headers=None*, *return\_raw\_response=False*, *retries=0*)[#](#arthurai.client.http.arthur.ArthurHTTPClient.post "Permalink to this definition")
476
- Sends a POST request to the given url with the given headers
477
-
478
-
479
-
480
- Parameters
481
- * **return\_raw\_response** – If true do not filter response, return raw object
482
- * **url** – url to send request to
483
- * **headers** – headers to use in the request
484
- * **retries** – Number of times to retry the request if it results in a 400 or higher response code
485
-
486
-
487
-
488
- Returns
489
- response of the rest call
490
-
491
-
492
-
493
-
494
-
495
-
496
-
497
- put(*url*, *json=None*, *files=None*, *headers=None*, *return\_raw\_response=False*, *retries=0*)[#](#arthurai.client.http.arthur.ArthurHTTPClient.put "Permalink to this definition")
498
- Sends a PUT request to the given url with the given headers
499
- :param return\_raw\_response: If true do not filter response, return raw object
500
- :param url: url to send request to
501
- :param headers: headers to use in the request
502
- :param retries: Number of times to retry the request if it results in a 400 or higher response code
503
- :return: response of the rest call
504
-
505
-
506
-
507
-
508
-
509
- send(*url*, *method='GET'*, *json=None*, *files=None*, *params=None*, *headers=None*, *return\_raw\_response=False*, *retries=0*)[#](#arthurai.client.http.arthur.ArthurHTTPClient.send "Permalink to this definition")
510
- Sends the specified data with headers to the given url with the given request type
511
-
512
-
513
-
514
- Parameters
515
- * **retries** – Number of times to retry the request if it results in a 400 or higher response code
516
- * **return\_raw\_response** – If true do not filter request response, return raw object
517
- * **url** – url to send data to
518
- * **method** – REST call type, POST, GET, PUT, DELETE
519
- * **json** – the data to send
520
- * **headers** – headers to use in the REST call
521
-
522
-
523
-
524
- Returns
525
- response of the REST call
526
-
527
-
528
-
529
-
530
-
531
-
532
-
533
-
534
-
535
-
536
-
537
- [Next
538
-
539
- arthurai.client.http.base](arthurai.client.http.base.html)
540
- [Previous
541
-
542
- arthurai.client.http.arthur](arthurai.client.http.arthur.html)
543
-
544
-
545
-
546
-
547
- Copyright © 2022, Arthur
548
-
549
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
550
-
551
- [Furo](https://github.com/pradyunsg/furo)
552
-
553
-
554
-
555
-
556
-
557
-
558
-
559
-
560
-
561
-
562
-
563
-
564
-
565
-
566
-
567
-
568
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.client.http.base.AbstractHTTPClient.md.txt DELETED
@@ -1,424 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.client.http.base.AbstractHTTPClient - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](#)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.client.http.base.AbstractHTTPClient[#](#arthurai-client-http-base-abstracthttpclient "Permalink to this headline")
360
- ===========================================================================================================================
361
-
362
-
363
-
364
-
365
- *class* arthurai.client.http.base.AbstractHTTPClient[#](#arthurai.client.http.base.AbstractHTTPClient "Permalink to this definition")
366
- Bases: `object`
367
-
368
-
369
- Methods
370
-
371
-
372
-
373
-
374
-
375
-
376
-
377
-
378
- | `delete` | |
379
- | `get` | |
380
- | `patch` | |
381
- | `post` | |
382
- | `put` | |
383
- | `send` | |
384
-
385
-
386
-
387
-
388
-
389
-
390
-
391
-
392
-
393
- [Next
394
-
395
- arthurai.client.http.requests](arthurai.client.http.requests.html)
396
- [Previous
397
-
398
- arthurai.client.http.base](arthurai.client.http.base.html)
399
-
400
-
401
-
402
-
403
- Copyright © 2022, Arthur
404
-
405
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
406
-
407
- [Furo](https://github.com/pradyunsg/furo)
408
-
409
-
410
-
411
-
412
-
413
-
414
-
415
-
416
-
417
-
418
-
419
-
420
-
421
-
422
-
423
-
424
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.client.http.md.txt DELETED
@@ -1,411 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.client.http - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](#)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.client.http[#](#module-arthurai.client.http "Permalink to this headline")
360
- ==================================================================================
361
-
362
-
363
-
364
-
365
-
366
-
367
-
368
-
369
- | [`arthurai.client.http.arthur`](arthurai.client.http.arthur.html#module-arthurai.client.http.arthur "arthurai.client.http.arthur") | |
370
- | [`arthurai.client.http.base`](arthurai.client.http.base.html#module-arthurai.client.http.base "arthurai.client.http.base") | |
371
- | [`arthurai.client.http.requests`](arthurai.client.http.requests.html#module-arthurai.client.http.requests "arthurai.client.http.requests") | |
372
-
373
-
374
-
375
-
376
-
377
-
378
-
379
-
380
- [Next
381
-
382
- arthurai.client.http.arthur](arthurai.client.http.arthur.html)
383
- [Previous
384
-
385
- arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
386
-
387
-
388
-
389
-
390
- Copyright © 2022, Arthur
391
-
392
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
393
-
394
- [Furo](https://github.com/pradyunsg/furo)
395
-
396
-
397
-
398
-
399
-
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
-
411
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.client.http.requests.md.txt DELETED
@@ -1,412 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.client.http.requests - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](#)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.client.http.requests[#](#module-arthurai.client.http.requests "Permalink to this headline")
360
- ====================================================================================================
361
-
362
-
363
- Classes
364
-
365
-
366
-
367
-
368
-
369
-
370
-
371
-
372
- | [`HTTPClient`](arthurai.client.http.requests.HTTPClient.html#arthurai.client.http.requests.HTTPClient "arthurai.client.http.requests.HTTPClient")(base\_url[, path\_prefix, ...]) | A requests-based HTTP Client intended for interacting with JSON-based APIs. |
373
-
374
-
375
-
376
-
377
-
378
-
379
-
380
-
381
- [Next
382
-
383
- arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
384
- [Previous
385
-
386
- arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
387
-
388
-
389
-
390
-
391
- Copyright © 2022, Arthur
392
-
393
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
394
-
395
- [Furo](https://github.com/pradyunsg/furo)
396
-
397
-
398
-
399
-
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
-
411
-
412
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.client.md.txt DELETED
@@ -1,416 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.client - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](#)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.client[#](#module-arthurai.client "Permalink to this headline")
360
- ========================================================================
361
-
362
-
363
- Arthur HTTP client and general (non-model) functions
364
-
365
-
366
-
367
-
368
-
369
-
370
-
371
-
372
- | [`arthurai.client.apiv3`](arthurai.client.apiv3.html#module-arthurai.client.apiv3 "arthurai.client.apiv3") | SDK Version 2 backward compatibility |
373
- | [`arthurai.client.client`](arthurai.client.client.html#module-arthurai.client.client "arthurai.client.client") | |
374
- | [`arthurai.client.helper`](arthurai.client.helper.html#module-arthurai.client.helper "arthurai.client.helper") | |
375
- | [`arthurai.client.http`](arthurai.client.http.html#module-arthurai.client.http "arthurai.client.http") | |
376
- | [`arthurai.client.validation`](arthurai.client.validation.html#module-arthurai.client.validation "arthurai.client.validation") | |
377
-
378
-
379
-
380
-
381
-
382
-
383
-
384
-
385
- [Next
386
-
387
- arthurai.client.apiv3](arthurai.client.apiv3.html)
388
- [Previous
389
-
390
- arthurai](arthurai.html)
391
-
392
-
393
-
394
-
395
- Copyright © 2022, Arthur
396
-
397
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
398
-
399
- [Furo](https://github.com/pradyunsg/furo)
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
-
411
-
412
-
413
-
414
-
415
-
416
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.client.validation.md.txt DELETED
@@ -1,413 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.client.validation - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](#)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.client.validation[#](#module-arthurai.client.validation "Permalink to this headline")
360
- ==============================================================================================
361
-
362
-
363
- Functions
364
-
365
-
366
-
367
-
368
-
369
-
370
-
371
-
372
- | [`validate\_multistatus\_response\_and\_get\_failures`](arthurai.client.validation.validate_multistatus_response_and_get_failures.html#arthurai.client.validation.validate_multistatus_response_and_get_failures "arthurai.client.validation.validate_multistatus_response_and_get_failures")(...) | Validate a 207 MultiStatus response and return the failures it contains. |
373
- | [`validate\_response\_status`](arthurai.client.validation.validate_response_status.html#arthurai.client.validation.validate_response_status "arthurai.client.validation.validate_response_status")(response\_or\_code[, ...]) | Validate the status code of a requests.Response object or (int) status code. |
374
-
375
-
376
-
377
-
378
-
379
-
380
-
381
-
382
- [Next
383
-
384
- arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
385
- [Previous
386
-
387
- arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
388
-
389
-
390
-
391
-
392
- Copyright © 2022, Arthur
393
-
394
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
395
-
396
- [Furo](https://github.com/pradyunsg/furo)
397
-
398
-
399
-
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
-
411
-
412
-
413
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.client.validation.validate_multistatus_response_and_get_failures.md.txt DELETED
@@ -1,453 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](#)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures[#](#arthurai-client-validation-validate-multistatus-response-and-get-failures "Permalink to this headline")
360
- ==========================================================================================================================================================================================
361
-
362
-
363
-
364
-
365
- arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures(*response*, *raise\_on\_failures=False*)[#](#arthurai.client.validation.validate_multistatus_response_and_get_failures "Permalink to this definition")
366
- Validate a 207 MultiStatus response and return the failures it contains.
367
-
368
-
369
-
370
- Parameters
371
- * **response** (`Response`) –
372
-
373
- requests.Response object to validate, with the following body format:
374
-
375
-
376
-
377
- ```
378
- {
379
- "counts": {
380
- "success": 0,
381
- "failure": 0,
382
- "total": 0
383
- },
384
- "results": [
385
- {
386
- "message": "success",
387
- "status": 200
388
- }
389
- ]
390
- }
391
-
392
- ```
393
- * **raise\_on\_failures** (`bool`) – if True, raise an exception if the response contains any failures
394
-
395
-
396
-
397
- Return type
398
- `Tuple`[`List`[`dict`], `List`[`dict`]]
399
-
400
-
401
-
402
- Returns
403
- a tuple of two lists: user-caused failures and internal failures
404
-
405
-
406
-
407
- Raises
408
- * **ArthurInternalValueError** – If the response does not have 207 status code, or is incorrectly formatted,
409
- or ‘counts’ and ‘results’ do not agree
410
- * **ResponseClientError** – if raise\_on\_failures and the response contains only client errors
411
- * **ResponseServerError** – if raise\_on\_failures and the response contains server errors
412
-
413
-
414
-
415
-
416
-
417
-
418
-
419
-
420
-
421
-
422
- [Next
423
-
424
- arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
425
- [Previous
426
-
427
- arthurai.client.validation](arthurai.client.validation.html)
428
-
429
-
430
-
431
-
432
- Copyright © 2022, Arthur
433
-
434
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
435
-
436
- [Furo](https://github.com/pradyunsg/furo)
437
-
438
-
439
-
440
-
441
-
442
-
443
-
444
-
445
-
446
-
447
-
448
-
449
-
450
-
451
-
452
-
453
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.client.validation.validate_response_status.md.txt DELETED
@@ -1,419 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.client.validation.validate\_response\_status - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](#)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.client.validation.validate\_response\_status[#](#arthurai-client-validation-validate-response-status "Permalink to this headline")
360
- ===========================================================================================================================================
361
-
362
-
363
-
364
-
365
- arthurai.client.validation.validate\_response\_status(*response\_or\_code*, *expected\_status\_code=None*, *allow\_redirects=False*)[#](#arthurai.client.validation.validate_response_status "Permalink to this definition")
366
- Validate the status code of a requests.Response object or (int) status code.
367
- :type response\_or\_code: `Union`[`Response`, `int`]
368
- :param response\_or\_code: the requests.Response object or status code to validate
369
- :type expected\_status\_code: `Optional`[`int`]
370
- :param expected\_status\_code: the expected status code to check for. If None, all codes <300 will be valid, and 3XX
371
- codes will be subject to allow\_redirects
372
- :type allow\_redirects: `Optional`[`bool`]
373
- :param allow\_redirects: if True will not raise an exception for 3XX status codes
374
- :rtype: `None`
375
- :return: None
376
- :raises InternalValueError: if expected\_status\_code is not None and does not match the response code
377
- :raises ResponseServerError: if the response has a 5XX status code
378
- :raises ResponseClientError: if the response has a 4XX status code
379
- :raises ResponseRedirectError: if the response has a 3XX status code
380
-
381
-
382
-
383
-
384
-
385
-
386
-
387
-
388
- [Next
389
-
390
- arthurai.common](arthurai.common.html)
391
- [Previous
392
-
393
- arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
394
-
395
-
396
-
397
-
398
- Copyright © 2022, Arthur
399
-
400
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
401
-
402
- [Furo](https://github.com/pradyunsg/furo)
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
-
411
-
412
-
413
-
414
-
415
-
416
-
417
-
418
-
419
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.common.constants.AccuracyMetric.md.txt DELETED
@@ -1,442 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.common.constants.AccuracyMetric - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](#)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.common.constants.AccuracyMetric[#](#arthurai-common-constants-accuracymetric "Permalink to this headline")
360
- ===================================================================================================================
361
-
362
-
363
-
364
-
365
- *class* arthurai.common.constants.AccuracyMetric[#](#arthurai.common.constants.AccuracyMetric "Permalink to this definition")
366
- Bases: [`arthurai.common.constants.ListableStrEnum`](arthurai.common.constants.ListableStrEnum.html#arthurai.common.constants.ListableStrEnum "arthurai.common.constants.ListableStrEnum")
367
-
368
-
369
- Methods
370
-
371
-
372
-
373
-
374
-
375
-
376
-
377
-
378
- | [`list`](#arthurai.common.constants.AccuracyMetric.list "arthurai.common.constants.AccuracyMetric.list") | Lists all attributes in alphabetical order |
379
-
380
-
381
-
382
- Attributes
383
-
384
-
385
-
386
-
387
-
388
-
389
-
390
-
391
- | `Accuracy` | |
392
- | `F1` | |
393
- | `Precision` | |
394
- | `Recall` | |
395
-
396
-
397
-
398
-
399
-
400
- *classmethod* list()[#](#arthurai.common.constants.AccuracyMetric.list "Permalink to this definition")
401
- Lists all attributes in alphabetical order
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
-
411
- [Next
412
-
413
- arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
414
- [Previous
415
-
416
- arthurai.common.constants](arthurai.common.constants.html)
417
-
418
-
419
-
420
-
421
- Copyright © 2022, Arthur
422
-
423
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
424
-
425
- [Furo](https://github.com/pradyunsg/furo)
426
-
427
-
428
-
429
-
430
-
431
-
432
-
433
-
434
-
435
-
436
-
437
-
438
-
439
-
440
-
441
-
442
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.common.constants.Enrichment.md.txt DELETED
@@ -1,445 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.common.constants.Enrichment - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](#)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.common.constants.Enrichment[#](#arthurai-common-constants-enrichment "Permalink to this headline")
360
- ===========================================================================================================
361
-
362
-
363
-
364
-
365
- *class* arthurai.common.constants.Enrichment[#](#arthurai.common.constants.Enrichment "Permalink to this definition")
366
- Bases: [`arthurai.common.constants.ListableStrEnum`](arthurai.common.constants.ListableStrEnum.html#arthurai.common.constants.ListableStrEnum "arthurai.common.constants.ListableStrEnum")
367
-
368
-
369
- This class contains constants for the names of enrichments
370
-
371
-
372
- Methods
373
-
374
-
375
-
376
-
377
-
378
-
379
-
380
-
381
- | [`list`](#arthurai.common.constants.Enrichment.list "arthurai.common.constants.Enrichment.list") | Lists all attributes in alphabetical order |
382
-
383
-
384
-
385
- Attributes
386
-
387
-
388
-
389
-
390
-
391
-
392
-
393
-
394
- | `AnomalyDetection` | |
395
- | `BiasMitigation` | |
396
- | `Explainability` | |
397
- | `Hotspots` | |
398
-
399
-
400
-
401
-
402
-
403
- *classmethod* list()[#](#arthurai.common.constants.Enrichment.list "Permalink to this definition")
404
- Lists all attributes in alphabetical order
405
-
406
-
407
-
408
-
409
-
410
-
411
-
412
-
413
-
414
- [Next
415
-
416
- arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
417
- [Previous
418
-
419
- arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
420
-
421
-
422
-
423
-
424
- Copyright © 2022, Arthur
425
-
426
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
427
-
428
- [Furo](https://github.com/pradyunsg/furo)
429
-
430
-
431
-
432
-
433
-
434
-
435
-
436
-
437
-
438
-
439
-
440
-
441
-
442
-
443
-
444
-
445
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.common.constants.ImageContentType.md.txt DELETED
@@ -1,445 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.common.constants.ImageContentType - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](#)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.common.constants.ImageContentType[#](#arthurai-common-constants-imagecontenttype "Permalink to this headline")
360
- =======================================================================================================================
361
-
362
-
363
-
364
-
365
- *class* arthurai.common.constants.ImageContentType[#](#arthurai.common.constants.ImageContentType "Permalink to this definition")
366
- Bases: [`arthurai.common.constants.ListableStrEnum`](arthurai.common.constants.ListableStrEnum.html#arthurai.common.constants.ListableStrEnum "arthurai.common.constants.ListableStrEnum")
367
-
368
-
369
- Valid image content types supported by Arthur API
370
-
371
-
372
- Methods
373
-
374
-
375
-
376
-
377
-
378
-
379
-
380
-
381
- | [`list`](#arthurai.common.constants.ImageContentType.list "arthurai.common.constants.ImageContentType.list") | Lists all attributes in alphabetical order |
382
-
383
-
384
-
385
- Attributes
386
-
387
-
388
-
389
-
390
-
391
-
392
-
393
-
394
- | `Gif` | |
395
- | `Jpeg` | |
396
- | `Png` | |
397
- | `Tiff` | |
398
-
399
-
400
-
401
-
402
-
403
- *classmethod* list()[#](#arthurai.common.constants.ImageContentType.list "Permalink to this definition")
404
- Lists all attributes in alphabetical order
405
-
406
-
407
-
408
-
409
-
410
-
411
-
412
-
413
-
414
- [Next
415
-
416
- arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
417
- [Previous
418
-
419
- arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
420
-
421
-
422
-
423
-
424
- Copyright © 2022, Arthur
425
-
426
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
427
-
428
- [Furo](https://github.com/pradyunsg/furo)
429
-
430
-
431
-
432
-
433
-
434
-
435
-
436
-
437
-
438
-
439
-
440
-
441
-
442
-
443
-
444
-
445
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.common.constants.ImageResponseType.md.txt DELETED
@@ -1,445 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.common.constants.ImageResponseType - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](#)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.common.constants.ImageResponseType[#](#arthurai-common-constants-imageresponsetype "Permalink to this headline")
360
- =========================================================================================================================
361
-
362
-
363
-
364
-
365
- *class* arthurai.common.constants.ImageResponseType[#](#arthurai.common.constants.ImageResponseType "Permalink to this definition")
366
- Bases: [`arthurai.common.constants.ListableStrEnum`](arthurai.common.constants.ListableStrEnum.html#arthurai.common.constants.ListableStrEnum "arthurai.common.constants.ListableStrEnum")
367
-
368
-
369
- Valid image response types supported by Arthur API
370
-
371
-
372
- Methods
373
-
374
-
375
-
376
-
377
-
378
-
379
-
380
-
381
- | [`list`](#arthurai.common.constants.ImageResponseType.list "arthurai.common.constants.ImageResponseType.list") | Lists all attributes in alphabetical order |
382
-
383
-
384
-
385
- Attributes
386
-
387
-
388
-
389
-
390
-
391
-
392
-
393
-
394
- | `LimeExplanation` | |
395
- | `RawImage` | |
396
- | `ResizedImage` | |
397
- | `Thumbnail` | |
398
-
399
-
400
-
401
-
402
-
403
- *classmethod* list()[#](#arthurai.common.constants.ImageResponseType.list "Permalink to this definition")
404
- Lists all attributes in alphabetical order
405
-
406
-
407
-
408
-
409
-
410
-
411
-
412
-
413
-
414
- [Next
415
-
416
- arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
417
- [Previous
418
-
419
- arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
420
-
421
-
422
-
423
-
424
- Copyright © 2022, Arthur
425
-
426
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
427
-
428
- [Furo](https://github.com/pradyunsg/furo)
429
-
430
-
431
-
432
-
433
-
434
-
435
-
436
-
437
-
438
-
439
-
440
-
441
-
442
-
443
-
444
-
445
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.common.constants.InputType.md.txt DELETED
@@ -1,441 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.common.constants.InputType - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](#)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.common.constants.InputType[#](#arthurai-common-constants-inputtype "Permalink to this headline")
360
- =========================================================================================================
361
-
362
-
363
-
364
-
365
- *class* arthurai.common.constants.InputType[#](#arthurai.common.constants.InputType "Permalink to this definition")
366
- Bases: [`arthurai.common.constants.ListableStrEnum`](arthurai.common.constants.ListableStrEnum.html#arthurai.common.constants.ListableStrEnum "arthurai.common.constants.ListableStrEnum")
367
-
368
-
369
- Methods
370
-
371
-
372
-
373
-
374
-
375
-
376
-
377
-
378
- | [`list`](#arthurai.common.constants.InputType.list "arthurai.common.constants.InputType.list") | Lists all attributes in alphabetical order |
379
-
380
-
381
-
382
- Attributes
383
-
384
-
385
-
386
-
387
-
388
-
389
-
390
-
391
- | `Image` | |
392
- | `NLP` | |
393
- | `Tabular` | |
394
-
395
-
396
-
397
-
398
-
399
- *classmethod* list()[#](#arthurai.common.constants.InputType.list "Permalink to this definition")
400
- Lists all attributes in alphabetical order
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
- [Next
411
-
412
- arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
413
- [Previous
414
-
415
- arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
416
-
417
-
418
-
419
-
420
- Copyright © 2022, Arthur
421
-
422
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
423
-
424
- [Furo](https://github.com/pradyunsg/furo)
425
-
426
-
427
-
428
-
429
-
430
-
431
-
432
-
433
-
434
-
435
-
436
-
437
-
438
-
439
-
440
-
441
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.common.constants.OutputType.md.txt DELETED
@@ -1,442 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.common.constants.OutputType - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](#)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.common.constants.OutputType[#](#arthurai-common-constants-outputtype "Permalink to this headline")
360
- ===========================================================================================================
361
-
362
-
363
-
364
-
365
- *class* arthurai.common.constants.OutputType[#](#arthurai.common.constants.OutputType "Permalink to this definition")
366
- Bases: [`arthurai.common.constants.ListableStrEnum`](arthurai.common.constants.ListableStrEnum.html#arthurai.common.constants.ListableStrEnum "arthurai.common.constants.ListableStrEnum")
367
-
368
-
369
- Methods
370
-
371
-
372
-
373
-
374
-
375
-
376
-
377
-
378
- | [`list`](#arthurai.common.constants.OutputType.list "arthurai.common.constants.OutputType.list") | Lists all attributes in alphabetical order |
379
-
380
-
381
-
382
- Attributes
383
-
384
-
385
-
386
-
387
-
388
-
389
-
390
-
391
- | `Multiclass` | |
392
- | `Multilabel` | |
393
- | `ObjectDetection` | |
394
- | `Regression` | |
395
-
396
-
397
-
398
-
399
-
400
- *classmethod* list()[#](#arthurai.common.constants.OutputType.list "Permalink to this definition")
401
- Lists all attributes in alphabetical order
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
-
411
- [Next
412
-
413
- arthurai.common.constants.Role](arthurai.common.constants.Role.html)
414
- [Previous
415
-
416
- arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
417
-
418
-
419
-
420
-
421
- Copyright © 2022, Arthur
422
-
423
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
424
-
425
- [Furo](https://github.com/pradyunsg/furo)
426
-
427
-
428
-
429
-
430
-
431
-
432
-
433
-
434
-
435
-
436
-
437
-
438
-
439
-
440
-
441
-
442
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.common.constants.Role.md.txt DELETED
@@ -1,441 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.common.constants.Role - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](#)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.common.constants.Role[#](#arthurai-common-constants-role "Permalink to this headline")
360
- ===============================================================================================
361
-
362
-
363
-
364
-
365
- *class* arthurai.common.constants.Role[#](#arthurai.common.constants.Role "Permalink to this definition")
366
- Bases: [`arthurai.common.constants.ListableStrEnum`](arthurai.common.constants.ListableStrEnum.html#arthurai.common.constants.ListableStrEnum "arthurai.common.constants.ListableStrEnum")
367
-
368
-
369
- Methods
370
-
371
-
372
-
373
-
374
-
375
-
376
-
377
-
378
- | [`list`](#arthurai.common.constants.Role.list "arthurai.common.constants.Role.list") | Lists all attributes in alphabetical order |
379
-
380
-
381
-
382
- Attributes
383
-
384
-
385
-
386
-
387
-
388
-
389
-
390
-
391
- | `Administrator` | |
392
- | `ModelOwner` | |
393
- | `User` | |
394
-
395
-
396
-
397
-
398
-
399
- *classmethod* list()[#](#arthurai.common.constants.Role.list "Permalink to this definition")
400
- Lists all attributes in alphabetical order
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
- [Next
411
-
412
- arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
413
- [Previous
414
-
415
- arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
416
-
417
-
418
-
419
-
420
- Copyright © 2022, Arthur
421
-
422
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
423
-
424
- [Furo](https://github.com/pradyunsg/furo)
425
-
426
-
427
-
428
-
429
-
430
-
431
-
432
-
433
-
434
-
435
-
436
-
437
-
438
-
439
-
440
-
441
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.common.constants.Stage.md.txt DELETED
@@ -1,444 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.common.constants.Stage - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](#)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.common.constants.Stage[#](#arthurai-common-constants-stage "Permalink to this headline")
360
- =================================================================================================
361
-
362
-
363
-
364
-
365
- *class* arthurai.common.constants.Stage[#](#arthurai.common.constants.Stage "Permalink to this definition")
366
- Bases: [`arthurai.common.constants.ListableStrEnum`](arthurai.common.constants.ListableStrEnum.html#arthurai.common.constants.ListableStrEnum "arthurai.common.constants.ListableStrEnum")
367
-
368
-
369
- Methods
370
-
371
-
372
-
373
-
374
-
375
-
376
-
377
-
378
- | [`list`](#arthurai.common.constants.Stage.list "arthurai.common.constants.Stage.list") | Lists all attributes in alphabetical order |
379
-
380
-
381
-
382
- Attributes
383
-
384
-
385
-
386
-
387
-
388
-
389
-
390
-
391
- | `GroundTruth` | |
392
- | `GroundTruthClass` | |
393
- | `ModelPipelineInput` | |
394
- | `NonInputData` | |
395
- | `PredictFunctionInput` | |
396
- | `PredictedValue` | |
397
-
398
-
399
-
400
-
401
-
402
- *classmethod* list()[#](#arthurai.common.constants.Stage.list "Permalink to this definition")
403
- Lists all attributes in alphabetical order
404
-
405
-
406
-
407
-
408
-
409
-
410
-
411
-
412
-
413
- [Next
414
-
415
- arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
416
- [Previous
417
-
418
- arthurai.common.constants.Role](arthurai.common.constants.Role.html)
419
-
420
-
421
-
422
-
423
- Copyright © 2022, Arthur
424
-
425
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
426
-
427
- [Furo](https://github.com/pradyunsg/furo)
428
-
429
-
430
-
431
-
432
-
433
-
434
-
435
-
436
-
437
-
438
-
439
-
440
-
441
-
442
-
443
-
444
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.common.constants.TextDelimiter.md.txt DELETED
@@ -1,507 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.common.constants.TextDelimiter - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](#)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.common.constants.TextDelimiter[#](#arthurai-common-constants-textdelimiter "Permalink to this headline")
360
- =================================================================================================================
361
-
362
-
363
-
364
-
365
- *class* arthurai.common.constants.TextDelimiter[#](#arthurai.common.constants.TextDelimiter "Permalink to this definition")
366
- Bases: [`arthurai.common.constants.ListableStrEnum`](arthurai.common.constants.ListableStrEnum.html#arthurai.common.constants.ListableStrEnum "arthurai.common.constants.ListableStrEnum")
367
-
368
-
369
- This class contains patterns that can be used as text\_delimiter for NLP models.
370
-
371
-
372
- Methods
373
-
374
-
375
-
376
-
377
-
378
-
379
-
380
-
381
- | [`list`](#arthurai.common.constants.TextDelimiter.list "arthurai.common.constants.TextDelimiter.list") | Lists all attributes in alphabetical order |
382
-
383
-
384
-
385
- Attributes
386
-
387
-
388
-
389
-
390
-
391
-
392
-
393
-
394
- | [`COMMA`](#arthurai.common.constants.TextDelimiter.COMMA "arthurai.common.constants.TextDelimiter.COMMA") | `","` Splits on a single comma. |
395
- | [`COMMA\_PLUS`](#arthurai.common.constants.TextDelimiter.COMMA_PLUS "arthurai.common.constants.TextDelimiter.COMMA_PLUS") | `",+"` Splits on one or more commas. |
396
- | [`NOT\_WORD`](#arthurai.common.constants.TextDelimiter.NOT_WORD "arthurai.common.constants.TextDelimiter.NOT_WORD") | `"\W+"` Splits on any character that is not a word. |
397
- | [`PIPE`](#arthurai.common.constants.TextDelimiter.PIPE "arthurai.common.constants.TextDelimiter.PIPE") | `"\|"` Splits on a single pipe. |
398
- | [`PIPE\_PLUS`](#arthurai.common.constants.TextDelimiter.PIPE_PLUS "arthurai.common.constants.TextDelimiter.PIPE_PLUS") | `"\|+"` Splits on one or more pipes. |
399
- | [`WHITESPACE`](#arthurai.common.constants.TextDelimiter.WHITESPACE "arthurai.common.constants.TextDelimiter.WHITESPACE") | `"\s+"` Splits on whitespace. |
400
-
401
-
402
-
403
-
404
-
405
- COMMA *= ','*[#](#arthurai.common.constants.TextDelimiter.COMMA "Permalink to this definition")
406
- `","` Splits on a single comma.
407
-
408
-
409
- Ex: `"this ,is,,a,test" = ["this ", "is", "", "a", "test"]`
410
-
411
-
412
-
413
-
414
-
415
- COMMA\_PLUS *= ',+'*[#](#arthurai.common.constants.TextDelimiter.COMMA_PLUS "Permalink to this definition")
416
- `",+"` Splits on one or more commas.
417
-
418
-
419
- Ex: `"this ,is,,a,test" = ["this ", "is", "a", "test"]`
420
-
421
-
422
-
423
-
424
-
425
- NOT\_WORD *= '\\W+'*[#](#arthurai.common.constants.TextDelimiter.NOT_WORD "Permalink to this definition")
426
- `"\W+"` Splits on any character that is not a word.
427
-
428
-
429
- Ex: `"this  is,aaaa,,,,,test!" = ["this", "is", "aaaa", "test", ""]`
430
-
431
-
432
-
433
-
434
-
435
- PIPE *= '\\|'*[#](#arthurai.common.constants.TextDelimiter.PIPE "Permalink to this definition")
436
- `"\|"` Splits on a single pipe.
437
-
438
-
439
- Ex: `"this |is||a|test" = ["this ", "is", "", "a", "test"]`
440
-
441
-
442
-
443
-
444
-
445
- PIPE\_PLUS *= '\\|+'*[#](#arthurai.common.constants.TextDelimiter.PIPE_PLUS "Permalink to this definition")
446
- `"\|+"` Splits on one or more pipes.
447
-
448
-
449
- Ex: `"this |is||a|test" = ["this ", "is", "a", "test"]`
450
-
451
-
452
-
453
-
454
-
455
- WHITESPACE *= '\\s+'*[#](#arthurai.common.constants.TextDelimiter.WHITESPACE "Permalink to this definition")
456
- `"\s+"` Splits on whitespace.
457
-
458
-
459
- Ex: `"this  is,a test! " = ["this", "is,a", "test!", ""]`
460
-
461
-
462
-
463
-
464
-
465
- *classmethod* list()[#](#arthurai.common.constants.TextDelimiter.list "Permalink to this definition")
466
- Lists all attributes in alphabetical order
467
-
468
-
469
-
470
-
471
-
472
-
473
-
474
-
475
-
476
- [Next
477
-
478
- arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
479
- [Previous
480
-
481
- arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
482
-
483
-
484
-
485
-
486
- Copyright © 2022, Arthur
487
-
488
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
489
-
490
- [Furo](https://github.com/pradyunsg/furo)
491
-
492
-
493
-
494
-
495
-
496
-
497
-
498
-
499
-
500
-
501
-
502
-
503
-
504
-
505
-
506
-
507
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.common.constants.ValueType.md.txt DELETED
@@ -1,446 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.common.constants.ValueType - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](#)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.common.constants.ValueType[#](#arthurai-common-constants-valuetype "Permalink to this headline")
360
- =========================================================================================================
361
-
362
-
363
-
364
-
365
- *class* arthurai.common.constants.ValueType[#](#arthurai.common.constants.ValueType "Permalink to this definition")
366
- Bases: [`arthurai.common.constants.ListableStrEnum`](arthurai.common.constants.ListableStrEnum.html#arthurai.common.constants.ListableStrEnum "arthurai.common.constants.ListableStrEnum")
367
-
368
-
369
- Methods
370
-
371
-
372
-
373
-
374
-
375
-
376
-
377
-
378
- | [`list`](#arthurai.common.constants.ValueType.list "arthurai.common.constants.ValueType.list") | Lists all attributes in alphabetical order |
379
-
380
-
381
-
382
- Attributes
383
-
384
-
385
-
386
-
387
-
388
-
389
-
390
-
391
- | `Boolean` | |
392
- | `BoundingBox` | |
393
- | `Float` | |
394
- | `Image` | |
395
- | `Integer` | |
396
- | `String` | |
397
- | `Timestamp` | |
398
- | `Unstructured\_Text` | |
399
-
400
-
401
-
402
-
403
-
404
- *classmethod* list()[#](#arthurai.common.constants.ValueType.list "Permalink to this definition")
405
- Lists all attributes in alphabetical order
406
-
407
-
408
-
409
-
410
-
411
-
412
-
413
-
414
-
415
- [Next
416
-
417
- arthurai.common.exceptions](arthurai.common.exceptions.html)
418
- [Previous
419
-
420
- arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
421
-
422
-
423
-
424
-
425
- Copyright © 2022, Arthur
426
-
427
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
428
-
429
- [Furo](https://github.com/pradyunsg/furo)
430
-
431
-
432
-
433
-
434
-
435
-
436
-
437
-
438
-
439
-
440
-
441
-
442
-
443
-
444
-
445
-
446
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.common.constants.md.txt DELETED
@@ -1,422 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.common.constants - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](#)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.common.constants[#](#module-arthurai.common.constants "Permalink to this headline")
360
- ============================================================================================
361
-
362
-
363
- Classes
364
-
365
-
366
-
367
-
368
-
369
-
370
-
371
-
372
- | [`AccuracyMetric`](arthurai.common.constants.AccuracyMetric.html#arthurai.common.constants.AccuracyMetric "arthurai.common.constants.AccuracyMetric")() | |
373
- | [`Enrichment`](arthurai.common.constants.Enrichment.html#arthurai.common.constants.Enrichment "arthurai.common.constants.Enrichment")() | This class contains constants for the names of enrichments |
374
- | [`ImageContentType`](arthurai.common.constants.ImageContentType.html#arthurai.common.constants.ImageContentType "arthurai.common.constants.ImageContentType")() | Valid image content types supported by Arthur API |
375
- | [`ImageResponseType`](arthurai.common.constants.ImageResponseType.html#arthurai.common.constants.ImageResponseType "arthurai.common.constants.ImageResponseType")() | Valid image response types supported by Arthur API |
376
- | [`InputType`](arthurai.common.constants.InputType.html#arthurai.common.constants.InputType "arthurai.common.constants.InputType")() | |
377
- | [`ListableStrEnum`](arthurai.common.constants.ListableStrEnum.html#arthurai.common.constants.ListableStrEnum "arthurai.common.constants.ListableStrEnum")() | This class operates similar to Enum but passes mypy type checking. |
378
- | [`OutputType`](arthurai.common.constants.OutputType.html#arthurai.common.constants.OutputType "arthurai.common.constants.OutputType")() | |
379
- | [`Role`](arthurai.common.constants.Role.html#arthurai.common.constants.Role "arthurai.common.constants.Role")() | |
380
- | [`Stage`](arthurai.common.constants.Stage.html#arthurai.common.constants.Stage "arthurai.common.constants.Stage")() | |
381
- | [`TextDelimiter`](arthurai.common.constants.TextDelimiter.html#arthurai.common.constants.TextDelimiter "arthurai.common.constants.TextDelimiter")() | This class contains patterns that can be used as text\_delimiter for NLP models. |
382
- | [`ValueType`](arthurai.common.constants.ValueType.html#arthurai.common.constants.ValueType "arthurai.common.constants.ValueType")() | |
383
-
384
-
385
-
386
-
387
-
388
-
389
-
390
-
391
- [Next
392
-
393
- arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
394
- [Previous
395
-
396
- arthurai.common](arthurai.common.html)
397
-
398
-
399
-
400
-
401
- Copyright © 2022, Arthur
402
-
403
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
404
-
405
- [Furo](https://github.com/pradyunsg/furo)
406
-
407
-
408
-
409
-
410
-
411
-
412
-
413
-
414
-
415
-
416
-
417
-
418
-
419
-
420
-
421
-
422
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.common.exceptions.arthur_excepted.md.txt DELETED
@@ -1,410 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.common.exceptions.arthur\_excepted - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](#)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.common.exceptions.arthur\_excepted[#](#arthurai-common-exceptions-arthur-excepted "Permalink to this headline")
360
- ========================================================================================================================
361
-
362
-
363
-
364
-
365
- arthurai.common.exceptions.arthur\_excepted(*message=None*)[#](#arthurai.common.exceptions.arthur_excepted "Permalink to this definition")
366
- Decorator to wrap user-facing Arthur functions with exception handling that describes to the user whether the error
367
- is their fault or is our fault and should be reported.
368
- :param message: an optional message to prefix the error with, should describe the failure e.g. “failed to send
369
- inferences” or “an error occurred while creating the model.”
370
- :return: the decorator function
371
-
372
-
373
-
374
-
375
-
376
-
377
-
378
-
379
- [Next
380
-
381
- arthurai.common.log](arthurai.common.log.html)
382
- [Previous
383
-
384
- arthurai.common.exceptions](arthurai.common.exceptions.html)
385
-
386
-
387
-
388
-
389
- Copyright © 2022, Arthur
390
-
391
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
392
-
393
- [Furo](https://github.com/pradyunsg/furo)
394
-
395
-
396
-
397
-
398
-
399
-
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.common.exceptions.md.txt DELETED
@@ -1,438 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.common.exceptions - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](#)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.common.exceptions[#](#module-arthurai.common.exceptions "Permalink to this headline")
360
- ==============================================================================================
361
-
362
-
363
- Functions
364
-
365
-
366
-
367
-
368
-
369
-
370
-
371
-
372
- | [`arthur\_excepted`](arthurai.common.exceptions.arthur_excepted.html#arthurai.common.exceptions.arthur_excepted "arthurai.common.exceptions.arthur_excepted")([message]) | Decorator to wrap user-facing Arthur functions with exception handling that describes to the user whether the error is their fault or is our fault and should be reported. |
373
-
374
-
375
-
376
- Exceptions
377
-
378
-
379
-
380
-
381
-
382
-
383
-
384
-
385
- | `ArthurError` | Base Error for Arthur SDK. |
386
- | `ArthurInternalError` | Exception raised when user input is correct but an error occurs. |
387
- | `ArthurUserError` | Exception raised due to incorrect user input to the Arthur SDK. |
388
- | `ExpectedParameterNotFoundError` | Exception raised when a field or property should be available from Arthur but is unexpectedly missing. |
389
- | `ForbiddenError` | Exception raised when a 403 Forbidden response is received from the API. |
390
- | `InternalTypeError` | Exception raised when a value is unexpected. |
391
- | `InternalValueError` | Exception raised when a value is unexpected. |
392
- | `MethodNotApplicableError` | Exception raised when the method called is not valid for the resource. |
393
- | `MissingParameterError` | Exception raised when parameters supplied to the Arthur SDK are missing. |
394
- | `ResponseClientError` | Exception raised when a 4XX response is received from the API. |
395
- | `ResponseRedirectError` | Exception raised when a 3XX response is unexpectedly received from the API. |
396
- | `ResponseServerError` | Exception raised when a 5XX response is received from the API. |
397
- | `UserTypeError` | Exception raised when a user supplies an argument of the incorrect type to the Arthur SDK. |
398
- | `UserValueError` | Exception raised when a user supplies an invalid value to the Arthur SDK. |
399
-
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
- [Next
408
-
409
- arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
410
- [Previous
411
-
412
- arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
413
-
414
-
415
-
416
-
417
- Copyright © 2022, Arthur
418
-
419
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
420
-
421
- [Furo](https://github.com/pradyunsg/furo)
422
-
423
-
424
-
425
-
426
-
427
-
428
-
429
-
430
-
431
-
432
-
433
-
434
-
435
-
436
-
437
-
438
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.common.log.InfoFilter.md.txt DELETED
@@ -1,433 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.common.log.InfoFilter - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](#)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.common.log.InfoFilter[#](#arthurai-common-log-infofilter "Permalink to this headline")
360
- ===============================================================================================
361
-
362
-
363
-
364
-
365
- *class* arthurai.common.log.InfoFilter(*name=''*)[#](#arthurai.common.log.InfoFilter "Permalink to this definition")
366
- Bases: `logging.Filter`
367
-
368
-
369
- A logging filter to only log messages that are debug or info level (i.e. never log warning or error messages)
370
-
371
-
372
- Methods
373
-
374
-
375
-
376
-
377
-
378
-
379
-
380
-
381
- | [`filter`](#arthurai.common.log.InfoFilter.filter "arthurai.common.log.InfoFilter.filter") | Determine if the specified record is to be logged. |
382
-
383
-
384
-
385
-
386
-
387
- filter(*rec*)[#](#arthurai.common.log.InfoFilter.filter "Permalink to this definition")
388
- Determine if the specified record is to be logged.
389
-
390
-
391
- Returns True if the record should be logged, or False otherwise.
392
- If deemed appropriate, the record may be modified in-place.
393
-
394
-
395
-
396
-
397
-
398
-
399
-
400
-
401
-
402
- [Next
403
-
404
- arthurai.core](arthurai.core.html)
405
- [Previous
406
-
407
- arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
408
-
409
-
410
-
411
-
412
- Copyright © 2022, Arthur
413
-
414
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
415
-
416
- [Furo](https://github.com/pradyunsg/furo)
417
-
418
-
419
-
420
-
421
-
422
-
423
-
424
-
425
-
426
-
427
-
428
-
429
-
430
-
431
-
432
-
433
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.common.log.disable_debug_logging.md.txt DELETED
@@ -1,407 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.common.log.disable\_debug\_logging - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](#)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.common.log.disable\_debug\_logging[#](#arthurai-common-log-disable-debug-logging "Permalink to this headline")
360
- =======================================================================================================================
361
-
362
-
363
-
364
-
365
- arthurai.common.log.disable\_debug\_logging()[#](#arthurai.common.log.disable_debug_logging "Permalink to this definition")
366
- Disables debug logging for the arthurai package. Note that log messages may be dropped while this function is
367
- being executed.
368
-
369
-
370
-
371
-
372
-
373
-
374
-
375
-
376
- [Next
377
-
378
- arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
379
- [Previous
380
-
381
- arthurai.common.log](arthurai.common.log.html)
382
-
383
-
384
-
385
-
386
- Copyright © 2022, Arthur
387
-
388
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
389
-
390
- [Furo](https://github.com/pradyunsg/furo)
391
-
392
-
393
-
394
-
395
-
396
-
397
-
398
-
399
-
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.common.log.enable_debug_logging.md.txt DELETED
@@ -1,407 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.common.log.enable\_debug\_logging - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](#)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.common.log.enable\_debug\_logging[#](#arthurai-common-log-enable-debug-logging "Permalink to this headline")
360
- =====================================================================================================================
361
-
362
-
363
-
364
-
365
- arthurai.common.log.enable\_debug\_logging()[#](#arthurai.common.log.enable_debug_logging "Permalink to this definition")
366
- Enables debug logging for the arthurai package. Note that log messages may be dropped while this function is
367
- being executed.
368
-
369
-
370
-
371
-
372
-
373
-
374
-
375
-
376
- [Next
377
-
378
- arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
379
- [Previous
380
-
381
- arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
382
-
383
-
384
-
385
-
386
- Copyright © 2022, Arthur
387
-
388
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
389
-
390
- [Furo](https://github.com/pradyunsg/furo)
391
-
392
-
393
-
394
-
395
-
396
-
397
-
398
-
399
-
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.common.log.initialize_logging.md.txt DELETED
@@ -1,406 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.common.log.initialize\_logging - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](#)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.common.log.initialize\_logging[#](#arthurai-common-log-initialize-logging "Permalink to this headline")
360
- ================================================================================================================
361
-
362
-
363
-
364
-
365
- arthurai.common.log.initialize\_logging()[#](#arthurai.common.log.initialize_logging "Permalink to this definition")
366
- Creates a parent ‘arthurai’ logger with a console output and INFO level.
367
-
368
-
369
-
370
-
371
-
372
-
373
-
374
-
375
- [Next
376
-
377
- arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
378
- [Previous
379
-
380
- arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
381
-
382
-
383
-
384
-
385
- Copyright © 2022, Arthur
386
-
387
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
388
-
389
- [Furo](https://github.com/pradyunsg/furo)
390
-
391
-
392
-
393
-
394
-
395
-
396
-
397
-
398
-
399
-
400
-
401
-
402
-
403
-
404
-
405
-
406
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.common.log.md.txt DELETED
@@ -1,441 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.common.log - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](#)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.common.log[#](#module-arthurai.common.log "Permalink to this headline")
360
- ================================================================================
361
-
362
-
363
- Functions
364
-
365
-
366
-
367
-
368
-
369
-
370
-
371
-
372
- | [`disable\_debug\_logging`](arthurai.common.log.disable_debug_logging.html#arthurai.common.log.disable_debug_logging "arthurai.common.log.disable_debug_logging")() | Disables debug logging for the arthurai package. |
373
- | [`enable\_debug\_logging`](arthurai.common.log.enable_debug_logging.html#arthurai.common.log.enable_debug_logging "arthurai.common.log.enable_debug_logging")() | Enables debug logging for the arthurai package. |
374
- | [`initialize\_logging`](arthurai.common.log.initialize_logging.html#arthurai.common.log.initialize_logging "arthurai.common.log.initialize_logging")() | Creates a parent 'arthurai' logger with a console output and INFO level. |
375
-
376
-
377
-
378
- Classes
379
-
380
-
381
-
382
-
383
-
384
-
385
-
386
-
387
- | [`InfoFilter`](arthurai.common.log.InfoFilter.html#arthurai.common.log.InfoFilter "arthurai.common.log.InfoFilter")([name]) | A logging filter to only log messages that are debug or info level (i.e. |
388
-
389
-
390
-
391
-
392
-
393
-
394
-
395
-
396
- [Next
397
-
398
- arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
399
- [Previous
400
-
401
- arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
402
-
403
-
404
-
405
-
406
- Copyright © 2022, Arthur
407
-
408
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
409
-
410
- [Furo](https://github.com/pradyunsg/furo)
411
-
412
-
413
-
414
-
415
-
416
-
417
-
418
-
419
-
420
-
421
-
422
-
423
- On this page
424
-
425
-
426
-
427
-
428
- * [arthurai.common.log](#)
429
-
430
-
431
-
432
-
433
-
434
-
435
-
436
-
437
-
438
-
439
-
440
-
441
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.common.md.txt DELETED
@@ -1,414 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.common - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](#)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.common[#](#module-arthurai.common "Permalink to this headline")
360
- ========================================================================
361
-
362
-
363
- Constants, exceptions, and logging for use in other packages
364
-
365
-
366
-
367
-
368
-
369
-
370
-
371
-
372
- | [`arthurai.common.constants`](arthurai.common.constants.html#module-arthurai.common.constants "arthurai.common.constants") | |
373
- | [`arthurai.common.exceptions`](arthurai.common.exceptions.html#module-arthurai.common.exceptions "arthurai.common.exceptions") | |
374
- | [`arthurai.common.log`](arthurai.common.log.html#module-arthurai.common.log "arthurai.common.log") | |
375
-
376
-
377
-
378
-
379
-
380
-
381
-
382
-
383
- [Next
384
-
385
- arthurai.common.constants](arthurai.common.constants.html)
386
- [Previous
387
-
388
- arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
389
-
390
-
391
-
392
-
393
- Copyright © 2022, Arthur
394
-
395
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
396
-
397
- [Furo](https://github.com/pradyunsg/furo)
398
-
399
-
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
-
411
-
412
-
413
-
414
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.core.alerts.Alert.md.txt DELETED
@@ -1,522 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.core.alerts.Alert - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](#)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.core.alerts.Alert[#](#arthurai-core-alerts-alert "Permalink to this headline")
360
- =======================================================================================
361
-
362
-
363
-
364
-
365
- *class* arthurai.core.alerts.Alert(*id*, *timestamp*, *metric\_value*, *message*, *model\_id*, *status*, *alert\_rule*, *window\_start=None*, *window\_end=None*, *batch\_id=None*)[#](#arthurai.core.alerts.Alert "Permalink to this definition")
366
- Bases: [`arthurai.core.base.ArthurBaseJsonDataclass`](arthurai.core.base.ArthurBaseJsonDataclass.html#arthurai.core.base.ArthurBaseJsonDataclass "arthurai.core.base.ArthurBaseJsonDataclass")
367
-
368
-
369
- Methods
370
-
371
-
372
-
373
-
374
-
375
-
376
-
377
-
378
- | [`clean\_nones`](#arthurai.core.alerts.Alert.clean_nones "arthurai.core.alerts.Alert.clean_nones") | Helper function to filter out None objects from a json or dictionary representation of an object |
379
- | `from\_dict` |
380
- rtype
381
- `TypeVar`(`A`, bound= `DataClassJsonMixin`)
382
-
383
- |
384
- | `from\_json` |
385
- rtype
386
- `TypeVar`(`A`, bound= `DataClassJsonMixin`)
387
-
388
- |
389
- | `schema` |
390
- rtype
391
- `SchemaF`[`TypeVar`(`A`)]
392
-
393
- |
394
- | [`to\_dict`](#arthurai.core.alerts.Alert.to_dict "arthurai.core.alerts.Alert.to_dict") | Creates a dictionary representation of this object |
395
- | [`to\_json`](#arthurai.core.alerts.Alert.to_json "arthurai.core.alerts.Alert.to_json") | Creates a json representation of this object |
396
-
397
-
398
-
399
- Attributes
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
- | `batch\_id` | |
409
- | `dataclass\_json\_config` | |
410
- | `window\_end` | |
411
- | `window\_start` | |
412
- | `id` | |
413
- | `timestamp` | |
414
- | `metric\_value` | |
415
- | `message` | |
416
- | `model\_id` | |
417
- | `status` | |
418
- | `alert\_rule` | |
419
-
420
-
421
-
422
-
423
-
424
- *static* clean\_nones(*d*)[#](#arthurai.core.alerts.Alert.clean_nones "Permalink to this definition")
425
- Helper function to filter out None objects from a json or dictionary representation of an object
426
-
427
-
428
-
429
- Parameters
430
- **d** – a Dictionary or Json representation of an ArthurBaseJsonDataclass object
431
-
432
-
433
-
434
- Returns
435
- Dictionary of the object with all None components removed
436
-
437
-
438
-
439
-
440
-
441
-
442
-
443
- to\_dict(*skip\_none=True*)[#](#arthurai.core.alerts.Alert.to_dict "Permalink to this definition")
444
- Creates a dictionary representation of this object
445
-
446
-
447
- This function can be applied to any extension of the ArthurBaseJsonDataClass
448
-
449
-
450
-
451
- Return type
452
- `dict`
453
-
454
-
455
-
456
- Returns
457
- Dictionary of object data
458
-
459
-
460
-
461
-
462
-
463
-
464
-
465
- to\_json(*skip\_none=True*)[#](#arthurai.core.alerts.Alert.to_json "Permalink to this definition")
466
- Creates a json representation of this object
467
-
468
-
469
- This function can be applied to any extension of the ArthurBaseJsonDataClass
470
-
471
-
472
-
473
- Return type
474
- `str`
475
-
476
-
477
-
478
- Returns
479
- json of object data
480
-
481
-
482
-
483
-
484
-
485
-
486
-
487
-
488
-
489
-
490
-
491
- [Next
492
-
493
- arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
494
- [Previous
495
-
496
- arthurai.core.alerts](arthurai.core.alerts.html)
497
-
498
-
499
-
500
-
501
- Copyright © 2022, Arthur
502
-
503
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
504
-
505
- [Furo](https://github.com/pradyunsg/furo)
506
-
507
-
508
-
509
-
510
-
511
-
512
-
513
-
514
-
515
-
516
-
517
-
518
-
519
-
520
-
521
-
522
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.core.alerts.AlertRule.md.txt DELETED
@@ -1,522 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.core.alerts.AlertRule - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](#)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.core.alerts.AlertRule[#](#arthurai-core-alerts-alertrule "Permalink to this headline")
360
- ===============================================================================================
361
-
362
-
363
-
364
-
365
- *class* arthurai.core.alerts.AlertRule(*bound*, *threshold*, *metric\_id*, *severity*, *name=None*, *lookback\_period=None*, *subsequent\_alert\_wait\_time=None*, *enabled=True*, *id=None*, *metric\_name=None*)[#](#arthurai.core.alerts.AlertRule "Permalink to this definition")
366
- Bases: [`arthurai.core.base.ArthurBaseJsonDataclass`](arthurai.core.base.ArthurBaseJsonDataclass.html#arthurai.core.base.ArthurBaseJsonDataclass "arthurai.core.base.ArthurBaseJsonDataclass")
367
-
368
-
369
- Methods
370
-
371
-
372
-
373
-
374
-
375
-
376
-
377
-
378
- | [`clean\_nones`](#arthurai.core.alerts.AlertRule.clean_nones "arthurai.core.alerts.AlertRule.clean_nones") | Helper function to filter out None objects from a json or dictionary representation of an object |
379
- | `from\_dict` |
380
- rtype
381
- `TypeVar`(`A`, bound= `DataClassJsonMixin`)
382
-
383
- |
384
- | `from\_json` |
385
- rtype
386
- `TypeVar`(`A`, bound= `DataClassJsonMixin`)
387
-
388
- |
389
- | `schema` |
390
- rtype
391
- `SchemaF`[`TypeVar`(`A`)]
392
-
393
- |
394
- | [`to\_dict`](#arthurai.core.alerts.AlertRule.to_dict "arthurai.core.alerts.AlertRule.to_dict") | Creates a dictionary representation of this object |
395
- | [`to\_json`](#arthurai.core.alerts.AlertRule.to_json "arthurai.core.alerts.AlertRule.to_json") | Creates a json representation of this object |
396
-
397
-
398
-
399
- Attributes
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
- | `dataclass\_json\_config` | |
409
- | `enabled` | |
410
- | `id` | |
411
- | `lookback\_period` | |
412
- | `metric\_name` | |
413
- | `name` | |
414
- | `subsequent\_alert\_wait\_time` | |
415
- | `bound` | |
416
- | `threshold` | |
417
- | `metric\_id` | |
418
- | `severity` | |
419
-
420
-
421
-
422
-
423
-
424
- *static* clean\_nones(*d*)[#](#arthurai.core.alerts.AlertRule.clean_nones "Permalink to this definition")
425
- Helper function to filter out None objects from a json or dictionary representation of an object
426
-
427
-
428
-
429
- Parameters
430
- **d** – a Dictionary or Json representation of an ArthurBaseJsonDataclass object
431
-
432
-
433
-
434
- Returns
435
- Dictionary of the object with all None components removed
436
-
437
-
438
-
439
-
440
-
441
-
442
-
443
- to\_dict(*skip\_none=True*)[#](#arthurai.core.alerts.AlertRule.to_dict "Permalink to this definition")
444
- Creates a dictionary representation of this object
445
-
446
-
447
- This function can be applied to any extension of the ArthurBaseJsonDataClass
448
-
449
-
450
-
451
- Return type
452
- `dict`
453
-
454
-
455
-
456
- Returns
457
- Dictionary of object data
458
-
459
-
460
-
461
-
462
-
463
-
464
-
465
- to\_json(*skip\_none=True*)[#](#arthurai.core.alerts.AlertRule.to_json "Permalink to this definition")
466
- Creates a json representation of this object
467
-
468
-
469
- This function can be applied to any extension of the ArthurBaseJsonDataClass
470
-
471
-
472
-
473
- Return type
474
- `str`
475
-
476
-
477
-
478
- Returns
479
- json of object data
480
-
481
-
482
-
483
-
484
-
485
-
486
-
487
-
488
-
489
-
490
-
491
- [Next
492
-
493
- arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
494
- [Previous
495
-
496
- arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
497
-
498
-
499
-
500
-
501
- Copyright © 2022, Arthur
502
-
503
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
504
-
505
- [Furo](https://github.com/pradyunsg/furo)
506
-
507
-
508
-
509
-
510
-
511
-
512
-
513
-
514
-
515
-
516
-
517
-
518
-
519
-
520
-
521
-
522
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.core.alerts.AlertRuleBound.md.txt DELETED
@@ -1,440 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.core.alerts.AlertRuleBound - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](#)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.core.alerts.AlertRuleBound[#](#arthurai-core-alerts-alertrulebound "Permalink to this headline")
360
- =========================================================================================================
361
-
362
-
363
-
364
-
365
- *class* arthurai.core.alerts.AlertRuleBound[#](#arthurai.core.alerts.AlertRuleBound "Permalink to this definition")
366
- Bases: [`arthurai.common.constants.ListableStrEnum`](arthurai.common.constants.ListableStrEnum.html#arthurai.common.constants.ListableStrEnum "arthurai.common.constants.ListableStrEnum")
367
-
368
-
369
- Methods
370
-
371
-
372
-
373
-
374
-
375
-
376
-
377
-
378
- | [`list`](#arthurai.core.alerts.AlertRuleBound.list "arthurai.core.alerts.AlertRuleBound.list") | Lists all attributes in alphabetical order |
379
-
380
-
381
-
382
- Attributes
383
-
384
-
385
-
386
-
387
-
388
-
389
-
390
-
391
- | `Lower` | |
392
- | `Upper` | |
393
-
394
-
395
-
396
-
397
-
398
- *classmethod* list()[#](#arthurai.core.alerts.AlertRuleBound.list "Permalink to this definition")
399
- Lists all attributes in alphabetical order
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
- [Next
410
-
411
- arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
412
- [Previous
413
-
414
- arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
415
-
416
-
417
-
418
-
419
- Copyright © 2022, Arthur
420
-
421
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
422
-
423
- [Furo](https://github.com/pradyunsg/furo)
424
-
425
-
426
-
427
-
428
-
429
-
430
-
431
-
432
-
433
-
434
-
435
-
436
-
437
-
438
-
439
-
440
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.core.alerts.AlertRuleSeverity.md.txt DELETED
@@ -1,440 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.core.alerts.AlertRuleSeverity - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](#)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.core.alerts.AlertRuleSeverity[#](#arthurai-core-alerts-alertruleseverity "Permalink to this headline")
360
- ===============================================================================================================
361
-
362
-
363
-
364
-
365
- *class* arthurai.core.alerts.AlertRuleSeverity[#](#arthurai.core.alerts.AlertRuleSeverity "Permalink to this definition")
366
- Bases: [`arthurai.common.constants.ListableStrEnum`](arthurai.common.constants.ListableStrEnum.html#arthurai.common.constants.ListableStrEnum "arthurai.common.constants.ListableStrEnum")
367
-
368
-
369
- Methods
370
-
371
-
372
-
373
-
374
-
375
-
376
-
377
-
378
- | [`list`](#arthurai.core.alerts.AlertRuleSeverity.list "arthurai.core.alerts.AlertRuleSeverity.list") | Lists all attributes in alphabetical order |
379
-
380
-
381
-
382
- Attributes
383
-
384
-
385
-
386
-
387
-
388
-
389
-
390
-
391
- | `Critical` | |
392
- | `Warning` | |
393
-
394
-
395
-
396
-
397
-
398
- *classmethod* list()[#](#arthurai.core.alerts.AlertRuleSeverity.list "Permalink to this definition")
399
- Lists all attributes in alphabetical order
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
- [Next
410
-
411
- arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
412
- [Previous
413
-
414
- arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
415
-
416
-
417
-
418
-
419
- Copyright © 2022, Arthur
420
-
421
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
422
-
423
- [Furo](https://github.com/pradyunsg/furo)
424
-
425
-
426
-
427
-
428
-
429
-
430
-
431
-
432
-
433
-
434
-
435
-
436
-
437
-
438
-
439
-
440
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.core.alerts.AlertStatus.md.txt DELETED
@@ -1,440 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.core.alerts.AlertStatus - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](#)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.core.alerts.AlertStatus[#](#arthurai-core-alerts-alertstatus "Permalink to this headline")
360
- ===================================================================================================
361
-
362
-
363
-
364
-
365
- *class* arthurai.core.alerts.AlertStatus[#](#arthurai.core.alerts.AlertStatus "Permalink to this definition")
366
- Bases: [`arthurai.common.constants.ListableStrEnum`](arthurai.common.constants.ListableStrEnum.html#arthurai.common.constants.ListableStrEnum "arthurai.common.constants.ListableStrEnum")
367
-
368
-
369
- Methods
370
-
371
-
372
-
373
-
374
-
375
-
376
-
377
-
378
- | [`list`](#arthurai.core.alerts.AlertStatus.list "arthurai.core.alerts.AlertStatus.list") | Lists all attributes in alphabetical order |
379
-
380
-
381
-
382
- Attributes
383
-
384
-
385
-
386
-
387
-
388
-
389
-
390
-
391
- | `Acknowledged` | |
392
- | `Resolved` | |
393
-
394
-
395
-
396
-
397
-
398
- *classmethod* list()[#](#arthurai.core.alerts.AlertStatus.list "Permalink to this definition")
399
- Lists all attributes in alphabetical order
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
- [Next
410
-
411
- arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
412
- [Previous
413
-
414
- arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
415
-
416
-
417
-
418
-
419
- Copyright © 2022, Arthur
420
-
421
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
422
-
423
- [Furo](https://github.com/pradyunsg/furo)
424
-
425
-
426
-
427
-
428
-
429
-
430
-
431
-
432
-
433
-
434
-
435
-
436
-
437
-
438
-
439
-
440
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.core.alerts.Metric.md.txt DELETED
@@ -1,518 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.core.alerts.Metric - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](#)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.core.alerts.Metric[#](#arthurai-core-alerts-metric "Permalink to this headline")
360
- =========================================================================================
361
-
362
-
363
-
364
-
365
- *class* arthurai.core.alerts.Metric(*id*, *name*, *query*, *is\_default*, *type=None*, *attribute=None*)[#](#arthurai.core.alerts.Metric "Permalink to this definition")
366
- Bases: [`arthurai.core.base.ArthurBaseJsonDataclass`](arthurai.core.base.ArthurBaseJsonDataclass.html#arthurai.core.base.ArthurBaseJsonDataclass "arthurai.core.base.ArthurBaseJsonDataclass")
367
-
368
-
369
- Methods
370
-
371
-
372
-
373
-
374
-
375
-
376
-
377
-
378
- | [`clean\_nones`](#arthurai.core.alerts.Metric.clean_nones "arthurai.core.alerts.Metric.clean_nones") | Helper function to filter out None objects from a json or dictionary representation of an object |
379
- | `from\_dict` |
380
- rtype
381
- `TypeVar`(`A`, bound= `DataClassJsonMixin`)
382
-
383
- |
384
- | `from\_json` |
385
- rtype
386
- `TypeVar`(`A`, bound= `DataClassJsonMixin`)
387
-
388
- |
389
- | `schema` |
390
- rtype
391
- `SchemaF`[`TypeVar`(`A`)]
392
-
393
- |
394
- | [`to\_dict`](#arthurai.core.alerts.Metric.to_dict "arthurai.core.alerts.Metric.to_dict") | Creates a dictionary representation of this object |
395
- | [`to\_json`](#arthurai.core.alerts.Metric.to_json "arthurai.core.alerts.Metric.to_json") | Creates a json representation of this object |
396
-
397
-
398
-
399
- Attributes
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
- | `attribute` | |
409
- | `dataclass\_json\_config` | |
410
- | `type` | |
411
- | `id` | |
412
- | `name` | |
413
- | `query` | |
414
- | `is\_default` | |
415
-
416
-
417
-
418
-
419
-
420
- *static* clean\_nones(*d*)[#](#arthurai.core.alerts.Metric.clean_nones "Permalink to this definition")
421
- Helper function to filter out None objects from a json or dictionary representation of an object
422
-
423
-
424
-
425
- Parameters
426
- **d** – a Dictionary or Json representation of an ArthurBaseJsonDataclass object
427
-
428
-
429
-
430
- Returns
431
- Dictionary of the object with all None components removed
432
-
433
-
434
-
435
-
436
-
437
-
438
-
439
- to\_dict(*skip\_none=True*)[#](#arthurai.core.alerts.Metric.to_dict "Permalink to this definition")
440
- Creates a dictionary representation of this object
441
-
442
-
443
- This function can be applied to any extension of the ArthurBaseJsonDataClass
444
-
445
-
446
-
447
- Return type
448
- `dict`
449
-
450
-
451
-
452
- Returns
453
- Dictionary of object data
454
-
455
-
456
-
457
-
458
-
459
-
460
-
461
- to\_json(*skip\_none=True*)[#](#arthurai.core.alerts.Metric.to_json "Permalink to this definition")
462
- Creates a json representation of this object
463
-
464
-
465
- This function can be applied to any extension of the ArthurBaseJsonDataClass
466
-
467
-
468
-
469
- Return type
470
- `str`
471
-
472
-
473
-
474
- Returns
475
- json of object data
476
-
477
-
478
-
479
-
480
-
481
-
482
-
483
-
484
-
485
-
486
-
487
- [Next
488
-
489
- arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
490
- [Previous
491
-
492
- arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
493
-
494
-
495
-
496
-
497
- Copyright © 2022, Arthur
498
-
499
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
500
-
501
- [Furo](https://github.com/pradyunsg/furo)
502
-
503
-
504
-
505
-
506
-
507
-
508
-
509
-
510
-
511
-
512
-
513
-
514
-
515
-
516
-
517
-
518
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.core.alerts.md.txt DELETED
@@ -1,418 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.core.alerts - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](#)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.core.alerts[#](#module-arthurai.core.alerts "Permalink to this headline")
360
- ==================================================================================
361
-
362
-
363
- Classes
364
-
365
-
366
-
367
-
368
-
369
-
370
-
371
-
372
- | [`Alert`](arthurai.core.alerts.Alert.html#arthurai.core.alerts.Alert "arthurai.core.alerts.Alert")(id, timestamp, metric\_value, message, ...) | |
373
- | [`AlertRule`](arthurai.core.alerts.AlertRule.html#arthurai.core.alerts.AlertRule "arthurai.core.alerts.AlertRule")(bound, threshold, metric\_id, severity) | |
374
- | [`AlertRuleBound`](arthurai.core.alerts.AlertRuleBound.html#arthurai.core.alerts.AlertRuleBound "arthurai.core.alerts.AlertRuleBound")() | |
375
- | [`AlertRuleSeverity`](arthurai.core.alerts.AlertRuleSeverity.html#arthurai.core.alerts.AlertRuleSeverity "arthurai.core.alerts.AlertRuleSeverity")() | |
376
- | [`AlertStatus`](arthurai.core.alerts.AlertStatus.html#arthurai.core.alerts.AlertStatus "arthurai.core.alerts.AlertStatus")() | |
377
- | [`Metric`](arthurai.core.alerts.Metric.html#arthurai.core.alerts.Metric "arthurai.core.alerts.Metric")(id, name, query, is\_default[, type, ...]) | |
378
- | [`MetricType`](arthurai.core.alerts.MetricType.html#arthurai.core.alerts.MetricType "arthurai.core.alerts.MetricType")() | |
379
-
380
-
381
-
382
-
383
-
384
-
385
-
386
-
387
- [Next
388
-
389
- arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
390
- [Previous
391
-
392
- arthurai.core](arthurai.core.html)
393
-
394
-
395
-
396
-
397
- Copyright © 2022, Arthur
398
-
399
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
400
-
401
- [Furo](https://github.com/pradyunsg/furo)
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
-
411
-
412
-
413
-
414
-
415
-
416
-
417
-
418
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.core.attributes.AttributeBin.md.txt DELETED
@@ -1,520 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.core.attributes.AttributeBin - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](#)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.core.attributes.AttributeBin[#](#arthurai-core-attributes-attributebin "Permalink to this headline")
360
- =============================================================================================================
361
-
362
-
363
-
364
-
365
- *class* arthurai.core.attributes.AttributeBin(*continuous\_start=None*, *continuous\_end=None*)[#](#arthurai.core.attributes.AttributeBin "Permalink to this definition")
366
- Bases: [`arthurai.core.base.ArthurBaseJsonDataclass`](arthurai.core.base.ArthurBaseJsonDataclass.html#arthurai.core.base.ArthurBaseJsonDataclass "arthurai.core.base.ArthurBaseJsonDataclass")
367
-
368
-
369
-
370
- A list of the attribute’s bins. An attribute will only have bins if it is not categorical. The bin start isexclusive and the end is inclusive, (continuous\_start, continuous\_end]. Use Null to represent an open end of a bin.
371
-
372
-
373
-
374
-
375
- Methods
376
-
377
-
378
-
379
-
380
-
381
-
382
-
383
-
384
- | [`clean\_nones`](#arthurai.core.attributes.AttributeBin.clean_nones "arthurai.core.attributes.AttributeBin.clean_nones") | Helper function to filter out None objects from a json or dictionary representation of an object |
385
- | `from\_dict` |
386
- rtype
387
- `TypeVar`(`A`, bound= `DataClassJsonMixin`)
388
-
389
- |
390
- | `from\_json` |
391
- rtype
392
- `TypeVar`(`A`, bound= `DataClassJsonMixin`)
393
-
394
- |
395
- | `schema` |
396
- rtype
397
- `SchemaF`[`TypeVar`(`A`)]
398
-
399
- |
400
- | [`to\_dict`](#arthurai.core.attributes.AttributeBin.to_dict "arthurai.core.attributes.AttributeBin.to_dict") | Creates a dictionary representation of this object |
401
- | [`to\_json`](#arthurai.core.attributes.AttributeBin.to_json "arthurai.core.attributes.AttributeBin.to_json") | Creates a json representation of this object |
402
-
403
-
404
-
405
- Attributes
406
-
407
-
408
-
409
-
410
-
411
-
412
-
413
-
414
- | `continuous\_end` | |
415
- | `continuous\_start` | |
416
- | `dataclass\_json\_config` | |
417
-
418
-
419
-
420
-
421
-
422
- *static* clean\_nones(*d*)[#](#arthurai.core.attributes.AttributeBin.clean_nones "Permalink to this definition")
423
- Helper function to filter out None objects from a json or dictionary representation of an object
424
-
425
-
426
-
427
- Parameters
428
- **d** – a Dictionary or Json representation of an ArthurBaseJsonDataclass object
429
-
430
-
431
-
432
- Returns
433
- Dictionary of the object with all None components removed
434
-
435
-
436
-
437
-
438
-
439
-
440
-
441
- to\_dict(*skip\_none=True*)[#](#arthurai.core.attributes.AttributeBin.to_dict "Permalink to this definition")
442
- Creates a dictionary representation of this object
443
-
444
-
445
- This function can be applied to any extension of the ArthurBaseJsonDataClass
446
-
447
-
448
-
449
- Return type
450
- `dict`
451
-
452
-
453
-
454
- Returns
455
- Dictionary of object data
456
-
457
-
458
-
459
-
460
-
461
-
462
-
463
- to\_json(*skip\_none=True*)[#](#arthurai.core.attributes.AttributeBin.to_json "Permalink to this definition")
464
- Creates a json representation of this object
465
-
466
-
467
- This function can be applied to any extension of the ArthurBaseJsonDataClass
468
-
469
-
470
-
471
- Return type
472
- `str`
473
-
474
-
475
-
476
- Returns
477
- json of object data
478
-
479
-
480
-
481
-
482
-
483
-
484
-
485
-
486
-
487
-
488
-
489
- [Next
490
-
491
- arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
492
- [Previous
493
-
494
- arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
495
-
496
-
497
-
498
-
499
- Copyright © 2022, Arthur
500
-
501
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
502
-
503
- [Furo](https://github.com/pradyunsg/furo)
504
-
505
-
506
-
507
-
508
-
509
-
510
-
511
-
512
-
513
-
514
-
515
-
516
-
517
-
518
-
519
-
520
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.core.attributes.AttributeCategory.md.txt DELETED
@@ -1,517 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.core.attributes.AttributeCategory - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](#)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.core.attributes.AttributeCategory[#](#arthurai-core-attributes-attributecategory "Permalink to this headline")
360
- =======================================================================================================================
361
-
362
-
363
-
364
-
365
- *class* arthurai.core.attributes.AttributeCategory(*value*, *label=None*)[#](#arthurai.core.attributes.AttributeCategory "Permalink to this definition")
366
- Bases: [`arthurai.core.base.ArthurBaseJsonDataclass`](arthurai.core.base.ArthurBaseJsonDataclass.html#arthurai.core.base.ArthurBaseJsonDataclass "arthurai.core.base.ArthurBaseJsonDataclass")
367
-
368
-
369
- A list of the attribute’s categories. An attribute will only have categories if it is marked as categorical.
370
-
371
-
372
- Methods
373
-
374
-
375
-
376
-
377
-
378
-
379
-
380
-
381
- | [`clean\_nones`](#arthurai.core.attributes.AttributeCategory.clean_nones "arthurai.core.attributes.AttributeCategory.clean_nones") | Helper function to filter out None objects from a json or dictionary representation of an object |
382
- | `from\_dict` |
383
- rtype
384
- `TypeVar`(`A`, bound= `DataClassJsonMixin`)
385
-
386
- |
387
- | `from\_json` |
388
- rtype
389
- `TypeVar`(`A`, bound= `DataClassJsonMixin`)
390
-
391
- |
392
- | `schema` |
393
- rtype
394
- `SchemaF`[`TypeVar`(`A`)]
395
-
396
- |
397
- | [`to\_dict`](#arthurai.core.attributes.AttributeCategory.to_dict "arthurai.core.attributes.AttributeCategory.to_dict") | Creates a dictionary representation of this object |
398
- | [`to\_json`](#arthurai.core.attributes.AttributeCategory.to_json "arthurai.core.attributes.AttributeCategory.to_json") | Creates a json representation of this object |
399
-
400
-
401
-
402
- Attributes
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
-
411
- | `dataclass\_json\_config` | |
412
- | `label` | |
413
- | `value` | |
414
-
415
-
416
-
417
-
418
-
419
- *static* clean\_nones(*d*)[#](#arthurai.core.attributes.AttributeCategory.clean_nones "Permalink to this definition")
420
- Helper function to filter out None objects from a json or dictionary representation of an object
421
-
422
-
423
-
424
- Parameters
425
- **d** – a Dictionary or Json representation of an ArthurBaseJsonDataclass object
426
-
427
-
428
-
429
- Returns
430
- Dictionary of the object with all None components removed
431
-
432
-
433
-
434
-
435
-
436
-
437
-
438
- to\_dict(*skip\_none=True*)[#](#arthurai.core.attributes.AttributeCategory.to_dict "Permalink to this definition")
439
- Creates a dictionary representation of this object
440
-
441
-
442
- This function can be applied to any extension of the ArthurBaseJsonDataClass
443
-
444
-
445
-
446
- Return type
447
- `dict`
448
-
449
-
450
-
451
- Returns
452
- Dictionary of object data
453
-
454
-
455
-
456
-
457
-
458
-
459
-
460
- to\_json(*skip\_none=True*)[#](#arthurai.core.attributes.AttributeCategory.to_json "Permalink to this definition")
461
- Creates a json representation of this object
462
-
463
-
464
- This function can be applied to any extension of the ArthurBaseJsonDataClass
465
-
466
-
467
-
468
- Return type
469
- `str`
470
-
471
-
472
-
473
- Returns
474
- json of object data
475
-
476
-
477
-
478
-
479
-
480
-
481
-
482
-
483
-
484
-
485
-
486
- [Next
487
-
488
- arthurai.core.auth\_info](arthurai.core.auth_info.html)
489
- [Previous
490
-
491
- arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
492
-
493
-
494
-
495
-
496
- Copyright © 2022, Arthur
497
-
498
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
499
-
500
- [Furo](https://github.com/pradyunsg/furo)
501
-
502
-
503
-
504
-
505
-
506
-
507
-
508
-
509
-
510
-
511
-
512
-
513
-
514
-
515
-
516
-
517
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.core.attributes.md.txt DELETED
@@ -1,414 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.core.attributes - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](#)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.core.attributes[#](#module-arthurai.core.attributes "Permalink to this headline")
360
- ==========================================================================================
361
-
362
-
363
- Classes
364
-
365
-
366
-
367
-
368
-
369
-
370
-
371
-
372
- | [`ArthurAttribute`](arthurai.core.attributes.ArthurAttribute.html#arthurai.core.attributes.ArthurAttribute "arthurai.core.attributes.ArthurAttribute")(name, value\_type, stage[, ...]) | ArthurAttribute encapsulates data associated with a model attribute |
373
- | [`AttributeBin`](arthurai.core.attributes.AttributeBin.html#arthurai.core.attributes.AttributeBin "arthurai.core.attributes.AttributeBin")([continuous\_start, continuous\_end]) | A list of the attribute's bins. An attribute will only have bins if it is not categorical. The bin start is |
374
- | [`AttributeCategory`](arthurai.core.attributes.AttributeCategory.html#arthurai.core.attributes.AttributeCategory "arthurai.core.attributes.AttributeCategory")(value[, label]) | A list of the attribute's categories. |
375
-
376
-
377
-
378
-
379
-
380
-
381
-
382
-
383
- [Next
384
-
385
- arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
386
- [Previous
387
-
388
- arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
389
-
390
-
391
-
392
-
393
- Copyright © 2022, Arthur
394
-
395
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
396
-
397
- [Furo](https://github.com/pradyunsg/furo)
398
-
399
-
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
-
411
-
412
-
413
-
414
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.core.auth_info.AuthInfo.md.txt DELETED
@@ -1,521 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.core.auth\_info.AuthInfo - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](#)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.core.auth\_info.AuthInfo[#](#arthurai-core-auth-info-authinfo "Permalink to this headline")
360
- ====================================================================================================
361
-
362
-
363
-
364
-
365
- *class* arthurai.core.auth\_info.AuthInfo(*issuer*, *username*, *first\_name*, *last\_name*, *email*, *roles*, *organization\_ids*, *internal\_user\_id=None*, *external\_user\_id=None*)[#](#arthurai.core.auth_info.AuthInfo "Permalink to this definition")
366
- Bases: [`arthurai.core.base.ArthurBaseJsonDataclass`](arthurai.core.base.ArthurBaseJsonDataclass.html#arthurai.core.base.ArthurBaseJsonDataclass "arthurai.core.base.ArthurBaseJsonDataclass")
367
-
368
-
369
- Methods
370
-
371
-
372
-
373
-
374
-
375
-
376
-
377
-
378
- | [`clean\_nones`](#arthurai.core.auth_info.AuthInfo.clean_nones "arthurai.core.auth_info.AuthInfo.clean_nones") | Helper function to filter out None objects from a json or dictionary representation of an object |
379
- | `from\_dict` |
380
- rtype
381
- `TypeVar`(`A`, bound= `DataClassJsonMixin`)
382
-
383
- |
384
- | `from\_json` |
385
- rtype
386
- `TypeVar`(`A`, bound= `DataClassJsonMixin`)
387
-
388
- |
389
- | `schema` |
390
- rtype
391
- `SchemaF`[`TypeVar`(`A`)]
392
-
393
- |
394
- | [`to\_dict`](#arthurai.core.auth_info.AuthInfo.to_dict "arthurai.core.auth_info.AuthInfo.to_dict") | Creates a dictionary representation of this object |
395
- | [`to\_json`](#arthurai.core.auth_info.AuthInfo.to_json "arthurai.core.auth_info.AuthInfo.to_json") | Creates a json representation of this object |
396
-
397
-
398
-
399
- Attributes
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
- | `dataclass\_json\_config` | |
409
- | `external\_user\_id` | |
410
- | `internal\_user\_id` | |
411
- | `issuer` | |
412
- | `username` | |
413
- | `first\_name` | |
414
- | `last\_name` | |
415
- | `email` | |
416
- | `roles` | |
417
- | `organization\_ids` | |
418
-
419
-
420
-
421
-
422
-
423
- *static* clean\_nones(*d*)[#](#arthurai.core.auth_info.AuthInfo.clean_nones "Permalink to this definition")
424
- Helper function to filter out None objects from a json or dictionary representation of an object
425
-
426
-
427
-
428
- Parameters
429
- **d** – a Dictionary or Json representation of an ArthurBaseJsonDataclass object
430
-
431
-
432
-
433
- Returns
434
- Dictionary of the object with all None components removed
435
-
436
-
437
-
438
-
439
-
440
-
441
-
442
- to\_dict(*skip\_none=True*)[#](#arthurai.core.auth_info.AuthInfo.to_dict "Permalink to this definition")
443
- Creates a dictionary representation of this object
444
-
445
-
446
- This function can be applied to any extension of the ArthurBaseJsonDataClass
447
-
448
-
449
-
450
- Return type
451
- `dict`
452
-
453
-
454
-
455
- Returns
456
- Dictionary of object data
457
-
458
-
459
-
460
-
461
-
462
-
463
-
464
- to\_json(*skip\_none=True*)[#](#arthurai.core.auth_info.AuthInfo.to_json "Permalink to this definition")
465
- Creates a json representation of this object
466
-
467
-
468
- This function can be applied to any extension of the ArthurBaseJsonDataClass
469
-
470
-
471
-
472
- Return type
473
- `str`
474
-
475
-
476
-
477
- Returns
478
- json of object data
479
-
480
-
481
-
482
-
483
-
484
-
485
-
486
-
487
-
488
-
489
-
490
- [Next
491
-
492
- arthurai.core.base](arthurai.core.base.html)
493
- [Previous
494
-
495
- arthurai.core.auth\_info](arthurai.core.auth_info.html)
496
-
497
-
498
-
499
-
500
- Copyright © 2022, Arthur
501
-
502
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
503
-
504
- [Furo](https://github.com/pradyunsg/furo)
505
-
506
-
507
-
508
-
509
-
510
-
511
-
512
-
513
-
514
-
515
-
516
-
517
-
518
-
519
-
520
-
521
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.core.base.md.txt DELETED
@@ -1,412 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.core.base - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](#)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.core.base[#](#module-arthurai.core.base "Permalink to this headline")
360
- ==============================================================================
361
-
362
-
363
- Classes
364
-
365
-
366
-
367
-
368
-
369
-
370
-
371
-
372
- | [`ArthurBaseJsonDataclass`](arthurai.core.base.ArthurBaseJsonDataclass.html#arthurai.core.base.ArthurBaseJsonDataclass "arthurai.core.base.ArthurBaseJsonDataclass")() | |
373
-
374
-
375
-
376
-
377
-
378
-
379
-
380
-
381
- [Next
382
-
383
- arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
384
- [Previous
385
-
386
- arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
387
-
388
-
389
-
390
-
391
- Copyright © 2022, Arthur
392
-
393
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
394
-
395
- [Furo](https://github.com/pradyunsg/furo)
396
-
397
-
398
-
399
-
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
-
411
-
412
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.core.bias.bias_metrics.BiasMetrics.md.txt DELETED
@@ -1,495 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.core.bias.bias\_metrics.BiasMetrics - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](#)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.core.bias.bias\_metrics.BiasMetrics[#](#arthurai-core-bias-bias-metrics-biasmetrics "Permalink to this headline")
360
- ==========================================================================================================================
361
-
362
-
363
-
364
-
365
- *class* arthurai.core.bias.bias\_metrics.BiasMetrics(*arthur\_model*)[#](#arthurai.core.bias.bias_metrics.BiasMetrics "Permalink to this definition")
366
- Bases: `object`
367
-
368
-
369
- Methods
370
-
371
-
372
-
373
-
374
-
375
-
376
-
377
-
378
- | [`demographic\_parity`](#arthurai.core.bias.bias_metrics.BiasMetrics.demographic_parity "arthurai.core.bias.bias_metrics.BiasMetrics.demographic_parity") | Get group-conditional positivity rates for all inferences, with the option to filter for a batch\_id or a particular chunk of time. |
379
- | [`group\_confusion\_matrices`](#arthurai.core.bias.bias_metrics.BiasMetrics.group_confusion_matrices "arthurai.core.bias.bias_metrics.BiasMetrics.group_confusion_matrices") | Get group-conditional confusion matrices for all inferences, with the option to filter for a batch\_id or a particular chunk of time. |
380
- | [`group\_positivity\_rates`](#arthurai.core.bias.bias_metrics.BiasMetrics.group_positivity_rates "arthurai.core.bias.bias_metrics.BiasMetrics.group_positivity_rates") | Get group-conditional positivity rates for all inferences, with the option to filter for a batch\_id or a particular chunk of time. |
381
-
382
-
383
-
384
-
385
-
386
- demographic\_parity(*attr\_name*, *batch\_id=None*, *start\_time=None*, *end\_time=None*)[#](#arthurai.core.bias.bias_metrics.BiasMetrics.demographic_parity "Permalink to this definition")
387
- Get group-conditional positivity rates for all inferences, with the option to filter for a batch\_id or
388
- a particular chunk of time. Currently only supports calculating bias with respect to a single sensitive
389
- attribute at a time. This method currently only handles binary models.
390
-
391
-
392
-
393
- Parameters
394
- * **attr\_name** (`str`) – The name of the sensitive attribute to get metrics for.
395
- * **batch\_id** (`Optional`[`str`]) – Optional filter to limit calculations to a specific batch ID.
396
- * **start\_time** (`Optional`[`datetime`]) – Optional filter to limit calculations to inferences after a specific timestamp.
397
- * **end\_time** (`Optional`[`datetime`]) – Optional filter to limit calculations to inferences before a specific timestamp.
398
-
399
-
400
-
401
- Returns
402
- A dict of the form {sens\_1: pos\_1, sens\_2: pos\_2, …}
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
- group\_confusion\_matrices(*attr\_name*, *pred\_property=None*, *batch\_id=None*, *start\_time=None*, *end\_time=None*, *return\_by\_metric=True*)[#](#arthurai.core.bias.bias_metrics.BiasMetrics.group_confusion_matrices "Permalink to this definition")
411
- Get group-conditional confusion matrices for all inferences, with the option to filter for a batch\_id or
412
- a particular chunk of time. Currently only supports calculating bias with respect to a single sensitive
413
- attribute at a time. This method handles both binary and multiclass models.
414
-
415
-
416
-
417
- Parameters
418
- * **attr\_name** (`str`) – The name of the sensitive attribute to get metrics for.
419
- * **pred\_property** (`Optional`[`str`]) – For multiclass models, the predicted label to get the confusion matrix for.
420
- * **batch\_id** (`Optional`[`str`]) – Optional filter to limit calculations to a specific batch ID.
421
- * **start\_time** (`Optional`[`datetime`]) – Optional filter to limit calculations to inferences after a specific timestamp.
422
- * **end\_time** (`Optional`[`datetime`]) – Optional filter to limit calculations to inferences before a specific timestamp.
423
- * **return\_by\_metric** – Whether the returned dictionary of results should be keyed by metric or by sensitive attribute value.
424
-
425
-
426
-
427
- Returns
428
- Either a dict of the form { metric: { sens\_1: val1, sens\_2: val2 }, …} (default) or its reverse.
429
-
430
-
431
-
432
-
433
-
434
-
435
-
436
- group\_positivity\_rates(*attr\_name*, *batch\_id=None*, *start\_time=None*, *end\_time=None*)[#](#arthurai.core.bias.bias_metrics.BiasMetrics.group_positivity_rates "Permalink to this definition")
437
- Get group-conditional positivity rates for all inferences, with the option to filter for a batch\_id or
438
- a particular chunk of time. Currently only supports calculating bias with respect to a single sensitive
439
- attribute at a time. This method currently only handles binary models.
440
-
441
-
442
-
443
- Parameters
444
- * **attr\_name** (`str`) – The name of the sensitive attribute to get metrics for.
445
- * **batch\_id** (`Optional`[`str`]) – Optional filter to limit calculations to a specific batch ID.
446
- * **start\_time** (`Optional`[`datetime`]) – Optional filter to limit calculations to inferences after a specific timestamp.
447
- * **end\_time** (`Optional`[`datetime`]) – Optional filter to limit calculations to inferences before a specific timestamp.
448
-
449
-
450
-
451
- Returns
452
- A dict of the form {sens\_1: pos\_1, sens\_2: pos\_2, …}
453
-
454
-
455
-
456
-
457
-
458
-
459
-
460
-
461
-
462
-
463
-
464
- [Next
465
-
466
- arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)
467
- [Previous
468
-
469
- arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)
470
-
471
-
472
-
473
-
474
- Copyright © 2022, Arthur
475
-
476
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
477
-
478
- [Furo](https://github.com/pradyunsg/furo)
479
-
480
-
481
-
482
-
483
-
484
-
485
-
486
-
487
-
488
-
489
-
490
-
491
-
492
-
493
-
494
-
495
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
files/arthur-docs-markdown/sdk/arthurai.core.bias.bias_metrics.md.txt DELETED
@@ -1,412 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- arthurai.core.bias.bias\_metrics - Arthur SDK Reference documentation
8
-
9
-
10
-
11
-
12
-
13
- body {
14
- --color-code-background: #f8f8f8;
15
- --color-code-foreground: black;
16
- --color-foreground-primary: #1a0016;
17
- --color-foreground-secondary: #473351;
18
- --color-background-primary: #ffffff;
19
- --color-background-secondary: #473351;
20
- --color-brand-primary: #b536fb;
21
- --color-api-background: #e4e0e4;
22
- --color-background-border: #e4e0e4;
23
- --color-inline-code-background: #e4e0e4;
24
- --color-icon: #473351;
25
- --color-toc-item-text: #1a0016;
26
- --color-toc-item-text--active: #473351;
27
- --color-highlight-on-target: #c7fdd1;
28
- --color-brand-content: #329ad7;
29
- --color-sidebar-background: #473351;
30
- --color-sidebar-link-text: #ffffff;
31
- --color-sidebar-link-text--top-level: #c7fdd1;
32
- --color-sidebar-item-background--hover: #ffffff;
33
- --color-sidebar-text--hover: #1a0016;
34
- --color-sidebar-search-text: #ffffff;
35
- --color-sidebar-search-border: #e4e0e4;
36
- --color-sidebar-search-foreground: #1a0016;
37
- --color-sidebar-search-foreground--inactive: #e4e0e4;
38
- --color-sidebar-search-background--focus: #ffffff;
39
- --font-stack: Graphik, sans-serif;
40
- --font-stack--monospace: IBM Plex Mono, monospace;
41
- --color-table-header-background: #e4e0e4;
42
-
43
- }
44
- @media not print {
45
- body[data-theme="dark"] {
46
- --color-code-background: #202020;
47
- --color-code-foreground: #d0d0d0;
48
- --color-foreground-primary: #ffffff;
49
- --color-foreground-secondary: #e4e0e4;
50
- --color-background-primary: #1a0016;
51
- --color-background-secondary: #473351;
52
- --color-brand-primary: #b536fb;
53
- --color-api-background: #473351;
54
- --color-background-border: #473351;
55
- --color-inline-code-background: #473351;
56
- --color-icon: #e4e0e4;
57
- --color-toc-item-text: #ffffff;
58
- --color-toc-item-text--active: #e4e0e4;
59
- --color-highlight-on-target: #473351;
60
- --color-brand-content: #329ad7;
61
- --color-sidebar-background: #473351;
62
- --color-sidebar-link-text: #ffffff;
63
- --color-sidebar-link-text--top-level: #c7fdd1;
64
- --color-sidebar-item-background--hover: #ffffff;
65
- --color-sidebar-text--hover: #1a0016;
66
- --color-sidebar-search-text: #ffffff;
67
- --color-sidebar-search-border: #e4e0e4;
68
- --color-sidebar-search-foreground: #1a0016;
69
- --color-sidebar-search-foreground--inactive: #e4e0e4;
70
- --color-sidebar-search-background--focus: #ffffff;
71
- --font-stack: Graphik, sans-serif;
72
- --font-stack--monospace: IBM Plex Mono, monospace;
73
- --color-table-header-background: #473351;
74
-
75
- }
76
- @media (prefers-color-scheme: dark) {
77
- body:not([data-theme="light"]) {
78
- --color-code-background: #202020;
79
- --color-code-foreground: #d0d0d0;
80
- --color-foreground-primary: #ffffff;
81
- --color-foreground-secondary: #e4e0e4;
82
- --color-background-primary: #1a0016;
83
- --color-background-secondary: #473351;
84
- --color-brand-primary: #b536fb;
85
- --color-api-background: #473351;
86
- --color-background-border: #473351;
87
- --color-inline-code-background: #473351;
88
- --color-icon: #e4e0e4;
89
- --color-toc-item-text: #ffffff;
90
- --color-toc-item-text--active: #e4e0e4;
91
- --color-highlight-on-target: #473351;
92
- --color-brand-content: #329ad7;
93
- --color-sidebar-background: #473351;
94
- --color-sidebar-link-text: #ffffff;
95
- --color-sidebar-link-text--top-level: #c7fdd1;
96
- --color-sidebar-item-background--hover: #ffffff;
97
- --color-sidebar-text--hover: #1a0016;
98
- --color-sidebar-search-text: #ffffff;
99
- --color-sidebar-search-border: #e4e0e4;
100
- --color-sidebar-search-foreground: #1a0016;
101
- --color-sidebar-search-foreground--inactive: #e4e0e4;
102
- --color-sidebar-search-background--focus: #ffffff;
103
- --font-stack: Graphik, sans-serif;
104
- --font-stack--monospace: IBM Plex Mono, monospace;
105
- --color-table-header-background: #473351;
106
-
107
- }
108
- }
109
- }
110
-
111
-
112
-
113
- document.body.dataset.theme = localStorage.getItem("theme") || "auto";
114
-
115
-
116
-
117
- Contents
118
-
119
-
120
-
121
-
122
-
123
- Menu
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- Expand
132
-
133
-
134
-
135
-
136
-
137
- Light mode
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- Dark mode
152
-
153
-
154
-
155
-
156
-
157
-
158
- Auto light/dark mode
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- Hide navigation sidebar
174
-
175
-
176
- Hide table of contents sidebar
177
-
178
-
179
-
180
-
181
-
182
- Toggle site navigation sidebar
183
-
184
-
185
-
186
-
187
- [Arthur SDK Reference documentation](../index.html)
188
-
189
-
190
-
191
-
192
- Toggle Light / Dark / Auto color theme
193
-
194
-
195
-
196
-
197
-
198
-
199
- Toggle table of contents sidebar
200
-
201
-
202
-
203
-
204
-
205
-
206
- [![Light Logo](../_static/images/dark-mode-logo.svg)
207
- ![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html)
208
-
209
-
210
-
211
-
212
-
213
- * [Arthur Docs](https://docs.arthur.ai)
214
- * [SDK Home](../index.html)
215
- * [Permissions by Function](../permissions.html)
216
- * [arthurai](arthurai.html)Toggle child pages in navigation
217
- + [arthurai.client](arthurai.client.html)Toggle child pages in navigation
218
- - [arthurai.client.apiv3](arthurai.client.apiv3.html)
219
- - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation
220
- * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html)
221
- * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html)
222
- - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation
223
- * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html)
224
- * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html)
225
- * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html)
226
- * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html)
227
- * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html)
228
- - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation
229
- * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation
230
- + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html)
231
- * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation
232
- + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html)
233
- * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation
234
- + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html)
235
- - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation
236
- * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html)
237
- * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html)
238
- + [arthurai.common](arthurai.common.html)Toggle child pages in navigation
239
- - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation
240
- * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html)
241
- * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html)
242
- * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html)
243
- * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html)
244
- * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html)
245
- * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html)
246
- * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html)
247
- * [arthurai.common.constants.Role](arthurai.common.constants.Role.html)
248
- * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html)
249
- * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html)
250
- * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html)
251
- - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation
252
- * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html)
253
- - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation
254
- * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html)
255
- * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html)
256
- * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html)
257
- * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html)
258
- + [arthurai.core](arthurai.core.html)Toggle child pages in navigation
259
- - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation
260
- * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html)
261
- * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html)
262
- * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html)
263
- * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html)
264
- * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html)
265
- * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html)
266
- * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html)
267
- - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation
268
- * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html)
269
- * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html)
270
- * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html)
271
- - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation
272
- * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html)
273
- - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation
274
- * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html)
275
- - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation
276
- * [arthurai.core.bias.bias\_metrics](#)Toggle child pages in navigation
277
- + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
278
- * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation
279
- + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html)
280
- * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation
281
- + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html)
282
- + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html)
283
- - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation
284
- * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html)
285
- * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html)
286
- - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation
287
- * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html)
288
- - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation
289
- * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html)
290
- * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html)
291
- * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html)
292
- * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html)
293
- - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation
294
- * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html)
295
- * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html)
296
- * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html)
297
- - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation
298
- * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html)
299
- * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html)
300
- * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html)
301
- - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation
302
- * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html)
303
- * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html)
304
- * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html)
305
- * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html)
306
- * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html)
307
- * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html)
308
- - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation
309
- * [arthurai.core.viz.style](arthurai.core.viz.style.html)
310
- * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation
311
- + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html)
312
- + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html)
313
- * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation
314
- + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html)
315
- + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation
316
- - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation
317
- * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html)
318
- * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html)
319
- - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation
320
- * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html)
321
- - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation
322
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html)
323
- * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html)
324
- + [arthurai.util](arthurai.util.html)Toggle child pages in navigation
325
- - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html)
326
- - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html)
327
- - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html)
328
- - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html)
329
- - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html)
330
- - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html)
331
- + [arthurai.version](arthurai.version.html)
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- [Back to top](#)
343
-
344
-
345
-
346
- Toggle Light / Dark / Auto color theme
347
-
348
-
349
-
350
-
351
-
352
-
353
- Toggle table of contents sidebar
354
-
355
-
356
-
357
-
358
-
359
- arthurai.core.bias.bias\_metrics[#](#module-arthurai.core.bias.bias_metrics "Permalink to this headline")
360
- =========================================================================================================
361
-
362
-
363
- Classes
364
-
365
-
366
-
367
-
368
-
369
-
370
-
371
-
372
- | [`BiasMetrics`](arthurai.core.bias.bias_metrics.BiasMetrics.html#arthurai.core.bias.bias_metrics.BiasMetrics "arthurai.core.bias.bias_metrics.BiasMetrics")(arthur\_model) | |
373
-
374
-
375
-
376
-
377
-
378
-
379
-
380
-
381
- [Next
382
-
383
- arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html)
384
- [Previous
385
-
386
- arthurai.core.bias](arthurai.core.bias.html)
387
-
388
-
389
-
390
-
391
- Copyright © 2022, Arthur
392
-
393
- Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s
394
-
395
- [Furo](https://github.com/pradyunsg/furo)
396
-
397
-
398
-
399
-
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
-
411
-
412
-