diff --git a/files/arthur-docs-markdown/sdk/arthurai.client.apiv3.md.txt b/files/arthur-docs-markdown/sdk/arthurai.client.apiv3.md.txt deleted file mode 100644 index ec06873a3a088ab1ec702134625244727ce818d8..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.client.apiv3.md.txt +++ /dev/null @@ -1,419 +0,0 @@ - - - - - - -arthurai.client.apiv3 - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](#) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.client.apiv3[#](#module-arthurai.client.apiv3 "Permalink to this headline") -==================================================================================== - - -SDK Version 2 backward compatibility - - -This convenience module provides compatibility with the ArthurAI SDK version 2.x, but is considered deprecated. Please -update your import paths according to the following: - - -* arthurai.client.apiv3.InputType → arthurai.common.constants.InputType -* arthurai.client.apiv3.OutputType → arthurai.common.constants.OutputType -* arthurai.client.apiv3.ValueType → arthurai.common.constants.ValueType -* arthurai.client.apiv3.Stage → arthurai.common.constants.Stage -* arthurai.client.apiv3.TextDelimiter → arthurai.common.constants.TextDelimiter -* arthurai.client.apiv3.ListableStrEnum → arthurai.common.constants.ListableStrEnum -* arthurai.client.apiv3.AttributeCategory → arthurai.core.attributes.AttributeCategory -* arthurai.client.apiv3.AttributeBin → arthurai.core.attributes.AttributeBin -* arthurai.client.apiv3.arthur\_explainer → arthurai.explainability.arthur\_explainer -* arthurai.client.apiv3.decorators → arthurai.core.decorators -* arthurai.client.apiv3.explanation\_packager → arthurai.explainability.explanation\_packager - - - - - - - -[Next - -arthurai.client.client](arthurai.client.client.html) -[Previous - -arthurai.client](arthurai.client.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.client.client.ArthurAI.md.txt b/files/arthur-docs-markdown/sdk/arthurai.client.client.ArthurAI.md.txt deleted file mode 100644 index b7098b560a8b7ef38698bb4582fe6dac913cd7f0..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.client.client.ArthurAI.md.txt +++ /dev/null @@ -1,650 +0,0 @@ - - - - - - -arthurai.client.client.ArthurAI - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](#) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.client.client.ArthurAI[#](#arthurai-client-client-arthurai "Permalink to this headline") -================================================================================================= - - - - -*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") -Bases: `object` - - -A client that interacts with Arthur’s servers. - - -Methods - - - - - - - - -| [`create\_service\_account`](#arthurai.client.client.ArthurAI.create_service_account "arthurai.client.client.ArthurAI.create_service_account") | Create a new service account | -| [`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 | -| [`get\_model`](#arthurai.client.client.ArthurAI.get_model "arthurai.client.client.ArthurAI.get_model") | Retrieve an existing model by id | -| [`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 | -| [`get\_service\_accounts`](#arthurai.client.client.ArthurAI.get_service_accounts "arthurai.client.client.ArthurAI.get_service_accounts") | Retrieve service accounts | -| [`model`](#arthurai.client.client.ArthurAI.model "arthurai.client.client.ArthurAI.model") | Create a new multistage model. | -| [`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 | - - - - - -create\_service\_account(*description*, *role*)[#](#arthurai.client.client.ArthurAI.create_service_account "Permalink to this definition") -Create a new service account - - - -Parameters -* **description** (`str`) – the description for the new service account -* **role** ([`Role`](arthurai.common.constants.Role.html#arthurai.common.constants.Role "arthurai.common.constants.Role")) – the Role of the new service account - - - -Returns -parsed response in the following format: - - - -``` -{ - "id": "", - "organization\_id": "", - "description": "", - "token": "" -} - -``` - - - - - - - -get\_current\_org()[#](#arthurai.client.client.ArthurAI.get_current_org "Permalink to this definition") -Retrieves the current organization that the client is operating in - - - -Return type -`Dict`[`str`, `str`] - - - -Returns -a string with the UUID of the current organization - - - -Permissions -N/A - - - - - - - -get\_model(*identifier*, *id\_type='id'*)[#](#arthurai.client.client.ArthurAI.get_model "Permalink to this definition") -Retrieve an existing model by id - - - -Param -identifier: Id to get the model by - - - -Param -id\_type: Type of id the identifier is, possible options are [‘id’, ‘partner\_model\_id’] - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - -Permissions -model read - - - -Return type -[`ArthurModel`](arthurai.core.models.ArthurModel.html#arthurai.core.models.ArthurModel "arthurai.core.models.ArthurModel") - - - - - - - -get\_model\_group(*id\_or\_model*)[#](#arthurai.client.client.ArthurAI.get_model_group "Permalink to this definition") -(BETA) Retrieve an existing model group by id - - - -Param -identifier: Id to get the model group by - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - -Permissions -model\_group read - - - -Return type -[`ArthurModelGroup`](arthurai.core.models.ArthurModelGroup.html#arthurai.core.models.ArthurModelGroup "arthurai.core.models.ArthurModelGroup") - - - - - - - -get\_service\_accounts(*description=None*)[#](#arthurai.client.client.ArthurAI.get_service_accounts "Permalink to this definition") -Retrieve service accounts - - - -Parameters -**description** (`Optional`[`str`]) – an optional description that returned account should match - - - -Returns -parsed response containing a list of service accounts, in the following format: - - - -``` -[ - { - "id": "", - "organization\_id": "", - "description": "", - "token": "" - } -] - -``` - - - - - - - -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") -Create a new multistage model. - - - -Parameters -* **partner\_model\_id** (`str`) – The string external id of the model -* **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") -* **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") -* **model\_type** (`Optional`[[`OutputType`](arthurai.common.constants.OutputType.html#arthurai.common.constants.OutputType "arthurai.common.constants.OutputType")]) – - - -Deprecated since version version: 2.0.0 Use output\_type instead. -* **display\_name** (`Optional`[`str`]) – Optional name to display on dashboard, will default to the external id -* **description** (`Optional`[`str`]) – Optional description for the model -* **tags** (`Optional`[`List`[`str`]]) – A list of string tags to associate with the model -* **classifier\_threshold** (`Optional`[`float`]) – For binary classification models this is the threshold to determine a positive class, defaults to 0.5 -* **is\_batch** (`bool`) – boolean value which signifies whether the model sends inferences by batch or streaming -* **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 -* **expected\_throughput\_gb\_per\_day** (`Optional`[`int`]) – Expected amount of throughput. Used to provision resources -* **pixel\_height** (`Optional`[`int`]) – Image height in pixels. Needed for CV models which require images to be one size -* **pixel\_width** (`Optional`[`int`]) – Image width in pixels. Needed for CV models which require images to be one size - - - -Return type -[`ArthurModel`](arthurai.core.models.ArthurModel.html#arthurai.core.models.ArthurModel "arthurai.core.models.ArthurModel") - - - -Returns -An `ArthurModel` - - - - - - - -set\_current\_org(*org\_id*)[#](#arthurai.client.client.ArthurAI.set_current_org "Permalink to this definition") -Sets the current organization that the client’s requests apply to - - - -Parameters -**org\_id** (`str`) – The ID of the organization to set - - - -Return type -`None` - - - -Returns -None - - - -Permissions -N/A - - - - - - - - - - - -[Next - -arthurai.client.helper](arthurai.client.helper.html) -[Previous - -arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.client.client.md.txt b/files/arthur-docs-markdown/sdk/arthurai.client.client.md.txt deleted file mode 100644 index fe688c648847a9050c65f79c55cb008ff5e5ad7a..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.client.client.md.txt +++ /dev/null @@ -1,443 +0,0 @@ - - - - - - -arthurai.client.client - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](#)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.client.client[#](#module-arthurai.client.client "Permalink to this headline") -====================================================================================== - - -Functions - - - - - - - - -| [`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, ...]) | -rtype -[`HTTPClient`](arthurai.client.http.requests.HTTPClient.html#arthurai.client.http.requests.HTTPClient "arthurai.client.http.requests.HTTPClient") - - | - - - -Classes - - - - - - - - -| [`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. | - - - - - - - - -[Next - -arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) -[Previous - -arthurai.client.apiv3](arthurai.client.apiv3.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - On this page - - - - -* [arthurai.client.client](#) - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.client.client.new_requests_client.md.txt b/files/arthur-docs-markdown/sdk/arthurai.client.client.new_requests_client.md.txt deleted file mode 100644 index 6db62360fe7644f3e2e4157790a484e336e24d97..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.client.client.new_requests_client.md.txt +++ /dev/null @@ -1,410 +0,0 @@ - - - - - - -arthurai.client.client.new\_requests\_client - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](#) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.client.client.new\_requests\_client[#](#arthurai-client-client-new-requests-client "Permalink to this headline") -========================================================================================================================= - - - - -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") - -Return type -[`HTTPClient`](arthurai.client.http.requests.HTTPClient.html#arthurai.client.http.requests.HTTPClient "arthurai.client.http.requests.HTTPClient") - - - - - - - - - - -[Next - -arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) -[Previous - -arthurai.client.client](arthurai.client.client.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.client.helper.construct_url.md.txt b/files/arthur-docs-markdown/sdk/arthurai.client.helper.construct_url.md.txt deleted file mode 100644 index fd1b8c25cfc3f695408a0db57f131daea279e199..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.client.helper.construct_url.md.txt +++ /dev/null @@ -1,430 +0,0 @@ - - - - - - -arthurai.client.helper.construct\_url - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](#) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.client.helper.construct\_url[#](#arthurai-client-helper-construct-url "Permalink to this headline") -============================================================================================================ - - - - -arthurai.client.helper.construct\_url(*\*parts*, *validate=True*, *default\_https=True*)[#](#arthurai.client.helper.construct_url "Permalink to this definition") -Construct a url from various parts - - -Useful for joining pieces which may or may not have leading and/or trailing -slashes. e.g. construct\_url(””, “/api/v3”, “/users”) will yield the same valid url as -construct\_url(””, “api/v3/”, “users/”). - - - -Parameters -* **validate** – if True, validate that the URL is valid -* **default\_https** – if True, allow urls without a scheme and use https by default -* **parts** (`str`) – strings from which to construct the url - - - -Return type -`str` - - - -Returns -a fully joined url - - - - - - - - - - -[Next - -arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) -[Previous - -arthurai.client.helper](arthurai.client.helper.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.client.helper.get_auth_info.md.txt b/files/arthur-docs-markdown/sdk/arthurai.client.helper.get_auth_info.md.txt deleted file mode 100644 index bc7f9040d96198e461284830143e0d825a8bb837..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.client.helper.get_auth_info.md.txt +++ /dev/null @@ -1,431 +0,0 @@ - - - - - - -arthurai.client.helper.get\_auth\_info - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](#) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.client.helper.get\_auth\_info[#](#arthurai-client-helper-get-auth-info "Permalink to this headline") -============================================================================================================= - - - - -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") -Get the AuthInfo struct associated with the provided access key - - - -Parameters -* **api\_http\_host** (`str`) – base url of the host to connect to, including protocol (e.g. “”) -* **api\_prefix** (`str`) – prefix of the API to connect to (e.g. “/api/v3”) -* **access\_key** (`str`) – API token to pass to the API -* **verify\_ssl** (`bool`) – Boolean for whether requests should verify that the SSL certificate is valid and not self-signed - - - -Return type -`Optional`[[`AuthInfo`](arthurai.core.auth_info.AuthInfo.html#arthurai.core.auth_info.AuthInfo "arthurai.core.auth_info.AuthInfo")] - - - -Returns -the AuthInfo associated with the provided access key - - - -Permissions -N/A - - - - - - - - - - -[Next - -arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) -[Previous - -arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.client.helper.get_current_org.md.txt b/files/arthur-docs-markdown/sdk/arthurai.client.helper.get_current_org.md.txt deleted file mode 100644 index d48b4b985d79efedb1b5eb27cc124f22e7a473d9..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.client.helper.get_current_org.md.txt +++ /dev/null @@ -1,426 +0,0 @@ - - - - - - -arthurai.client.helper.get\_current\_org - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](#) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.client.helper.get\_current\_org[#](#arthurai-client-helper-get-current-org "Permalink to this headline") -================================================================================================================= - - - - -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") -Get the current organization for the provided access key - - - -Parameters -* **api\_http\_host** (`str`) – base url of the host to connect to, including protocol (e.g. “”) -* **api\_prefix** (`str`) – prefix of the API to connect to (e.g. “/api/v3”) -* **access\_key** (`str`) – API Key to pass to the API -* **verify\_ssl** (`bool`) – Boolean for whether requests should verify that the SSL certificate is valid and not self-signed - - - -Return type -`Optional`[`str`] - - - -Returns -the organization ID associated with the provided access key, None if no such organization exists - - - - - - - - - - -[Next - -arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) -[Previous - -arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.client.helper.md.txt b/files/arthur-docs-markdown/sdk/arthurai.client.helper.md.txt deleted file mode 100644 index 51a68772a8602e21d2135bbf896e0e77586fbf7c..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.client.helper.md.txt +++ /dev/null @@ -1,416 +0,0 @@ - - - - - - -arthurai.client.helper - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](#)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.client.helper[#](#module-arthurai.client.helper "Permalink to this headline") -====================================================================================== - - -Functions - - - - - - - - -| [`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 | -| [`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 | -| [`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 | -| [`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 | -| [`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 | - - - - - - - - -[Next - -arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) -[Previous - -arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.client.helper.user_login.md.txt b/files/arthur-docs-markdown/sdk/arthurai.client.helper.user_login.md.txt deleted file mode 100644 index 7f7e4b8f1fd78895519c420166137701cca50c25..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.client.helper.user_login.md.txt +++ /dev/null @@ -1,427 +0,0 @@ - - - - - - -arthurai.client.helper.user\_login - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](#) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.client.helper.user\_login[#](#arthurai-client-helper-user-login "Permalink to this headline") -====================================================================================================== - - - - -arthurai.client.helper.user\_login(*api\_http\_host*, *api\_prefix*, *login*, *password*, *verify\_ssl=True*)[#](#arthurai.client.helper.user_login "Permalink to this definition") -Get the current organization for the provided access key - - - -Parameters -* **api\_http\_host** (`str`) – base url of the host to connect to, including protocol (e.g. “”) -* **api\_prefix** (`str`) – prefix of the API to connect to (e.g. “/api/v3”) -* **login** (`str`) – the username or password to use to log in -* **password** (`str`) – password for the user -* **verify\_ssl** (`bool`) – Boolean for whether requests should verify that the SSL certificate is valid and not self-signed - - - -Return type -`Tuple`[`str`, `Dict`[`str`, `Any`]] - - - -Returns -a tuple of (access\_key, {user object}) - - - - - - - - - - -[Next - -arthurai.client.http](arthurai.client.http.html) -[Previous - -arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.client.http.arthur.ArthurHTTPClient.md.txt b/files/arthur-docs-markdown/sdk/arthurai.client.http.arthur.ArthurHTTPClient.md.txt deleted file mode 100644 index a2d02360d8aac7a5c1269ac473a2f83a729607f2..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.client.http.arthur.ArthurHTTPClient.md.txt +++ /dev/null @@ -1,568 +0,0 @@ - - - - - - -arthurai.client.http.arthur.ArthurHTTPClient - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](#) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.client.http.arthur.ArthurHTTPClient[#](#arthurai-client-http-arthur-arthurhttpclient "Permalink to this headline") -=========================================================================================================================== - - - - -*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") -Bases: [`arthurai.client.http.base.AbstractHTTPClient`](arthurai.client.http.base.AbstractHTTPClient.html#arthurai.client.http.base.AbstractHTTPClient "arthurai.client.http.base.AbstractHTTPClient") - - -An HTTPClient that uses Arthur-specific parameters - - - -Deprecated since version 3.13.1. - - - -Methods - - - - - - - - -| [`async\_call`](#arthurai.client.http.arthur.ArthurHTTPClient.async_call "arthurai.client.http.arthur.ArthurHTTPClient.async_call") | Starts a new process asynchronously | -| [`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 | -| [`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 | -| [`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 | -| [`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 | -| [`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 | -| [`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 | - - - - - -*static* async\_call(*rest\_call*, *pool*, *\*args*, *callback=None*)[#](#arthurai.client.http.arthur.ArthurHTTPClient.async_call "Permalink to this definition") -Starts a new process asynchronously - - - -Parameters -* **rest\_call** – a pointer to the rest call which should be executed async -* **pool** – python process pool to take processes from -* **callback** – function which will get called given the response of the child thread - - - -Returns -returns a python AsyncResult object - - - - - - - -delete(*url*, *headers=None*, *return\_raw\_response=False*, *retries=0*)[#](#arthurai.client.http.arthur.ArthurHTTPClient.delete "Permalink to this definition") -Sends a DELETE request to the given url with the given headers - - - -Parameters -* **return\_raw\_response** – If true do not filter response, return raw object -* **url** – url to send request to -* **headers** – headers to use in the request -* **retries** – Number of times to retry the request if it results in a 400 or higher response code - - - -Returns -response of the rest call - - - - - - - -get(*url*, *headers=None*, *params=None*, *return\_raw\_response=False*, *retries=0*)[#](#arthurai.client.http.arthur.ArthurHTTPClient.get "Permalink to this definition") -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 - - - - - -patch(*url*, *json=None*, *files=None*, *headers=None*, *return\_raw\_response=False*, *retries=0*)[#](#arthurai.client.http.arthur.ArthurHTTPClient.patch "Permalink to this definition") -Sends a PATCH request to the given url with the given headers - - - -Parameters -* **return\_raw\_response** – If true do not filter response, return raw object -* **url** – url to send request to -* **headers** – headers to use in the request -* **retries** – Number of times to retry the request if it results in a 400 or higher response code - - - -Returns -response of the rest call - - - - - - - -post(*url*, *json=None*, *files=None*, *headers=None*, *return\_raw\_response=False*, *retries=0*)[#](#arthurai.client.http.arthur.ArthurHTTPClient.post "Permalink to this definition") -Sends a POST request to the given url with the given headers - - - -Parameters -* **return\_raw\_response** – If true do not filter response, return raw object -* **url** – url to send request to -* **headers** – headers to use in the request -* **retries** – Number of times to retry the request if it results in a 400 or higher response code - - - -Returns -response of the rest call - - - - - - - -put(*url*, *json=None*, *files=None*, *headers=None*, *return\_raw\_response=False*, *retries=0*)[#](#arthurai.client.http.arthur.ArthurHTTPClient.put "Permalink to this definition") -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 - - - - - -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") -Sends the specified data with headers to the given url with the given request type - - - -Parameters -* **retries** – Number of times to retry the request if it results in a 400 or higher response code -* **return\_raw\_response** – If true do not filter request response, return raw object -* **url** – url to send data to -* **method** – REST call type, POST, GET, PUT, DELETE -* **json** – the data to send -* **headers** – headers to use in the REST call - - - -Returns -response of the REST call - - - - - - - - - - - -[Next - -arthurai.client.http.base](arthurai.client.http.base.html) -[Previous - -arthurai.client.http.arthur](arthurai.client.http.arthur.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.client.http.base.AbstractHTTPClient.md.txt b/files/arthur-docs-markdown/sdk/arthurai.client.http.base.AbstractHTTPClient.md.txt deleted file mode 100644 index a3dddce95ee701ef9e75ffc4ad0124c6496c5fe5..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.client.http.base.AbstractHTTPClient.md.txt +++ /dev/null @@ -1,424 +0,0 @@ - - - - - - -arthurai.client.http.base.AbstractHTTPClient - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](#) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.client.http.base.AbstractHTTPClient[#](#arthurai-client-http-base-abstracthttpclient "Permalink to this headline") -=========================================================================================================================== - - - - -*class* arthurai.client.http.base.AbstractHTTPClient[#](#arthurai.client.http.base.AbstractHTTPClient "Permalink to this definition") -Bases: `object` - - -Methods - - - - - - - - -| `delete` | | -| `get` | | -| `patch` | | -| `post` | | -| `put` | | -| `send` | | - - - - - - - - - -[Next - -arthurai.client.http.requests](arthurai.client.http.requests.html) -[Previous - -arthurai.client.http.base](arthurai.client.http.base.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.client.http.md.txt b/files/arthur-docs-markdown/sdk/arthurai.client.http.md.txt deleted file mode 100644 index 278728169b2eb9c9751b2cd6156378efdc7420ba..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.client.http.md.txt +++ /dev/null @@ -1,411 +0,0 @@ - - - - - - -arthurai.client.http - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](#)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.client.http[#](#module-arthurai.client.http "Permalink to this headline") -================================================================================== - - - - - - - - -| [`arthurai.client.http.arthur`](arthurai.client.http.arthur.html#module-arthurai.client.http.arthur "arthurai.client.http.arthur") | | -| [`arthurai.client.http.base`](arthurai.client.http.base.html#module-arthurai.client.http.base "arthurai.client.http.base") | | -| [`arthurai.client.http.requests`](arthurai.client.http.requests.html#module-arthurai.client.http.requests "arthurai.client.http.requests") | | - - - - - - - - -[Next - -arthurai.client.http.arthur](arthurai.client.http.arthur.html) -[Previous - -arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.client.http.requests.md.txt b/files/arthur-docs-markdown/sdk/arthurai.client.http.requests.md.txt deleted file mode 100644 index 236cb6b06583dd7996c41392192c1a6a523a0201..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.client.http.requests.md.txt +++ /dev/null @@ -1,412 +0,0 @@ - - - - - - -arthurai.client.http.requests - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](#)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.client.http.requests[#](#module-arthurai.client.http.requests "Permalink to this headline") -==================================================================================================== - - -Classes - - - - - - - - -| [`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. | - - - - - - - - -[Next - -arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) -[Previous - -arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.client.md.txt b/files/arthur-docs-markdown/sdk/arthurai.client.md.txt deleted file mode 100644 index e03faa37884aa1f4d3c6e3ffc325ce33490ab5f2..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.client.md.txt +++ /dev/null @@ -1,416 +0,0 @@ - - - - - - -arthurai.client - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](#)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.client[#](#module-arthurai.client "Permalink to this headline") -======================================================================== - - -Arthur HTTP client and general (non-model) functions - - - - - - - - -| [`arthurai.client.apiv3`](arthurai.client.apiv3.html#module-arthurai.client.apiv3 "arthurai.client.apiv3") | SDK Version 2 backward compatibility | -| [`arthurai.client.client`](arthurai.client.client.html#module-arthurai.client.client "arthurai.client.client") | | -| [`arthurai.client.helper`](arthurai.client.helper.html#module-arthurai.client.helper "arthurai.client.helper") | | -| [`arthurai.client.http`](arthurai.client.http.html#module-arthurai.client.http "arthurai.client.http") | | -| [`arthurai.client.validation`](arthurai.client.validation.html#module-arthurai.client.validation "arthurai.client.validation") | | - - - - - - - - -[Next - -arthurai.client.apiv3](arthurai.client.apiv3.html) -[Previous - -arthurai](arthurai.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.client.validation.md.txt b/files/arthur-docs-markdown/sdk/arthurai.client.validation.md.txt deleted file mode 100644 index 3168a4a67d02a1f7f091030602f9212949873353..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.client.validation.md.txt +++ /dev/null @@ -1,413 +0,0 @@ - - - - - - -arthurai.client.validation - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](#)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.client.validation[#](#module-arthurai.client.validation "Permalink to this headline") -============================================================================================== - - -Functions - - - - - - - - -| [`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. | -| [`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. | - - - - - - - - -[Next - -arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) -[Previous - -arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.client.validation.validate_multistatus_response_and_get_failures.md.txt b/files/arthur-docs-markdown/sdk/arthurai.client.validation.validate_multistatus_response_and_get_failures.md.txt deleted file mode 100644 index 29951e80fd4cc57ec0d51b3846d16593a912800b..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.client.validation.validate_multistatus_response_and_get_failures.md.txt +++ /dev/null @@ -1,453 +0,0 @@ - - - - - - -arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](#) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures[#](#arthurai-client-validation-validate-multistatus-response-and-get-failures "Permalink to this headline") -========================================================================================================================================================================================== - - - - -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") -Validate a 207 MultiStatus response and return the failures it contains. - - - -Parameters -* **response** (`Response`) – - -requests.Response object to validate, with the following body format: - - - -``` -{ - "counts": { - "success": 0, - "failure": 0, - "total": 0 - }, - "results": [ - { - "message": "success", - "status": 200 - } - ] -} - -``` -* **raise\_on\_failures** (`bool`) – if True, raise an exception if the response contains any failures - - - -Return type -`Tuple`[`List`[`dict`], `List`[`dict`]] - - - -Returns -a tuple of two lists: user-caused failures and internal failures - - - -Raises -* **ArthurInternalValueError** – If the response does not have 207 status code, or is incorrectly formatted, -or ‘counts’ and ‘results’ do not agree -* **ResponseClientError** – if raise\_on\_failures and the response contains only client errors -* **ResponseServerError** – if raise\_on\_failures and the response contains server errors - - - - - - - - - - -[Next - -arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) -[Previous - -arthurai.client.validation](arthurai.client.validation.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.client.validation.validate_response_status.md.txt b/files/arthur-docs-markdown/sdk/arthurai.client.validation.validate_response_status.md.txt deleted file mode 100644 index 068330ff9a609fbf7adc3fc9852d35d6a8c34669..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.client.validation.validate_response_status.md.txt +++ /dev/null @@ -1,419 +0,0 @@ - - - - - - -arthurai.client.validation.validate\_response\_status - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](#) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.client.validation.validate\_response\_status[#](#arthurai-client-validation-validate-response-status "Permalink to this headline") -=========================================================================================================================================== - - - - -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") -Validate the status code of a requests.Response object or (int) status code. -:type response\_or\_code: `Union`[`Response`, `int`] -:param response\_or\_code: the requests.Response object or status code to validate -:type expected\_status\_code: `Optional`[`int`] -:param expected\_status\_code: the expected status code to check for. If None, all codes <300 will be valid, and 3XX -codes will be subject to allow\_redirects -:type allow\_redirects: `Optional`[`bool`] -:param allow\_redirects: if True will not raise an exception for 3XX status codes -:rtype: `None` -:return: None -:raises InternalValueError: if expected\_status\_code is not None and does not match the response code -:raises ResponseServerError: if the response has a 5XX status code -:raises ResponseClientError: if the response has a 4XX status code -:raises ResponseRedirectError: if the response has a 3XX status code - - - - - - - - -[Next - -arthurai.common](arthurai.common.html) -[Previous - -arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.common.constants.AccuracyMetric.md.txt b/files/arthur-docs-markdown/sdk/arthurai.common.constants.AccuracyMetric.md.txt deleted file mode 100644 index ad9078640b2e02601dfcd7c578d3fd4aa968eb0d..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.common.constants.AccuracyMetric.md.txt +++ /dev/null @@ -1,442 +0,0 @@ - - - - - - -arthurai.common.constants.AccuracyMetric - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](#) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.common.constants.AccuracyMetric[#](#arthurai-common-constants-accuracymetric "Permalink to this headline") -=================================================================================================================== - - - - -*class* arthurai.common.constants.AccuracyMetric[#](#arthurai.common.constants.AccuracyMetric "Permalink to this definition") -Bases: [`arthurai.common.constants.ListableStrEnum`](arthurai.common.constants.ListableStrEnum.html#arthurai.common.constants.ListableStrEnum "arthurai.common.constants.ListableStrEnum") - - -Methods - - - - - - - - -| [`list`](#arthurai.common.constants.AccuracyMetric.list "arthurai.common.constants.AccuracyMetric.list") | Lists all attributes in alphabetical order | - - - -Attributes - - - - - - - - -| `Accuracy` | | -| `F1` | | -| `Precision` | | -| `Recall` | | - - - - - -*classmethod* list()[#](#arthurai.common.constants.AccuracyMetric.list "Permalink to this definition") -Lists all attributes in alphabetical order - - - - - - - - - -[Next - -arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) -[Previous - -arthurai.common.constants](arthurai.common.constants.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.common.constants.Enrichment.md.txt b/files/arthur-docs-markdown/sdk/arthurai.common.constants.Enrichment.md.txt deleted file mode 100644 index 520f2b87800f0d1662823a08620398b0b976535d..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.common.constants.Enrichment.md.txt +++ /dev/null @@ -1,445 +0,0 @@ - - - - - - -arthurai.common.constants.Enrichment - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](#) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.common.constants.Enrichment[#](#arthurai-common-constants-enrichment "Permalink to this headline") -=========================================================================================================== - - - - -*class* arthurai.common.constants.Enrichment[#](#arthurai.common.constants.Enrichment "Permalink to this definition") -Bases: [`arthurai.common.constants.ListableStrEnum`](arthurai.common.constants.ListableStrEnum.html#arthurai.common.constants.ListableStrEnum "arthurai.common.constants.ListableStrEnum") - - -This class contains constants for the names of enrichments - - -Methods - - - - - - - - -| [`list`](#arthurai.common.constants.Enrichment.list "arthurai.common.constants.Enrichment.list") | Lists all attributes in alphabetical order | - - - -Attributes - - - - - - - - -| `AnomalyDetection` | | -| `BiasMitigation` | | -| `Explainability` | | -| `Hotspots` | | - - - - - -*classmethod* list()[#](#arthurai.common.constants.Enrichment.list "Permalink to this definition") -Lists all attributes in alphabetical order - - - - - - - - - -[Next - -arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) -[Previous - -arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.common.constants.ImageContentType.md.txt b/files/arthur-docs-markdown/sdk/arthurai.common.constants.ImageContentType.md.txt deleted file mode 100644 index c01d9fa12481cd24acbb0be8ebcb95950acbebd4..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.common.constants.ImageContentType.md.txt +++ /dev/null @@ -1,445 +0,0 @@ - - - - - - -arthurai.common.constants.ImageContentType - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](#) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.common.constants.ImageContentType[#](#arthurai-common-constants-imagecontenttype "Permalink to this headline") -======================================================================================================================= - - - - -*class* arthurai.common.constants.ImageContentType[#](#arthurai.common.constants.ImageContentType "Permalink to this definition") -Bases: [`arthurai.common.constants.ListableStrEnum`](arthurai.common.constants.ListableStrEnum.html#arthurai.common.constants.ListableStrEnum "arthurai.common.constants.ListableStrEnum") - - -Valid image content types supported by Arthur API - - -Methods - - - - - - - - -| [`list`](#arthurai.common.constants.ImageContentType.list "arthurai.common.constants.ImageContentType.list") | Lists all attributes in alphabetical order | - - - -Attributes - - - - - - - - -| `Gif` | | -| `Jpeg` | | -| `Png` | | -| `Tiff` | | - - - - - -*classmethod* list()[#](#arthurai.common.constants.ImageContentType.list "Permalink to this definition") -Lists all attributes in alphabetical order - - - - - - - - - -[Next - -arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) -[Previous - -arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.common.constants.ImageResponseType.md.txt b/files/arthur-docs-markdown/sdk/arthurai.common.constants.ImageResponseType.md.txt deleted file mode 100644 index 88b4a0de0a3935fddf4a99f14d6a4239d0764bb9..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.common.constants.ImageResponseType.md.txt +++ /dev/null @@ -1,445 +0,0 @@ - - - - - - -arthurai.common.constants.ImageResponseType - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](#) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.common.constants.ImageResponseType[#](#arthurai-common-constants-imageresponsetype "Permalink to this headline") -========================================================================================================================= - - - - -*class* arthurai.common.constants.ImageResponseType[#](#arthurai.common.constants.ImageResponseType "Permalink to this definition") -Bases: [`arthurai.common.constants.ListableStrEnum`](arthurai.common.constants.ListableStrEnum.html#arthurai.common.constants.ListableStrEnum "arthurai.common.constants.ListableStrEnum") - - -Valid image response types supported by Arthur API - - -Methods - - - - - - - - -| [`list`](#arthurai.common.constants.ImageResponseType.list "arthurai.common.constants.ImageResponseType.list") | Lists all attributes in alphabetical order | - - - -Attributes - - - - - - - - -| `LimeExplanation` | | -| `RawImage` | | -| `ResizedImage` | | -| `Thumbnail` | | - - - - - -*classmethod* list()[#](#arthurai.common.constants.ImageResponseType.list "Permalink to this definition") -Lists all attributes in alphabetical order - - - - - - - - - -[Next - -arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) -[Previous - -arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.common.constants.InputType.md.txt b/files/arthur-docs-markdown/sdk/arthurai.common.constants.InputType.md.txt deleted file mode 100644 index c6382dff2dea07862ab2039b57df8bc7263cd42c..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.common.constants.InputType.md.txt +++ /dev/null @@ -1,441 +0,0 @@ - - - - - - -arthurai.common.constants.InputType - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](#) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.common.constants.InputType[#](#arthurai-common-constants-inputtype "Permalink to this headline") -========================================================================================================= - - - - -*class* arthurai.common.constants.InputType[#](#arthurai.common.constants.InputType "Permalink to this definition") -Bases: [`arthurai.common.constants.ListableStrEnum`](arthurai.common.constants.ListableStrEnum.html#arthurai.common.constants.ListableStrEnum "arthurai.common.constants.ListableStrEnum") - - -Methods - - - - - - - - -| [`list`](#arthurai.common.constants.InputType.list "arthurai.common.constants.InputType.list") | Lists all attributes in alphabetical order | - - - -Attributes - - - - - - - - -| `Image` | | -| `NLP` | | -| `Tabular` | | - - - - - -*classmethod* list()[#](#arthurai.common.constants.InputType.list "Permalink to this definition") -Lists all attributes in alphabetical order - - - - - - - - - -[Next - -arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) -[Previous - -arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.common.constants.OutputType.md.txt b/files/arthur-docs-markdown/sdk/arthurai.common.constants.OutputType.md.txt deleted file mode 100644 index 27999493a9c4fbda636e419758939b680dd368c2..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.common.constants.OutputType.md.txt +++ /dev/null @@ -1,442 +0,0 @@ - - - - - - -arthurai.common.constants.OutputType - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](#) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.common.constants.OutputType[#](#arthurai-common-constants-outputtype "Permalink to this headline") -=========================================================================================================== - - - - -*class* arthurai.common.constants.OutputType[#](#arthurai.common.constants.OutputType "Permalink to this definition") -Bases: [`arthurai.common.constants.ListableStrEnum`](arthurai.common.constants.ListableStrEnum.html#arthurai.common.constants.ListableStrEnum "arthurai.common.constants.ListableStrEnum") - - -Methods - - - - - - - - -| [`list`](#arthurai.common.constants.OutputType.list "arthurai.common.constants.OutputType.list") | Lists all attributes in alphabetical order | - - - -Attributes - - - - - - - - -| `Multiclass` | | -| `Multilabel` | | -| `ObjectDetection` | | -| `Regression` | | - - - - - -*classmethod* list()[#](#arthurai.common.constants.OutputType.list "Permalink to this definition") -Lists all attributes in alphabetical order - - - - - - - - - -[Next - -arthurai.common.constants.Role](arthurai.common.constants.Role.html) -[Previous - -arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.common.constants.Role.md.txt b/files/arthur-docs-markdown/sdk/arthurai.common.constants.Role.md.txt deleted file mode 100644 index 275512fa3250b2091d42c2cf05e6f9e7be0dfed2..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.common.constants.Role.md.txt +++ /dev/null @@ -1,441 +0,0 @@ - - - - - - -arthurai.common.constants.Role - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](#) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.common.constants.Role[#](#arthurai-common-constants-role "Permalink to this headline") -=============================================================================================== - - - - -*class* arthurai.common.constants.Role[#](#arthurai.common.constants.Role "Permalink to this definition") -Bases: [`arthurai.common.constants.ListableStrEnum`](arthurai.common.constants.ListableStrEnum.html#arthurai.common.constants.ListableStrEnum "arthurai.common.constants.ListableStrEnum") - - -Methods - - - - - - - - -| [`list`](#arthurai.common.constants.Role.list "arthurai.common.constants.Role.list") | Lists all attributes in alphabetical order | - - - -Attributes - - - - - - - - -| `Administrator` | | -| `ModelOwner` | | -| `User` | | - - - - - -*classmethod* list()[#](#arthurai.common.constants.Role.list "Permalink to this definition") -Lists all attributes in alphabetical order - - - - - - - - - -[Next - -arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) -[Previous - -arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.common.constants.Stage.md.txt b/files/arthur-docs-markdown/sdk/arthurai.common.constants.Stage.md.txt deleted file mode 100644 index 2dd88cba74e455908e8eeda19323311b6ed230df..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.common.constants.Stage.md.txt +++ /dev/null @@ -1,444 +0,0 @@ - - - - - - -arthurai.common.constants.Stage - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](#) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.common.constants.Stage[#](#arthurai-common-constants-stage "Permalink to this headline") -================================================================================================= - - - - -*class* arthurai.common.constants.Stage[#](#arthurai.common.constants.Stage "Permalink to this definition") -Bases: [`arthurai.common.constants.ListableStrEnum`](arthurai.common.constants.ListableStrEnum.html#arthurai.common.constants.ListableStrEnum "arthurai.common.constants.ListableStrEnum") - - -Methods - - - - - - - - -| [`list`](#arthurai.common.constants.Stage.list "arthurai.common.constants.Stage.list") | Lists all attributes in alphabetical order | - - - -Attributes - - - - - - - - -| `GroundTruth` | | -| `GroundTruthClass` | | -| `ModelPipelineInput` | | -| `NonInputData` | | -| `PredictFunctionInput` | | -| `PredictedValue` | | - - - - - -*classmethod* list()[#](#arthurai.common.constants.Stage.list "Permalink to this definition") -Lists all attributes in alphabetical order - - - - - - - - - -[Next - -arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) -[Previous - -arthurai.common.constants.Role](arthurai.common.constants.Role.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.common.constants.TextDelimiter.md.txt b/files/arthur-docs-markdown/sdk/arthurai.common.constants.TextDelimiter.md.txt deleted file mode 100644 index e29d256a0003a0d725ab363fa80f7d2c28053aab..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.common.constants.TextDelimiter.md.txt +++ /dev/null @@ -1,507 +0,0 @@ - - - - - - -arthurai.common.constants.TextDelimiter - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](#) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.common.constants.TextDelimiter[#](#arthurai-common-constants-textdelimiter "Permalink to this headline") -================================================================================================================= - - - - -*class* arthurai.common.constants.TextDelimiter[#](#arthurai.common.constants.TextDelimiter "Permalink to this definition") -Bases: [`arthurai.common.constants.ListableStrEnum`](arthurai.common.constants.ListableStrEnum.html#arthurai.common.constants.ListableStrEnum "arthurai.common.constants.ListableStrEnum") - - -This class contains patterns that can be used as text\_delimiter for NLP models. - - -Methods - - - - - - - - -| [`list`](#arthurai.common.constants.TextDelimiter.list "arthurai.common.constants.TextDelimiter.list") | Lists all attributes in alphabetical order | - - - -Attributes - - - - - - - - -| [`COMMA`](#arthurai.common.constants.TextDelimiter.COMMA "arthurai.common.constants.TextDelimiter.COMMA") | `","` Splits on a single comma. | -| [`COMMA\_PLUS`](#arthurai.common.constants.TextDelimiter.COMMA_PLUS "arthurai.common.constants.TextDelimiter.COMMA_PLUS") | `",+"` Splits on one or more commas. | -| [`NOT\_WORD`](#arthurai.common.constants.TextDelimiter.NOT_WORD "arthurai.common.constants.TextDelimiter.NOT_WORD") | `"\W+"` Splits on any character that is not a word. | -| [`PIPE`](#arthurai.common.constants.TextDelimiter.PIPE "arthurai.common.constants.TextDelimiter.PIPE") | `"\|"` Splits on a single pipe. | -| [`PIPE\_PLUS`](#arthurai.common.constants.TextDelimiter.PIPE_PLUS "arthurai.common.constants.TextDelimiter.PIPE_PLUS") | `"\|+"` Splits on one or more pipes. | -| [`WHITESPACE`](#arthurai.common.constants.TextDelimiter.WHITESPACE "arthurai.common.constants.TextDelimiter.WHITESPACE") | `"\s+"` Splits on whitespace. | - - - - - -COMMA *= ','*[#](#arthurai.common.constants.TextDelimiter.COMMA "Permalink to this definition") -`","` Splits on a single comma. - - -Ex: `"this ,is,,a,test" = ["this ", "is", "", "a", "test"]` - - - - - -COMMA\_PLUS *= ',+'*[#](#arthurai.common.constants.TextDelimiter.COMMA_PLUS "Permalink to this definition") -`",+"` Splits on one or more commas. - - -Ex: `"this ,is,,a,test" = ["this ", "is", "a", "test"]` - - - - - -NOT\_WORD *= '\\W+'*[#](#arthurai.common.constants.TextDelimiter.NOT_WORD "Permalink to this definition") -`"\W+"` Splits on any character that is not a word. - - -Ex: `"this  is,aaaa,,,,,test!" = ["this", "is", "aaaa", "test", ""]` - - - - - -PIPE *= '\\|'*[#](#arthurai.common.constants.TextDelimiter.PIPE "Permalink to this definition") -`"\|"` Splits on a single pipe. - - -Ex: `"this |is||a|test" = ["this ", "is", "", "a", "test"]` - - - - - -PIPE\_PLUS *= '\\|+'*[#](#arthurai.common.constants.TextDelimiter.PIPE_PLUS "Permalink to this definition") -`"\|+"` Splits on one or more pipes. - - -Ex: `"this |is||a|test" = ["this ", "is", "a", "test"]` - - - - - -WHITESPACE *= '\\s+'*[#](#arthurai.common.constants.TextDelimiter.WHITESPACE "Permalink to this definition") -`"\s+"` Splits on whitespace. - - -Ex: `"this  is,a test! " = ["this", "is,a", "test!", ""]` - - - - - -*classmethod* list()[#](#arthurai.common.constants.TextDelimiter.list "Permalink to this definition") -Lists all attributes in alphabetical order - - - - - - - - - -[Next - -arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) -[Previous - -arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.common.constants.ValueType.md.txt b/files/arthur-docs-markdown/sdk/arthurai.common.constants.ValueType.md.txt deleted file mode 100644 index fc5c46c717d1c0a63f8f4d3583af79662bff6598..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.common.constants.ValueType.md.txt +++ /dev/null @@ -1,446 +0,0 @@ - - - - - - -arthurai.common.constants.ValueType - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](#) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.common.constants.ValueType[#](#arthurai-common-constants-valuetype "Permalink to this headline") -========================================================================================================= - - - - -*class* arthurai.common.constants.ValueType[#](#arthurai.common.constants.ValueType "Permalink to this definition") -Bases: [`arthurai.common.constants.ListableStrEnum`](arthurai.common.constants.ListableStrEnum.html#arthurai.common.constants.ListableStrEnum "arthurai.common.constants.ListableStrEnum") - - -Methods - - - - - - - - -| [`list`](#arthurai.common.constants.ValueType.list "arthurai.common.constants.ValueType.list") | Lists all attributes in alphabetical order | - - - -Attributes - - - - - - - - -| `Boolean` | | -| `BoundingBox` | | -| `Float` | | -| `Image` | | -| `Integer` | | -| `String` | | -| `Timestamp` | | -| `Unstructured\_Text` | | - - - - - -*classmethod* list()[#](#arthurai.common.constants.ValueType.list "Permalink to this definition") -Lists all attributes in alphabetical order - - - - - - - - - -[Next - -arthurai.common.exceptions](arthurai.common.exceptions.html) -[Previous - -arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.common.constants.md.txt b/files/arthur-docs-markdown/sdk/arthurai.common.constants.md.txt deleted file mode 100644 index 8549af4bff98b414de8aaef5c59db9ba76aa2096..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.common.constants.md.txt +++ /dev/null @@ -1,422 +0,0 @@ - - - - - - -arthurai.common.constants - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](#)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.common.constants[#](#module-arthurai.common.constants "Permalink to this headline") -============================================================================================ - - -Classes - - - - - - - - -| [`AccuracyMetric`](arthurai.common.constants.AccuracyMetric.html#arthurai.common.constants.AccuracyMetric "arthurai.common.constants.AccuracyMetric")() | | -| [`Enrichment`](arthurai.common.constants.Enrichment.html#arthurai.common.constants.Enrichment "arthurai.common.constants.Enrichment")() | This class contains constants for the names of enrichments | -| [`ImageContentType`](arthurai.common.constants.ImageContentType.html#arthurai.common.constants.ImageContentType "arthurai.common.constants.ImageContentType")() | Valid image content types supported by Arthur API | -| [`ImageResponseType`](arthurai.common.constants.ImageResponseType.html#arthurai.common.constants.ImageResponseType "arthurai.common.constants.ImageResponseType")() | Valid image response types supported by Arthur API | -| [`InputType`](arthurai.common.constants.InputType.html#arthurai.common.constants.InputType "arthurai.common.constants.InputType")() | | -| [`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. | -| [`OutputType`](arthurai.common.constants.OutputType.html#arthurai.common.constants.OutputType "arthurai.common.constants.OutputType")() | | -| [`Role`](arthurai.common.constants.Role.html#arthurai.common.constants.Role "arthurai.common.constants.Role")() | | -| [`Stage`](arthurai.common.constants.Stage.html#arthurai.common.constants.Stage "arthurai.common.constants.Stage")() | | -| [`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. | -| [`ValueType`](arthurai.common.constants.ValueType.html#arthurai.common.constants.ValueType "arthurai.common.constants.ValueType")() | | - - - - - - - - -[Next - -arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) -[Previous - -arthurai.common](arthurai.common.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.common.exceptions.arthur_excepted.md.txt b/files/arthur-docs-markdown/sdk/arthurai.common.exceptions.arthur_excepted.md.txt deleted file mode 100644 index dc7bd66113d466a5d1d16b2861e2f1184de6fe25..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.common.exceptions.arthur_excepted.md.txt +++ /dev/null @@ -1,410 +0,0 @@ - - - - - - -arthurai.common.exceptions.arthur\_excepted - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](#) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.common.exceptions.arthur\_excepted[#](#arthurai-common-exceptions-arthur-excepted "Permalink to this headline") -======================================================================================================================== - - - - -arthurai.common.exceptions.arthur\_excepted(*message=None*)[#](#arthurai.common.exceptions.arthur_excepted "Permalink to this definition") -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. -:param message: an optional message to prefix the error with, should describe the failure e.g. “failed to send -inferences” or “an error occurred while creating the model.” -:return: the decorator function - - - - - - - - -[Next - -arthurai.common.log](arthurai.common.log.html) -[Previous - -arthurai.common.exceptions](arthurai.common.exceptions.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.common.exceptions.md.txt b/files/arthur-docs-markdown/sdk/arthurai.common.exceptions.md.txt deleted file mode 100644 index 7d503b7818fa563aac3fb93855a943c589289aa2..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.common.exceptions.md.txt +++ /dev/null @@ -1,438 +0,0 @@ - - - - - - -arthurai.common.exceptions - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](#)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.common.exceptions[#](#module-arthurai.common.exceptions "Permalink to this headline") -============================================================================================== - - -Functions - - - - - - - - -| [`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. | - - - -Exceptions - - - - - - - - -| `ArthurError` | Base Error for Arthur SDK. | -| `ArthurInternalError` | Exception raised when user input is correct but an error occurs. | -| `ArthurUserError` | Exception raised due to incorrect user input to the Arthur SDK. | -| `ExpectedParameterNotFoundError` | Exception raised when a field or property should be available from Arthur but is unexpectedly missing. | -| `ForbiddenError` | Exception raised when a 403 Forbidden response is received from the API. | -| `InternalTypeError` | Exception raised when a value is unexpected. | -| `InternalValueError` | Exception raised when a value is unexpected. | -| `MethodNotApplicableError` | Exception raised when the method called is not valid for the resource. | -| `MissingParameterError` | Exception raised when parameters supplied to the Arthur SDK are missing. | -| `ResponseClientError` | Exception raised when a 4XX response is received from the API. | -| `ResponseRedirectError` | Exception raised when a 3XX response is unexpectedly received from the API. | -| `ResponseServerError` | Exception raised when a 5XX response is received from the API. | -| `UserTypeError` | Exception raised when a user supplies an argument of the incorrect type to the Arthur SDK. | -| `UserValueError` | Exception raised when a user supplies an invalid value to the Arthur SDK. | - - - - - - - - -[Next - -arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) -[Previous - -arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.common.log.InfoFilter.md.txt b/files/arthur-docs-markdown/sdk/arthurai.common.log.InfoFilter.md.txt deleted file mode 100644 index 35938f4d5359af42a421ded0ad22fe16529b65cb..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.common.log.InfoFilter.md.txt +++ /dev/null @@ -1,433 +0,0 @@ - - - - - - -arthurai.common.log.InfoFilter - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](#) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.common.log.InfoFilter[#](#arthurai-common-log-infofilter "Permalink to this headline") -=============================================================================================== - - - - -*class* arthurai.common.log.InfoFilter(*name=''*)[#](#arthurai.common.log.InfoFilter "Permalink to this definition") -Bases: `logging.Filter` - - -A logging filter to only log messages that are debug or info level (i.e. never log warning or error messages) - - -Methods - - - - - - - - -| [`filter`](#arthurai.common.log.InfoFilter.filter "arthurai.common.log.InfoFilter.filter") | Determine if the specified record is to be logged. | - - - - - -filter(*rec*)[#](#arthurai.common.log.InfoFilter.filter "Permalink to this definition") -Determine if the specified record is to be logged. - - -Returns True if the record should be logged, or False otherwise. -If deemed appropriate, the record may be modified in-place. - - - - - - - - - -[Next - -arthurai.core](arthurai.core.html) -[Previous - -arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.common.log.disable_debug_logging.md.txt b/files/arthur-docs-markdown/sdk/arthurai.common.log.disable_debug_logging.md.txt deleted file mode 100644 index 8b331f46ff80868a44cacdaab2a97662e18864a5..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.common.log.disable_debug_logging.md.txt +++ /dev/null @@ -1,407 +0,0 @@ - - - - - - -arthurai.common.log.disable\_debug\_logging - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](#) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.common.log.disable\_debug\_logging[#](#arthurai-common-log-disable-debug-logging "Permalink to this headline") -======================================================================================================================= - - - - -arthurai.common.log.disable\_debug\_logging()[#](#arthurai.common.log.disable_debug_logging "Permalink to this definition") -Disables debug logging for the arthurai package. Note that log messages may be dropped while this function is -being executed. - - - - - - - - -[Next - -arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) -[Previous - -arthurai.common.log](arthurai.common.log.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.common.log.enable_debug_logging.md.txt b/files/arthur-docs-markdown/sdk/arthurai.common.log.enable_debug_logging.md.txt deleted file mode 100644 index 6768723a851fb6ced3377d64ab0fdf9fa26b52f8..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.common.log.enable_debug_logging.md.txt +++ /dev/null @@ -1,407 +0,0 @@ - - - - - - -arthurai.common.log.enable\_debug\_logging - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](#) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.common.log.enable\_debug\_logging[#](#arthurai-common-log-enable-debug-logging "Permalink to this headline") -===================================================================================================================== - - - - -arthurai.common.log.enable\_debug\_logging()[#](#arthurai.common.log.enable_debug_logging "Permalink to this definition") -Enables debug logging for the arthurai package. Note that log messages may be dropped while this function is -being executed. - - - - - - - - -[Next - -arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) -[Previous - -arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.common.log.initialize_logging.md.txt b/files/arthur-docs-markdown/sdk/arthurai.common.log.initialize_logging.md.txt deleted file mode 100644 index 564f32b9098bc9b44c2d130e07a0f60318826890..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.common.log.initialize_logging.md.txt +++ /dev/null @@ -1,406 +0,0 @@ - - - - - - -arthurai.common.log.initialize\_logging - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](#) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.common.log.initialize\_logging[#](#arthurai-common-log-initialize-logging "Permalink to this headline") -================================================================================================================ - - - - -arthurai.common.log.initialize\_logging()[#](#arthurai.common.log.initialize_logging "Permalink to this definition") -Creates a parent ‘arthurai’ logger with a console output and INFO level. - - - - - - - - -[Next - -arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) -[Previous - -arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.common.log.md.txt b/files/arthur-docs-markdown/sdk/arthurai.common.log.md.txt deleted file mode 100644 index bfd4fd993b04fc982d8a32640516a9eaf45d02ef..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.common.log.md.txt +++ /dev/null @@ -1,441 +0,0 @@ - - - - - - -arthurai.common.log - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](#)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.common.log[#](#module-arthurai.common.log "Permalink to this headline") -================================================================================ - - -Functions - - - - - - - - -| [`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. | -| [`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. | -| [`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. | - - - -Classes - - - - - - - - -| [`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. | - - - - - - - - -[Next - -arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) -[Previous - -arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - On this page - - - - -* [arthurai.common.log](#) - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.common.md.txt b/files/arthur-docs-markdown/sdk/arthurai.common.md.txt deleted file mode 100644 index f5f17d0dc6f66eaf1f37b3b9a3d7166ec610eecf..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.common.md.txt +++ /dev/null @@ -1,414 +0,0 @@ - - - - - - -arthurai.common - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](#)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.common[#](#module-arthurai.common "Permalink to this headline") -======================================================================== - - -Constants, exceptions, and logging for use in other packages - - - - - - - - -| [`arthurai.common.constants`](arthurai.common.constants.html#module-arthurai.common.constants "arthurai.common.constants") | | -| [`arthurai.common.exceptions`](arthurai.common.exceptions.html#module-arthurai.common.exceptions "arthurai.common.exceptions") | | -| [`arthurai.common.log`](arthurai.common.log.html#module-arthurai.common.log "arthurai.common.log") | | - - - - - - - - -[Next - -arthurai.common.constants](arthurai.common.constants.html) -[Previous - -arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.alerts.Alert.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.alerts.Alert.md.txt deleted file mode 100644 index 943b390d789d894a99dd2b0ce89b093b138bd7db..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.alerts.Alert.md.txt +++ /dev/null @@ -1,522 +0,0 @@ - - - - - - -arthurai.core.alerts.Alert - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](#) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.alerts.Alert[#](#arthurai-core-alerts-alert "Permalink to this headline") -======================================================================================= - - - - -*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") -Bases: [`arthurai.core.base.ArthurBaseJsonDataclass`](arthurai.core.base.ArthurBaseJsonDataclass.html#arthurai.core.base.ArthurBaseJsonDataclass "arthurai.core.base.ArthurBaseJsonDataclass") - - -Methods - - - - - - - - -| [`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 | -| `from\_dict` | -rtype -`TypeVar`(`A`, bound= `DataClassJsonMixin`) - - | -| `from\_json` | -rtype -`TypeVar`(`A`, bound= `DataClassJsonMixin`) - - | -| `schema` | -rtype -`SchemaF`[`TypeVar`(`A`)] - - | -| [`to\_dict`](#arthurai.core.alerts.Alert.to_dict "arthurai.core.alerts.Alert.to_dict") | Creates a dictionary representation of this object | -| [`to\_json`](#arthurai.core.alerts.Alert.to_json "arthurai.core.alerts.Alert.to_json") | Creates a json representation of this object | - - - -Attributes - - - - - - - - -| `batch\_id` | | -| `dataclass\_json\_config` | | -| `window\_end` | | -| `window\_start` | | -| `id` | | -| `timestamp` | | -| `metric\_value` | | -| `message` | | -| `model\_id` | | -| `status` | | -| `alert\_rule` | | - - - - - -*static* clean\_nones(*d*)[#](#arthurai.core.alerts.Alert.clean_nones "Permalink to this definition") -Helper function to filter out None objects from a json or dictionary representation of an object - - - -Parameters -**d** – a Dictionary or Json representation of an ArthurBaseJsonDataclass object - - - -Returns -Dictionary of the object with all None components removed - - - - - - - -to\_dict(*skip\_none=True*)[#](#arthurai.core.alerts.Alert.to_dict "Permalink to this definition") -Creates a dictionary representation of this object - - -This function can be applied to any extension of the ArthurBaseJsonDataClass - - - -Return type -`dict` - - - -Returns -Dictionary of object data - - - - - - - -to\_json(*skip\_none=True*)[#](#arthurai.core.alerts.Alert.to_json "Permalink to this definition") -Creates a json representation of this object - - -This function can be applied to any extension of the ArthurBaseJsonDataClass - - - -Return type -`str` - - - -Returns -json of object data - - - - - - - - - - - -[Next - -arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) -[Previous - -arthurai.core.alerts](arthurai.core.alerts.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.alerts.AlertRule.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.alerts.AlertRule.md.txt deleted file mode 100644 index c39ea6ca64400e49d7f87bc422ca34d1c9676040..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.alerts.AlertRule.md.txt +++ /dev/null @@ -1,522 +0,0 @@ - - - - - - -arthurai.core.alerts.AlertRule - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](#) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.alerts.AlertRule[#](#arthurai-core-alerts-alertrule "Permalink to this headline") -=============================================================================================== - - - - -*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") -Bases: [`arthurai.core.base.ArthurBaseJsonDataclass`](arthurai.core.base.ArthurBaseJsonDataclass.html#arthurai.core.base.ArthurBaseJsonDataclass "arthurai.core.base.ArthurBaseJsonDataclass") - - -Methods - - - - - - - - -| [`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 | -| `from\_dict` | -rtype -`TypeVar`(`A`, bound= `DataClassJsonMixin`) - - | -| `from\_json` | -rtype -`TypeVar`(`A`, bound= `DataClassJsonMixin`) - - | -| `schema` | -rtype -`SchemaF`[`TypeVar`(`A`)] - - | -| [`to\_dict`](#arthurai.core.alerts.AlertRule.to_dict "arthurai.core.alerts.AlertRule.to_dict") | Creates a dictionary representation of this object | -| [`to\_json`](#arthurai.core.alerts.AlertRule.to_json "arthurai.core.alerts.AlertRule.to_json") | Creates a json representation of this object | - - - -Attributes - - - - - - - - -| `dataclass\_json\_config` | | -| `enabled` | | -| `id` | | -| `lookback\_period` | | -| `metric\_name` | | -| `name` | | -| `subsequent\_alert\_wait\_time` | | -| `bound` | | -| `threshold` | | -| `metric\_id` | | -| `severity` | | - - - - - -*static* clean\_nones(*d*)[#](#arthurai.core.alerts.AlertRule.clean_nones "Permalink to this definition") -Helper function to filter out None objects from a json or dictionary representation of an object - - - -Parameters -**d** – a Dictionary or Json representation of an ArthurBaseJsonDataclass object - - - -Returns -Dictionary of the object with all None components removed - - - - - - - -to\_dict(*skip\_none=True*)[#](#arthurai.core.alerts.AlertRule.to_dict "Permalink to this definition") -Creates a dictionary representation of this object - - -This function can be applied to any extension of the ArthurBaseJsonDataClass - - - -Return type -`dict` - - - -Returns -Dictionary of object data - - - - - - - -to\_json(*skip\_none=True*)[#](#arthurai.core.alerts.AlertRule.to_json "Permalink to this definition") -Creates a json representation of this object - - -This function can be applied to any extension of the ArthurBaseJsonDataClass - - - -Return type -`str` - - - -Returns -json of object data - - - - - - - - - - - -[Next - -arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) -[Previous - -arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.alerts.AlertRuleBound.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.alerts.AlertRuleBound.md.txt deleted file mode 100644 index d86a8ca4625081ad7ac5dfdaa9262bad94770eac..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.alerts.AlertRuleBound.md.txt +++ /dev/null @@ -1,440 +0,0 @@ - - - - - - -arthurai.core.alerts.AlertRuleBound - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](#) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.alerts.AlertRuleBound[#](#arthurai-core-alerts-alertrulebound "Permalink to this headline") -========================================================================================================= - - - - -*class* arthurai.core.alerts.AlertRuleBound[#](#arthurai.core.alerts.AlertRuleBound "Permalink to this definition") -Bases: [`arthurai.common.constants.ListableStrEnum`](arthurai.common.constants.ListableStrEnum.html#arthurai.common.constants.ListableStrEnum "arthurai.common.constants.ListableStrEnum") - - -Methods - - - - - - - - -| [`list`](#arthurai.core.alerts.AlertRuleBound.list "arthurai.core.alerts.AlertRuleBound.list") | Lists all attributes in alphabetical order | - - - -Attributes - - - - - - - - -| `Lower` | | -| `Upper` | | - - - - - -*classmethod* list()[#](#arthurai.core.alerts.AlertRuleBound.list "Permalink to this definition") -Lists all attributes in alphabetical order - - - - - - - - - -[Next - -arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) -[Previous - -arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.alerts.AlertRuleSeverity.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.alerts.AlertRuleSeverity.md.txt deleted file mode 100644 index 0b0e467ea826cb6032fdd111da6ff3067b7cb3d9..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.alerts.AlertRuleSeverity.md.txt +++ /dev/null @@ -1,440 +0,0 @@ - - - - - - -arthurai.core.alerts.AlertRuleSeverity - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](#) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.alerts.AlertRuleSeverity[#](#arthurai-core-alerts-alertruleseverity "Permalink to this headline") -=============================================================================================================== - - - - -*class* arthurai.core.alerts.AlertRuleSeverity[#](#arthurai.core.alerts.AlertRuleSeverity "Permalink to this definition") -Bases: [`arthurai.common.constants.ListableStrEnum`](arthurai.common.constants.ListableStrEnum.html#arthurai.common.constants.ListableStrEnum "arthurai.common.constants.ListableStrEnum") - - -Methods - - - - - - - - -| [`list`](#arthurai.core.alerts.AlertRuleSeverity.list "arthurai.core.alerts.AlertRuleSeverity.list") | Lists all attributes in alphabetical order | - - - -Attributes - - - - - - - - -| `Critical` | | -| `Warning` | | - - - - - -*classmethod* list()[#](#arthurai.core.alerts.AlertRuleSeverity.list "Permalink to this definition") -Lists all attributes in alphabetical order - - - - - - - - - -[Next - -arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) -[Previous - -arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.alerts.AlertStatus.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.alerts.AlertStatus.md.txt deleted file mode 100644 index 06d4af2ff4c719303c98cbd37b5958b3925c16e2..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.alerts.AlertStatus.md.txt +++ /dev/null @@ -1,440 +0,0 @@ - - - - - - -arthurai.core.alerts.AlertStatus - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](#) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.alerts.AlertStatus[#](#arthurai-core-alerts-alertstatus "Permalink to this headline") -=================================================================================================== - - - - -*class* arthurai.core.alerts.AlertStatus[#](#arthurai.core.alerts.AlertStatus "Permalink to this definition") -Bases: [`arthurai.common.constants.ListableStrEnum`](arthurai.common.constants.ListableStrEnum.html#arthurai.common.constants.ListableStrEnum "arthurai.common.constants.ListableStrEnum") - - -Methods - - - - - - - - -| [`list`](#arthurai.core.alerts.AlertStatus.list "arthurai.core.alerts.AlertStatus.list") | Lists all attributes in alphabetical order | - - - -Attributes - - - - - - - - -| `Acknowledged` | | -| `Resolved` | | - - - - - -*classmethod* list()[#](#arthurai.core.alerts.AlertStatus.list "Permalink to this definition") -Lists all attributes in alphabetical order - - - - - - - - - -[Next - -arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) -[Previous - -arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.alerts.Metric.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.alerts.Metric.md.txt deleted file mode 100644 index ee88558f58dfdfd0d5dce3be479fe14161b34430..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.alerts.Metric.md.txt +++ /dev/null @@ -1,518 +0,0 @@ - - - - - - -arthurai.core.alerts.Metric - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](#) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.alerts.Metric[#](#arthurai-core-alerts-metric "Permalink to this headline") -========================================================================================= - - - - -*class* arthurai.core.alerts.Metric(*id*, *name*, *query*, *is\_default*, *type=None*, *attribute=None*)[#](#arthurai.core.alerts.Metric "Permalink to this definition") -Bases: [`arthurai.core.base.ArthurBaseJsonDataclass`](arthurai.core.base.ArthurBaseJsonDataclass.html#arthurai.core.base.ArthurBaseJsonDataclass "arthurai.core.base.ArthurBaseJsonDataclass") - - -Methods - - - - - - - - -| [`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 | -| `from\_dict` | -rtype -`TypeVar`(`A`, bound= `DataClassJsonMixin`) - - | -| `from\_json` | -rtype -`TypeVar`(`A`, bound= `DataClassJsonMixin`) - - | -| `schema` | -rtype -`SchemaF`[`TypeVar`(`A`)] - - | -| [`to\_dict`](#arthurai.core.alerts.Metric.to_dict "arthurai.core.alerts.Metric.to_dict") | Creates a dictionary representation of this object | -| [`to\_json`](#arthurai.core.alerts.Metric.to_json "arthurai.core.alerts.Metric.to_json") | Creates a json representation of this object | - - - -Attributes - - - - - - - - -| `attribute` | | -| `dataclass\_json\_config` | | -| `type` | | -| `id` | | -| `name` | | -| `query` | | -| `is\_default` | | - - - - - -*static* clean\_nones(*d*)[#](#arthurai.core.alerts.Metric.clean_nones "Permalink to this definition") -Helper function to filter out None objects from a json or dictionary representation of an object - - - -Parameters -**d** – a Dictionary or Json representation of an ArthurBaseJsonDataclass object - - - -Returns -Dictionary of the object with all None components removed - - - - - - - -to\_dict(*skip\_none=True*)[#](#arthurai.core.alerts.Metric.to_dict "Permalink to this definition") -Creates a dictionary representation of this object - - -This function can be applied to any extension of the ArthurBaseJsonDataClass - - - -Return type -`dict` - - - -Returns -Dictionary of object data - - - - - - - -to\_json(*skip\_none=True*)[#](#arthurai.core.alerts.Metric.to_json "Permalink to this definition") -Creates a json representation of this object - - -This function can be applied to any extension of the ArthurBaseJsonDataClass - - - -Return type -`str` - - - -Returns -json of object data - - - - - - - - - - - -[Next - -arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) -[Previous - -arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.alerts.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.alerts.md.txt deleted file mode 100644 index 95fd3b3350f2462cb26dfd4053e4be14c35fabdc..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.alerts.md.txt +++ /dev/null @@ -1,418 +0,0 @@ - - - - - - -arthurai.core.alerts - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](#)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.alerts[#](#module-arthurai.core.alerts "Permalink to this headline") -================================================================================== - - -Classes - - - - - - - - -| [`Alert`](arthurai.core.alerts.Alert.html#arthurai.core.alerts.Alert "arthurai.core.alerts.Alert")(id, timestamp, metric\_value, message, ...) | | -| [`AlertRule`](arthurai.core.alerts.AlertRule.html#arthurai.core.alerts.AlertRule "arthurai.core.alerts.AlertRule")(bound, threshold, metric\_id, severity) | | -| [`AlertRuleBound`](arthurai.core.alerts.AlertRuleBound.html#arthurai.core.alerts.AlertRuleBound "arthurai.core.alerts.AlertRuleBound")() | | -| [`AlertRuleSeverity`](arthurai.core.alerts.AlertRuleSeverity.html#arthurai.core.alerts.AlertRuleSeverity "arthurai.core.alerts.AlertRuleSeverity")() | | -| [`AlertStatus`](arthurai.core.alerts.AlertStatus.html#arthurai.core.alerts.AlertStatus "arthurai.core.alerts.AlertStatus")() | | -| [`Metric`](arthurai.core.alerts.Metric.html#arthurai.core.alerts.Metric "arthurai.core.alerts.Metric")(id, name, query, is\_default[, type, ...]) | | -| [`MetricType`](arthurai.core.alerts.MetricType.html#arthurai.core.alerts.MetricType "arthurai.core.alerts.MetricType")() | | - - - - - - - - -[Next - -arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) -[Previous - -arthurai.core](arthurai.core.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.attributes.AttributeBin.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.attributes.AttributeBin.md.txt deleted file mode 100644 index 2a761275a957172dcb232ff30e5e360be610ef7f..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.attributes.AttributeBin.md.txt +++ /dev/null @@ -1,520 +0,0 @@ - - - - - - -arthurai.core.attributes.AttributeBin - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](#) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.attributes.AttributeBin[#](#arthurai-core-attributes-attributebin "Permalink to this headline") -============================================================================================================= - - - - -*class* arthurai.core.attributes.AttributeBin(*continuous\_start=None*, *continuous\_end=None*)[#](#arthurai.core.attributes.AttributeBin "Permalink to this definition") -Bases: [`arthurai.core.base.ArthurBaseJsonDataclass`](arthurai.core.base.ArthurBaseJsonDataclass.html#arthurai.core.base.ArthurBaseJsonDataclass "arthurai.core.base.ArthurBaseJsonDataclass") - - - -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. - - - - -Methods - - - - - - - - -| [`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 | -| `from\_dict` | -rtype -`TypeVar`(`A`, bound= `DataClassJsonMixin`) - - | -| `from\_json` | -rtype -`TypeVar`(`A`, bound= `DataClassJsonMixin`) - - | -| `schema` | -rtype -`SchemaF`[`TypeVar`(`A`)] - - | -| [`to\_dict`](#arthurai.core.attributes.AttributeBin.to_dict "arthurai.core.attributes.AttributeBin.to_dict") | Creates a dictionary representation of this object | -| [`to\_json`](#arthurai.core.attributes.AttributeBin.to_json "arthurai.core.attributes.AttributeBin.to_json") | Creates a json representation of this object | - - - -Attributes - - - - - - - - -| `continuous\_end` | | -| `continuous\_start` | | -| `dataclass\_json\_config` | | - - - - - -*static* clean\_nones(*d*)[#](#arthurai.core.attributes.AttributeBin.clean_nones "Permalink to this definition") -Helper function to filter out None objects from a json or dictionary representation of an object - - - -Parameters -**d** – a Dictionary or Json representation of an ArthurBaseJsonDataclass object - - - -Returns -Dictionary of the object with all None components removed - - - - - - - -to\_dict(*skip\_none=True*)[#](#arthurai.core.attributes.AttributeBin.to_dict "Permalink to this definition") -Creates a dictionary representation of this object - - -This function can be applied to any extension of the ArthurBaseJsonDataClass - - - -Return type -`dict` - - - -Returns -Dictionary of object data - - - - - - - -to\_json(*skip\_none=True*)[#](#arthurai.core.attributes.AttributeBin.to_json "Permalink to this definition") -Creates a json representation of this object - - -This function can be applied to any extension of the ArthurBaseJsonDataClass - - - -Return type -`str` - - - -Returns -json of object data - - - - - - - - - - - -[Next - -arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) -[Previous - -arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.attributes.AttributeCategory.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.attributes.AttributeCategory.md.txt deleted file mode 100644 index de80c4441571e8d1ae7d104fadd01cbecb5d8c31..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.attributes.AttributeCategory.md.txt +++ /dev/null @@ -1,517 +0,0 @@ - - - - - - -arthurai.core.attributes.AttributeCategory - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](#) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.attributes.AttributeCategory[#](#arthurai-core-attributes-attributecategory "Permalink to this headline") -======================================================================================================================= - - - - -*class* arthurai.core.attributes.AttributeCategory(*value*, *label=None*)[#](#arthurai.core.attributes.AttributeCategory "Permalink to this definition") -Bases: [`arthurai.core.base.ArthurBaseJsonDataclass`](arthurai.core.base.ArthurBaseJsonDataclass.html#arthurai.core.base.ArthurBaseJsonDataclass "arthurai.core.base.ArthurBaseJsonDataclass") - - -A list of the attribute’s categories. An attribute will only have categories if it is marked as categorical. - - -Methods - - - - - - - - -| [`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 | -| `from\_dict` | -rtype -`TypeVar`(`A`, bound= `DataClassJsonMixin`) - - | -| `from\_json` | -rtype -`TypeVar`(`A`, bound= `DataClassJsonMixin`) - - | -| `schema` | -rtype -`SchemaF`[`TypeVar`(`A`)] - - | -| [`to\_dict`](#arthurai.core.attributes.AttributeCategory.to_dict "arthurai.core.attributes.AttributeCategory.to_dict") | Creates a dictionary representation of this object | -| [`to\_json`](#arthurai.core.attributes.AttributeCategory.to_json "arthurai.core.attributes.AttributeCategory.to_json") | Creates a json representation of this object | - - - -Attributes - - - - - - - - -| `dataclass\_json\_config` | | -| `label` | | -| `value` | | - - - - - -*static* clean\_nones(*d*)[#](#arthurai.core.attributes.AttributeCategory.clean_nones "Permalink to this definition") -Helper function to filter out None objects from a json or dictionary representation of an object - - - -Parameters -**d** – a Dictionary or Json representation of an ArthurBaseJsonDataclass object - - - -Returns -Dictionary of the object with all None components removed - - - - - - - -to\_dict(*skip\_none=True*)[#](#arthurai.core.attributes.AttributeCategory.to_dict "Permalink to this definition") -Creates a dictionary representation of this object - - -This function can be applied to any extension of the ArthurBaseJsonDataClass - - - -Return type -`dict` - - - -Returns -Dictionary of object data - - - - - - - -to\_json(*skip\_none=True*)[#](#arthurai.core.attributes.AttributeCategory.to_json "Permalink to this definition") -Creates a json representation of this object - - -This function can be applied to any extension of the ArthurBaseJsonDataClass - - - -Return type -`str` - - - -Returns -json of object data - - - - - - - - - - - -[Next - -arthurai.core.auth\_info](arthurai.core.auth_info.html) -[Previous - -arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.attributes.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.attributes.md.txt deleted file mode 100644 index e647273b0ea206996ec5a295048a1bbb76a3d0e1..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.attributes.md.txt +++ /dev/null @@ -1,414 +0,0 @@ - - - - - - -arthurai.core.attributes - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](#)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.attributes[#](#module-arthurai.core.attributes "Permalink to this headline") -========================================================================================== - - -Classes - - - - - - - - -| [`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 | -| [`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 | -| [`AttributeCategory`](arthurai.core.attributes.AttributeCategory.html#arthurai.core.attributes.AttributeCategory "arthurai.core.attributes.AttributeCategory")(value[, label]) | A list of the attribute's categories. | - - - - - - - - -[Next - -arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) -[Previous - -arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.auth_info.AuthInfo.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.auth_info.AuthInfo.md.txt deleted file mode 100644 index 64647b8bafb5af7a81887fb04e7f7787557ecff3..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.auth_info.AuthInfo.md.txt +++ /dev/null @@ -1,521 +0,0 @@ - - - - - - -arthurai.core.auth\_info.AuthInfo - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](#) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.auth\_info.AuthInfo[#](#arthurai-core-auth-info-authinfo "Permalink to this headline") -==================================================================================================== - - - - -*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") -Bases: [`arthurai.core.base.ArthurBaseJsonDataclass`](arthurai.core.base.ArthurBaseJsonDataclass.html#arthurai.core.base.ArthurBaseJsonDataclass "arthurai.core.base.ArthurBaseJsonDataclass") - - -Methods - - - - - - - - -| [`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 | -| `from\_dict` | -rtype -`TypeVar`(`A`, bound= `DataClassJsonMixin`) - - | -| `from\_json` | -rtype -`TypeVar`(`A`, bound= `DataClassJsonMixin`) - - | -| `schema` | -rtype -`SchemaF`[`TypeVar`(`A`)] - - | -| [`to\_dict`](#arthurai.core.auth_info.AuthInfo.to_dict "arthurai.core.auth_info.AuthInfo.to_dict") | Creates a dictionary representation of this object | -| [`to\_json`](#arthurai.core.auth_info.AuthInfo.to_json "arthurai.core.auth_info.AuthInfo.to_json") | Creates a json representation of this object | - - - -Attributes - - - - - - - - -| `dataclass\_json\_config` | | -| `external\_user\_id` | | -| `internal\_user\_id` | | -| `issuer` | | -| `username` | | -| `first\_name` | | -| `last\_name` | | -| `email` | | -| `roles` | | -| `organization\_ids` | | - - - - - -*static* clean\_nones(*d*)[#](#arthurai.core.auth_info.AuthInfo.clean_nones "Permalink to this definition") -Helper function to filter out None objects from a json or dictionary representation of an object - - - -Parameters -**d** – a Dictionary or Json representation of an ArthurBaseJsonDataclass object - - - -Returns -Dictionary of the object with all None components removed - - - - - - - -to\_dict(*skip\_none=True*)[#](#arthurai.core.auth_info.AuthInfo.to_dict "Permalink to this definition") -Creates a dictionary representation of this object - - -This function can be applied to any extension of the ArthurBaseJsonDataClass - - - -Return type -`dict` - - - -Returns -Dictionary of object data - - - - - - - -to\_json(*skip\_none=True*)[#](#arthurai.core.auth_info.AuthInfo.to_json "Permalink to this definition") -Creates a json representation of this object - - -This function can be applied to any extension of the ArthurBaseJsonDataClass - - - -Return type -`str` - - - -Returns -json of object data - - - - - - - - - - - -[Next - -arthurai.core.base](arthurai.core.base.html) -[Previous - -arthurai.core.auth\_info](arthurai.core.auth_info.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.base.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.base.md.txt deleted file mode 100644 index 6520725e177f5d082b180870a55f2f0acfa32221..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.base.md.txt +++ /dev/null @@ -1,412 +0,0 @@ - - - - - - -arthurai.core.base - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](#)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.base[#](#module-arthurai.core.base "Permalink to this headline") -============================================================================== - - -Classes - - - - - - - - -| [`ArthurBaseJsonDataclass`](arthurai.core.base.ArthurBaseJsonDataclass.html#arthurai.core.base.ArthurBaseJsonDataclass "arthurai.core.base.ArthurBaseJsonDataclass")() | | - - - - - - - - -[Next - -arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) -[Previous - -arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.bias.bias_metrics.BiasMetrics.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.bias.bias_metrics.BiasMetrics.md.txt deleted file mode 100644 index 7bcf96fa07da40314046ebd06ae74d2f62b0d517..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.bias.bias_metrics.BiasMetrics.md.txt +++ /dev/null @@ -1,495 +0,0 @@ - - - - - - -arthurai.core.bias.bias\_metrics.BiasMetrics - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](#) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.bias.bias\_metrics.BiasMetrics[#](#arthurai-core-bias-bias-metrics-biasmetrics "Permalink to this headline") -========================================================================================================================== - - - - -*class* arthurai.core.bias.bias\_metrics.BiasMetrics(*arthur\_model*)[#](#arthurai.core.bias.bias_metrics.BiasMetrics "Permalink to this definition") -Bases: `object` - - -Methods - - - - - - - - -| [`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. | -| [`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. | -| [`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. | - - - - - -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") -Get group-conditional positivity rates for all inferences, with the option to filter for a batch\_id or -a particular chunk of time. Currently only supports calculating bias with respect to a single sensitive -attribute at a time. This method currently only handles binary models. - - - -Parameters -* **attr\_name** (`str`) – The name of the sensitive attribute to get metrics for. -* **batch\_id** (`Optional`[`str`]) – Optional filter to limit calculations to a specific batch ID. -* **start\_time** (`Optional`[`datetime`]) – Optional filter to limit calculations to inferences after a specific timestamp. -* **end\_time** (`Optional`[`datetime`]) – Optional filter to limit calculations to inferences before a specific timestamp. - - - -Returns -A dict of the form {sens\_1: pos\_1, sens\_2: pos\_2, …} - - - - - - - -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") -Get group-conditional confusion matrices for all inferences, with the option to filter for a batch\_id or -a particular chunk of time. Currently only supports calculating bias with respect to a single sensitive -attribute at a time. This method handles both binary and multiclass models. - - - -Parameters -* **attr\_name** (`str`) – The name of the sensitive attribute to get metrics for. -* **pred\_property** (`Optional`[`str`]) – For multiclass models, the predicted label to get the confusion matrix for. -* **batch\_id** (`Optional`[`str`]) – Optional filter to limit calculations to a specific batch ID. -* **start\_time** (`Optional`[`datetime`]) – Optional filter to limit calculations to inferences after a specific timestamp. -* **end\_time** (`Optional`[`datetime`]) – Optional filter to limit calculations to inferences before a specific timestamp. -* **return\_by\_metric** – Whether the returned dictionary of results should be keyed by metric or by sensitive attribute value. - - - -Returns -Either a dict of the form { metric: { sens\_1: val1, sens\_2: val2 }, …} (default) or its reverse. - - - - - - - -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") -Get group-conditional positivity rates for all inferences, with the option to filter for a batch\_id or -a particular chunk of time. Currently only supports calculating bias with respect to a single sensitive -attribute at a time. This method currently only handles binary models. - - - -Parameters -* **attr\_name** (`str`) – The name of the sensitive attribute to get metrics for. -* **batch\_id** (`Optional`[`str`]) – Optional filter to limit calculations to a specific batch ID. -* **start\_time** (`Optional`[`datetime`]) – Optional filter to limit calculations to inferences after a specific timestamp. -* **end\_time** (`Optional`[`datetime`]) – Optional filter to limit calculations to inferences before a specific timestamp. - - - -Returns -A dict of the form {sens\_1: pos\_1, sens\_2: pos\_2, …} - - - - - - - - - - - -[Next - -arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html) -[Previous - -arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.bias.bias_metrics.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.bias.bias_metrics.md.txt deleted file mode 100644 index 177eda451f8dd3935d805958730342131863d612..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.bias.bias_metrics.md.txt +++ /dev/null @@ -1,412 +0,0 @@ - - - - - - -arthurai.core.bias.bias\_metrics - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](#)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.bias.bias\_metrics[#](#module-arthurai.core.bias.bias_metrics "Permalink to this headline") -========================================================================================================= - - -Classes - - - - - - - - -| [`BiasMetrics`](arthurai.core.bias.bias_metrics.BiasMetrics.html#arthurai.core.bias.bias_metrics.BiasMetrics "arthurai.core.bias.bias_metrics.BiasMetrics")(arthur\_model) | | - - - - - - - - -[Next - -arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) -[Previous - -arthurai.core.bias](arthurai.core.bias.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.md.txt deleted file mode 100644 index 2e2121217a3ce4dbb40e0fe3316081cb61b6980d..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.md.txt +++ /dev/null @@ -1,423 +0,0 @@ - - - - - - -arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](#) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper[#](#arthurai-core-bias-bias-wrapper-arthurbiaswrapper "Permalink to this headline") -====================================================================================================================================== - - - - -*class* arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper(*arthur\_model*)[#](#arthurai.core.bias.bias_wrapper.ArthurBiasWrapper "Permalink to this definition") -Bases: `object` - - -This is a wrapper class for all bias-related functionality, including metrics -and mitigation. This allows users to access bias functionality directly from the -ArthurModel object: arthur\_model.bias.metrics, for example. - - -Methods - - - - - - - - - - - - - - - - - -[Next - -arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html) -[Previous - -arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.bias.bias_wrapper.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.bias.bias_wrapper.md.txt deleted file mode 100644 index b240e97428fa437eba10e2ec947e1f61ffb21216..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.bias.bias_wrapper.md.txt +++ /dev/null @@ -1,412 +0,0 @@ - - - - - - -arthurai.core.bias.bias\_wrapper - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](#)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.bias.bias\_wrapper[#](#module-arthurai.core.bias.bias_wrapper "Permalink to this headline") -========================================================================================================= - - -Classes - - - - - - - - -| [`ArthurBiasWrapper`](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html#arthurai.core.bias.bias_wrapper.ArthurBiasWrapper "arthurai.core.bias.bias_wrapper.ArthurBiasWrapper")(arthur\_model) | This is a wrapper class for all bias-related functionality, including metrics and mitigation. | - - - - - - - - -[Next - -arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) -[Previous - -arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.bias.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.bias.md.txt deleted file mode 100644 index fc2facc626503130fd50a2f4db76862f6e46144d..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.bias.md.txt +++ /dev/null @@ -1,411 +0,0 @@ - - - - - - -arthurai.core.bias - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](#)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.bias[#](#module-arthurai.core.bias "Permalink to this headline") -============================================================================== - - - - - - - - -| [`arthurai.core.bias.bias\_metrics`](arthurai.core.bias.bias_metrics.html#module-arthurai.core.bias.bias_metrics "arthurai.core.bias.bias_metrics") | | -| [`arthurai.core.bias.bias\_wrapper`](arthurai.core.bias.bias_wrapper.html#module-arthurai.core.bias.bias_wrapper "arthurai.core.bias.bias_wrapper") | | -| [`arthurai.core.bias.threshold\_mitigation`](arthurai.core.bias.threshold_mitigation.html#module-arthurai.core.bias.threshold_mitigation "arthurai.core.bias.threshold_mitigation") | | - - - - - - - - -[Next - -arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html) -[Previous - -arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.bias.threshold_mitigation.Curves.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.bias.threshold_mitigation.Curves.md.txt deleted file mode 100644 index a9f8e162582c70ceebe82111bf12f1e30aa84ec0..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.bias.threshold_mitigation.Curves.md.txt +++ /dev/null @@ -1,439 +0,0 @@ - - - - - - -arthurai.core.bias.threshold\_mitigation.Curves - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](#) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.bias.threshold\_mitigation.Curves[#](#arthurai-core-bias-threshold-mitigation-curves "Permalink to this headline") -================================================================================================================================ - - - - -*class* arthurai.core.bias.threshold\_mitigation.Curves(*attribute\_name*, *constraint*, *max\_acc\_idx*, *attr\_val\_to\_threshold*)[#](#arthurai.core.bias.threshold_mitigation.Curves "Permalink to this definition") -Bases: `object` - - -A class which defines information about a given set of curves for a specific sensitive -attribute and a specific constraint, as well as a dictionary mapping attribute values -to the curves themselves - - -Methods - - - - - - - - - - - -Attributes - - - - - - - - -| `attribute\_name` | | -| `constraint` | | -| `max\_acc\_idx` | | -| `attr\_val\_to\_threshold` | | - - - - - - - - - -[Next - -arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) -[Previous - -arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.bias.threshold_mitigation.ThresholdMitigation.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.bias.threshold_mitigation.ThresholdMitigation.md.txt deleted file mode 100644 index c0546c83fa8621b1951def8fbfa5470df0402e9f..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.bias.threshold_mitigation.ThresholdMitigation.md.txt +++ /dev/null @@ -1,485 +0,0 @@ - - - - - - -arthurai.core.bias.threshold\_mitigation.ThresholdMitigation - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](#) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.bias.threshold\_mitigation.ThresholdMitigation[#](#arthurai-core-bias-threshold-mitigation-thresholdmitigation "Permalink to this headline") -========================================================================================================================================================== - - - - -*class* arthurai.core.bias.threshold\_mitigation.ThresholdMitigation(*arthur\_model*)[#](#arthurai.core.bias.threshold_mitigation.ThresholdMitigation "Permalink to this definition") -Bases: `object` - - -Methods - - - - - - - - -| [`enable`](#arthurai.core.bias.threshold_mitigation.ThresholdMitigation.enable "arthurai.core.bias.threshold_mitigation.ThresholdMitigation.enable") | Triggers workflow to train curves for all constraints and for all sensitive attributes. | -| [`get\_curves`](#arthurai.core.bias.threshold_mitigation.ThresholdMitigation.get_curves "arthurai.core.bias.threshold_mitigation.ThresholdMitigation.get_curves") | Fetch curves for the given sensitive attribute and constraint. | -| [`get\_thresholds\_for\_idx`](#arthurai.core.bias.threshold_mitigation.ThresholdMitigation.get_thresholds_for_idx "arthurai.core.bias.threshold_mitigation.ThresholdMitigation.get_thresholds_for_idx") | Retrieve the thresholds for each group, given a set of curves and aparticular optimization index. | -| [`plot\_curves`](#arthurai.core.bias.threshold_mitigation.ThresholdMitigation.plot_curves "arthurai.core.bias.threshold_mitigation.ThresholdMitigation.plot_curves") | Simple plot of the tradeoff curve for a single sensitive attribute and constraint. | - - - - - -enable()[#](#arthurai.core.bias.threshold_mitigation.ThresholdMitigation.enable "Permalink to this definition") -Triggers workflow to train curves for all constraints and for all sensitive attributes. -Equivalent to calling arthurmodel.enable\_bias\_mitigation(); here for convenience. - - - - - -get\_curves(*attribute*, *constraint='equal\_opportunity'*)[#](#arthurai.core.bias.threshold_mitigation.ThresholdMitigation.get_curves "Permalink to this definition") -Fetch curves for the given sensitive attribute and constraint. - - - -Parameters -* **attribute** (`str`) – Name of the sensitive attribute to fetch curves for. -* **constraint** (`str`) – which constraint to use. “demographic\_parity”, “equal\_opportunity”, or “equalized\_odds” - - - -Returns -a Curves object which contains information about the attribute, constraint, accuracy-maximizing index, -and the actual curves. - - - - - - - -get\_thresholds\_for\_idx(*curves*, *idx=None*)[#](#arthurai.core.bias.threshold_mitigation.ThresholdMitigation.get_thresholds_for_idx "Permalink to this definition") -Retrieve the thresholds for each group, given a set of curves and aparticular optimization index. - - - -Parameters -* **curves** ([`Curves`](arthurai.core.bias.threshold_mitigation.Curves.html#arthurai.core.bias.threshold_mitigation.Curves "arthurai.core.bias.threshold_mitigation.Curves")) – one Curves object containing a set of curves corresponding to a single sensitive attribute and constraint. -* **idx** (`Optional`[`int`]) – one integer (between 0 and 1000, inclusive) that represents a specific solution option. Defaults to the curve’s accuracy-maximizing index. - - - -Returns -a dictionary mapping sensitive feature values to the prediction threshold used for that group. - - - - - - - -plot\_curves(*curves=None*, *attribute=None*, *constraint=None*)[#](#arthurai.core.bias.threshold_mitigation.ThresholdMitigation.plot_curves "Permalink to this definition") -Simple plot of the tradeoff curve for a single sensitive attribute and constraint. - - - -Parameters -**curves** (`Optional`[[`Curves`](arthurai.core.bias.threshold_mitigation.Curves.html#arthurai.core.bias.threshold_mitigation.Curves "arthurai.core.bias.threshold_mitigation.Curves")]) – one Curves object containing a set of curves corresponding to a single sensitive attribute and constraint. - - - - - - - - - - - -[Next - -arthurai.core.data\_service](arthurai.core.data_service.html) -[Previous - -arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.bias.threshold_mitigation.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.bias.threshold_mitigation.md.txt deleted file mode 100644 index 6a5f8eaaa1dc02dab2c447017ff264cc54330851..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.bias.threshold_mitigation.md.txt +++ /dev/null @@ -1,413 +0,0 @@ - - - - - - -arthurai.core.bias.threshold\_mitigation - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](#)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.bias.threshold\_mitigation[#](#module-arthurai.core.bias.threshold_mitigation "Permalink to this headline") -========================================================================================================================= - - -Classes - - - - - - - - -| [`Curves`](arthurai.core.bias.threshold_mitigation.Curves.html#arthurai.core.bias.threshold_mitigation.Curves "arthurai.core.bias.threshold_mitigation.Curves")(attribute\_name, constraint, ...) | A class which defines information about a given set of curves for a specific sensitive attribute and a specific constraint, as well as a dictionary mapping attribute values to the curves themselves | -| [`ThresholdMitigation`](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html#arthurai.core.bias.threshold_mitigation.ThresholdMitigation "arthurai.core.bias.threshold_mitigation.ThresholdMitigation")(arthur\_model) | | - - - - - - - - -[Next - -arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) -[Previous - -arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.data_service.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.data_service.md.txt deleted file mode 100644 index 6c2d38693af008a209c39b23e8d62131332a20cd..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.data_service.md.txt +++ /dev/null @@ -1,413 +0,0 @@ - - - - - - -arthurai.core.data\_service - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](#)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.data\_service[#](#module-arthurai.core.data_service "Permalink to this headline") -=============================================================================================== - - -Classes - - - - - - - - -| [`DatasetService`](arthurai.core.data_service.DatasetService.html#arthurai.core.data_service.DatasetService "arthurai.core.data_service.DatasetService")() | | -| [`ImageZipper`](arthurai.core.data_service.ImageZipper.html#arthurai.core.data_service.ImageZipper "arthurai.core.data_service.ImageZipper")() | | - - - - - - - - -[Next - -arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) -[Previous - -arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.decorators.log_prediction.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.decorators.log_prediction.md.txt deleted file mode 100644 index 6c323dffa6f0f365cb0bad3e2621bce75408f6fe..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.decorators.log_prediction.md.txt +++ /dev/null @@ -1,435 +0,0 @@ - - - - - - -arthurai.core.decorators.log\_prediction - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](#) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.decorators.log\_prediction[#](#arthurai-core-decorators-log-prediction "Permalink to this headline") -================================================================================================================== - - - - -arthurai.core.decorators.log\_prediction(*arthur\_model*)[#](#arthurai.core.decorators.log_prediction "Permalink to this definition") -Decorator to log the inputs and prediction of a model to Arthur. - - - -Parameters -**arthur\_model** ([`ArthurModel`](arthurai.core.models.ArthurModel.html#arthurai.core.models.ArthurModel "arthurai.core.models.ArthurModel")) – A previously-saved ArthurModel object - - - - -Note, the prediction function to be decorated can take optional arguments for logging; -these should be passed as kwargs into the function to be decorated. - - - -Parameters -* **inference\_timestamp** – A timestamp in ISO 8601 format -* **partner\_inference\_id** – A unique identifier for an inference - - - -Return type -`Callable`[[`Any`], `Any`] - - - -Returns -Tuple of (model\_prediction, inference\_id) - - - - - - - - - - -[Next - -arthurai.core.inferences](arthurai.core.inferences.html) -[Previous - -arthurai.core.decorators](arthurai.core.decorators.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.decorators.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.decorators.md.txt deleted file mode 100644 index 7f22c184c3fc4ad698a37c15d0da520d5e03c9cb..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.decorators.md.txt +++ /dev/null @@ -1,412 +0,0 @@ - - - - - - -arthurai.core.decorators - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](#)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.decorators[#](#module-arthurai.core.decorators "Permalink to this headline") -========================================================================================== - - -Functions - - - - - - - - -| [`log\_prediction`](arthurai.core.decorators.log_prediction.html#arthurai.core.decorators.log_prediction "arthurai.core.decorators.log_prediction")(arthur\_model) | Decorator to log the inputs and prediction of a model to Arthur. | - - - - - - - - -[Next - -arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) -[Previous - -arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.inferences.add_inference_metadata_to_dataframe.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.inferences.add_inference_metadata_to_dataframe.md.txt deleted file mode 100644 index 511e9c63d228196177f9de3c7c9072e8fd14c371..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.inferences.add_inference_metadata_to_dataframe.md.txt +++ /dev/null @@ -1,431 +0,0 @@ - - - - - - -arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](#) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe[#](#arthurai-core-inferences-add-inference-metadata-to-dataframe "Permalink to this headline") -=============================================================================================================================================================== - - - - -arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe(*df*, *model\_attributes*, *ignore\_join\_errors=False*)[#](#arthurai.core.inferences.add_inference_metadata_to_dataframe "Permalink to this definition") -Adds timestamp and/or partner\_inference\_id fields to the DataFrame. - - - -Parameters -* **df** (`DataFrame`) – DataFrame to add metadata to -* **model\_attributes** (`Collection`[[`ArthurAttribute`](arthurai.core.attributes.ArthurAttribute.html#arthurai.core.attributes.ArthurAttribute "arthurai.core.attributes.ArthurAttribute")]) – attributes of the model -* **ignore\_join\_errors** (`bool`) – if True, allow inference data without `partner\_inference\_id` or ground truth data - - - -Return type -`DataFrame` - - - -Returns -the input DataFrame if no updates are needed, otherwise a shallow copy with the new columns - - - -Raises -**UserValueError** – if inference data is supplied without `partner\_inference\_id` or ground truth data, and -`ignore\_join\_errors` is False. - - - - - - - - - - -[Next - -arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) -[Previous - -arthurai.core.inferences](arthurai.core.inferences.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.inferences.add_predictions_or_ground_truth.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.inferences.add_predictions_or_ground_truth.md.txt deleted file mode 100644 index 627228292861b32c981f87ae87ae6a830977c7ee..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.inferences.add_predictions_or_ground_truth.md.txt +++ /dev/null @@ -1,416 +0,0 @@ - - - - - - -arthurai.core.inferences.add\_predictions\_or\_ground\_truth - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](#) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.inferences.add\_predictions\_or\_ground\_truth[#](#arthurai-core-inferences-add-predictions-or-ground-truth "Permalink to this headline") -======================================================================================================================================================= - - - - -arthurai.core.inferences.add\_predictions\_or\_ground\_truth(*inference\_data*, *new\_data*, *attributes*, *stage*)[#](#arthurai.core.inferences.add_predictions_or_ground_truth "Permalink to this definition") -Add prediction or ground truth data to inference data *in place*. -:type inference\_data: `List`[`Dict`[`str`, `Any`]] -:param inference\_data: the inference data as a List of Dicts as expected by the Arthur API -:type new\_data: `Union`[`List`[`Dict`[`str`, `Any`]], `Dict`[`str`, `List`[`Any`]], `DataFrame`, `Iterable`[`Any`]] -:param new\_data: the new data to add in, as a List of Dicts, Dict of Lists, DataFrame, or Sequence -(if a single column) -:type attributes: `List`[[`ArthurAttribute`](arthurai.core.attributes.ArthurAttribute.html#arthurai.core.attributes.ArthurAttribute "arthurai.core.attributes.ArthurAttribute")] -:param attributes: the model’s attributes -:type stage: [`Stage`](arthurai.common.constants.Stage.html#arthurai.common.constants.Stage "arthurai.common.constants.Stage") -:param stage: the Stage of the new data, either PredictedValue or GroundTruth -:return: None (modifies inference\_data in place) - - - - - - - - -[Next - -arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) -[Previous - -arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.inferences.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.inferences.md.txt deleted file mode 100644 index 7b8700493ec8ca49b1e6084755bfea5d87e37b5d..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.inferences.md.txt +++ /dev/null @@ -1,415 +0,0 @@ - - - - - - -arthurai.core.inferences - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](#)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.inferences[#](#module-arthurai.core.inferences "Permalink to this headline") -========================================================================================== - - -Functions - - - - - - - - -| [`add\_inference\_metadata\_to\_dataframe`](arthurai.core.inferences.add_inference_metadata_to_dataframe.html#arthurai.core.inferences.add_inference_metadata_to_dataframe "arthurai.core.inferences.add_inference_metadata_to_dataframe")(df, ...) | Adds timestamp and/or partner\_inference\_id fields to the DataFrame. | -| [`add\_predictions\_or\_ground\_truth`](arthurai.core.inferences.add_predictions_or_ground_truth.html#arthurai.core.inferences.add_predictions_or_ground_truth "arthurai.core.inferences.add_predictions_or_ground_truth")(...) | Add prediction or ground truth data to inference data *in place*. | -| [`nest\_inference\_and\_ground\_truth\_data`](arthurai.core.inferences.nest_inference_and_ground_truth_data.html#arthurai.core.inferences.nest_inference_and_ground_truth_data "arthurai.core.inferences.nest_inference_and_ground_truth_data")(data, ...) | Reformat List of Dicts inference data to nest inference and ground truth data as expected by the Arthur API. | -| [`parse\_stage\_attributes`](arthurai.core.inferences.parse_stage_attributes.html#arthurai.core.inferences.parse_stage_attributes "arthurai.core.inferences.parse_stage_attributes")(data, attributes, stage) | Parses data for a single stage into the standard List of Dicts format. | - - - - - - - - -[Next - -arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) -[Previous - -arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.inferences.parse_stage_attributes.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.inferences.parse_stage_attributes.md.txt deleted file mode 100644 index d3b4e5bd02d0da97fd412891679100ee2b82f465..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.inferences.parse_stage_attributes.md.txt +++ /dev/null @@ -1,431 +0,0 @@ - - - - - - -arthurai.core.inferences.parse\_stage\_attributes - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](#) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.inferences.parse\_stage\_attributes[#](#arthurai-core-inferences-parse-stage-attributes "Permalink to this headline") -=================================================================================================================================== - - - - -arthurai.core.inferences.parse\_stage\_attributes(*data*, *attributes*, *stage*)[#](#arthurai.core.inferences.parse_stage_attributes "Permalink to this definition") -Parses data for a single stage into the standard List of Dicts format. - - -If the stage contains only a single attribute, data can be a single list-like column. - - - -See also - - -Similar to dataframe\_like\_to\_list\_of\_dicts, but an expected column (attribute)-aware and supports single columns - - - - -Parameters -* **data** (`Union`[`List`[`Dict`[`str`, `Any`]], `Dict`[`str`, `List`[`Any`]], `DataFrame`, `Iterable`[`Any`]]) – -* **attributes** (`List`[[`ArthurAttribute`](arthurai.core.attributes.ArthurAttribute.html#arthurai.core.attributes.ArthurAttribute "arthurai.core.attributes.ArthurAttribute")]) – -* **stage** ([`Stage`](arthurai.common.constants.Stage.html#arthurai.common.constants.Stage "arthurai.common.constants.Stage")) – - - - -Returns -parsed data in List of Dicts formt - - - - - - - - - - -[Next - -arthurai.core.model\_utils](arthurai.core.model_utils.html) -[Previous - -arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.md.txt deleted file mode 100644 index 559036ba98ae9170e8afb4f250da299ae7f9afe5..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.md.txt +++ /dev/null @@ -1,423 +0,0 @@ - - - - - - -arthurai.core - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](#)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core[#](#module-arthurai.core "Permalink to this headline") -==================================================================== - - -Primary ArthurAI functionality - - - - - - - - -| [`arthurai.core.alerts`](arthurai.core.alerts.html#module-arthurai.core.alerts "arthurai.core.alerts") | | -| [`arthurai.core.attributes`](arthurai.core.attributes.html#module-arthurai.core.attributes "arthurai.core.attributes") | | -| [`arthurai.core.auth\_info`](arthurai.core.auth_info.html#module-arthurai.core.auth_info "arthurai.core.auth_info") | | -| [`arthurai.core.base`](arthurai.core.base.html#module-arthurai.core.base "arthurai.core.base") | | -| [`arthurai.core.bias`](arthurai.core.bias.html#module-arthurai.core.bias "arthurai.core.bias") | | -| [`arthurai.core.data\_service`](arthurai.core.data_service.html#module-arthurai.core.data_service "arthurai.core.data_service") | | -| [`arthurai.core.decorators`](arthurai.core.decorators.html#module-arthurai.core.decorators "arthurai.core.decorators") | | -| [`arthurai.core.inferences`](arthurai.core.inferences.html#module-arthurai.core.inferences "arthurai.core.inferences") | | -| [`arthurai.core.model\_utils`](arthurai.core.model_utils.html#module-arthurai.core.model_utils "arthurai.core.model_utils") | | -| [`arthurai.core.models`](arthurai.core.models.html#module-arthurai.core.models "arthurai.core.models") | | -| [`arthurai.core.util`](arthurai.core.util.html#module-arthurai.core.util "arthurai.core.util") | | -| [`arthurai.core.viz`](arthurai.core.viz.html#module-arthurai.core.viz "arthurai.core.viz") | | - - - - - - - - -[Next - -arthurai.core.alerts](arthurai.core.alerts.html) -[Previous - -arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.model_utils.check_has_bias_attrs.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.model_utils.check_has_bias_attrs.md.txt deleted file mode 100644 index 343c3a962479766424c0a938ef03e7a7ad4e88c0..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.model_utils.check_has_bias_attrs.md.txt +++ /dev/null @@ -1,406 +0,0 @@ - - - - - - -arthurai.core.model\_utils.check\_has\_bias\_attrs - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](#) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.model\_utils.check\_has\_bias\_attrs[#](#arthurai-core-model-utils-check-has-bias-attrs "Permalink to this headline") -=================================================================================================================================== - - - - -arthurai.core.model\_utils.check\_has\_bias\_attrs(*model*)[#](#arthurai.core.model_utils.check_has_bias_attrs "Permalink to this definition") -Returns True if and only if the model has any attributes being monitored for bias by Arthur - - - - - - - - -[Next - -arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) -[Previous - -arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.model_utils.get_positive_predicted_class.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.model_utils.get_positive_predicted_class.md.txt deleted file mode 100644 index 38440f6da9fc08483ca28c59c7d6d7d6dc45e5e9..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.model_utils.get_positive_predicted_class.md.txt +++ /dev/null @@ -1,407 +0,0 @@ - - - - - - -arthurai.core.model\_utils.get\_positive\_predicted\_class - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](#) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.model\_utils.get\_positive\_predicted\_class[#](#arthurai-core-model-utils-get-positive-predicted-class "Permalink to this headline") -=================================================================================================================================================== - - - - -arthurai.core.model\_utils.get\_positive\_predicted\_class(*model*)[#](#arthurai.core.model_utils.get_positive_predicted_class "Permalink to this definition") -Checks if model is a binary classifier. Returns False if multiclass, otherwise returns the name of the positive -predicted attribute - - - - - - - - -[Next - -arthurai.core.models](arthurai.core.models.html) -[Previous - -arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.model_utils.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.model_utils.md.txt deleted file mode 100644 index 84c63a36018406736f91f8493cea125a025f4e47..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.model_utils.md.txt +++ /dev/null @@ -1,414 +0,0 @@ - - - - - - -arthurai.core.model\_utils - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](#)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.model\_utils[#](#module-arthurai.core.model_utils "Permalink to this headline") -============================================================================================= - - -Functions - - - - - - - - -| [`check\_attr\_is\_bias`](arthurai.core.model_utils.check_attr_is_bias.html#arthurai.core.model_utils.check_attr_is_bias "arthurai.core.model_utils.check_attr_is_bias")(model, attr\_name) | Returns True if and only if the model has an attribute with the given name attr\_name being monitored for bias by Arthur | -| [`check\_has\_bias\_attrs`](arthurai.core.model_utils.check_has_bias_attrs.html#arthurai.core.model_utils.check_has_bias_attrs "arthurai.core.model_utils.check_has_bias_attrs")(model) | Returns True if and only if the model has any attributes being monitored for bias by Arthur | -| [`get\_positive\_predicted\_class`](arthurai.core.model_utils.get_positive_predicted_class.html#arthurai.core.model_utils.get_positive_predicted_class "arthurai.core.model_utils.get_positive_predicted_class")(model) | Checks if model is a binary classifier. | - - - - - - - - -[Next - -arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) -[Previous - -arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.models.ArthurModel.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.models.ArthurModel.md.txt deleted file mode 100644 index 3d06a9939f4ce760dd99d942cb0eeeefdd095b54..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.models.ArthurModel.md.txt +++ /dev/null @@ -1,3390 +0,0 @@ - - - - - - -arthurai.core.models.ArthurModel - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](#) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.models.ArthurModel[#](#arthurai-core-models-arthurmodel "Permalink to this headline") -=================================================================================================== - - - - -*class* arthurai.core.models.ArthurModel(*partner\_model\_id*, *input\_type*, *output\_type*, *client=None*, *explainability=None*, *id=None*, *display\_name=None*, *description=None*, *is\_batch=False*, *archived=False*, *created\_at=None*, *updated\_at=None*, *attributes=None*, *tags=None*, *classifier\_threshold=None*, *text\_delimiter=None*, *expected\_throughput\_gb\_per\_day=None*, *pixel\_height=None*, *pixel\_width=None*, *image\_class\_labels=None*, *reference\_dataframe=None*, *model\_group\_id=None*, *version\_sequence\_num=None*, *version\_label=None*)[#](#arthurai.core.models.ArthurModel "Permalink to this definition") -Bases: [`arthurai.core.base.ArthurBaseJsonDataclass`](arthurai.core.base.ArthurBaseJsonDataclass.html#arthurai.core.base.ArthurBaseJsonDataclass "arthurai.core.base.ArthurBaseJsonDataclass") - - -Arthur Model class represents the metadata which represents a registered model in the application - - - -Parameters -* **client** – `arthurai.client.Client` object which manages data storage -* **partner\_model\_id** – Client provided unique id to associate with the model. This field must be unique across -all active models cannot be changed once set. -* **input\_type** – [`arthurai.common.constants.InputType`](arthurai.common.constants.InputType.html#arthurai.common.constants.InputType "arthurai.common.constants.InputType") representing the model’s input data type. -* **output\_type** – [`arthurai.common.constants.InputType`](arthurai.common.constants.InputType.html#arthurai.common.constants.InputType "arthurai.common.constants.InputType") representing the model’s output data format. -* **explainability** – [`arthurai.core.models.ExplainabilityParameters`](arthurai.core.models.ExplainabilityParameters.html#arthurai.core.models.ExplainabilityParameters "arthurai.core.models.ExplainabilityParameters") object representing parameters that -will be used to create inference explanations. -* **id** – The auto-generated unique UUID for the model. Will be overwritten if set by the user. -* **display\_name** – An optional display name for the model. -* **description** – Optional description of the model. -* **is\_batch** – Boolean value to determine whether the model sends inferences in batch or streaming format. -Defaults to False. -* **archived** – Indicates whether or not a model has been archived, defaults to false. -* **created\_at** – UTC timestamp in ISO8601 format of when the model was created. Will be overwritten if set by the -user. -* **updated\_at** – UTC timestamp in ISO8601 format of when the model was last updated. Will be overwritten if set by -the user. -* **attributes** – List of [`arthurai.core.attributes.ArthurAttribute`](arthurai.core.attributes.ArthurAttribute.html#arthurai.core.attributes.ArthurAttribute "arthurai.core.attributes.ArthurAttribute") objects registered to the model -* **tags** – List of string keywords to associate with the model. -* **classifier\_thresholds** – Threshold value for classification models, default is 0.5. -* **text\_delimiter** – Only valid for models with input\_type equal to -`arthurai.common.constants.InputType.NLP`. Represents the text delimiter -to divide input strings. -* **expected\_throughput\_gb\_per\_day** – Expected amount of throughput. -* **pixel\_height** – Only valid for models with input\_type equal to -`arthurai.common.constants.InputType.Image`. Expected image height in pixels. -* **pixel\_width** – Only valid for models with input\_type equal to -`arthurai.common.constants.InputType.Image`. Expected image width in pixels. - - - - -Methods - - - - - - - - -| [`add\_attribute`](#arthurai.core.models.ArthurModel.add_attribute "arthurai.core.models.ArthurModel.add_attribute") | Adds a new attribute of stage ModelPipelineInput or NonInputData to the model. | -| [`add\_binary\_classifier\_output\_attributes`](#arthurai.core.models.ArthurModel.add_binary_classifier_output_attributes "arthurai.core.models.ArthurModel.add_binary_classifier_output_attributes") | Registers GroundTruth and PredictedValue attributes and their thresholds | -| [`add\_classifier\_output\_attributes\_gtclass`](#arthurai.core.models.ArthurModel.add_classifier_output_attributes_gtclass "arthurai.core.models.ArthurModel.add_classifier_output_attributes_gtclass") | Registers ground truth and predicted value attributes for classification models | -| [`add\_image\_attribute`](#arthurai.core.models.ArthurModel.add_image_attribute "arthurai.core.models.ArthurModel.add_image_attribute") | Wraps add\_attribute for images (see [`ArthurModel.add\_attribute()`](#arthurai.core.models.ArthurModel.add_attribute "arthurai.core.models.ArthurModel.add_attribute")) | -| [`add\_multiclass\_classifier\_output\_attributes`](#arthurai.core.models.ArthurModel.add_multiclass_classifier_output_attributes "arthurai.core.models.ArthurModel.add_multiclass_classifier_output_attributes") | Registers GroundTruth and PredictedValue attributes | -| [`add\_object\_detection\_output\_attributes`](#arthurai.core.models.ArthurModel.add_object_detection_output_attributes "arthurai.core.models.ArthurModel.add_object_detection_output_attributes") | Registers ground truth and predicted value attributes for an object detection model, as well as setting the image class labels. | -| [`add\_regression\_output\_attributes`](#arthurai.core.models.ArthurModel.add_regression_output_attributes "arthurai.core.models.ArthurModel.add_regression_output_attributes") | Registers ground truth attributes and predicted value attributes for regression models. | -| [`archive`](#arthurai.core.models.ArthurModel.archive "arthurai.core.models.ArthurModel.archive") | Archives the model with a DELETE request | -| [`binarize`](#arthurai.core.models.ArthurModel.binarize "arthurai.core.models.ArthurModel.binarize") | Creates a binary class probability based on classes defined in a `ModelType.Multiclass` model | -| [`build`](#arthurai.core.models.ArthurModel.build "arthurai.core.models.ArthurModel.build") | Build an Arthur model from a Pandas DataFrame, inferring the attribute metadata and registering the reference data to be stored with Arthur. | -| [`check\_attr\_is\_bias`](#arthurai.core.models.ArthurModel.check_attr_is_bias "arthurai.core.models.ArthurModel.check_attr_is_bias") | Returns True if and only if the model has an attribute with the given name attr\_name being monitored for bias by Arthur | -| [`check\_has\_bias\_attrs`](#arthurai.core.models.ArthurModel.check_has_bias_attrs "arthurai.core.models.ArthurModel.check_has_bias_attrs") | Returns True if and only if the model has any attributes being monitored for bias by Arthur | -| [`clean\_nones`](#arthurai.core.models.ArthurModel.clean_nones "arthurai.core.models.ArthurModel.clean_nones") | Helper function to filter out None objects from a json or dictionary representation of an object | -| [`close\_batch`](#arthurai.core.models.ArthurModel.close_batch "arthurai.core.models.ArthurModel.close_batch") | Closes the specified batch, optionally can supply the number of inferences that are contained in the batch | -| [`create\_alert\_rule`](#arthurai.core.models.ArthurModel.create_alert_rule "arthurai.core.models.ArthurModel.create_alert_rule") | Creates alert rules for the current model. | -| [`create\_metric`](#arthurai.core.models.ArthurModel.create_metric "arthurai.core.models.ArthurModel.create_metric") | Creates a metric registered to this model and returns the UUID assigned to the newly created metric. | -| [`delete\_explainer`](#arthurai.core.models.ArthurModel.delete_explainer "arthurai.core.models.ArthurModel.delete_explainer") | Spin down the model explainability server | -| [`enable\_bias\_mitigation`](#arthurai.core.models.ArthurModel.enable_bias_mitigation "arthurai.core.models.ArthurModel.enable_bias_mitigation") | Updates the bias mitigation Enrichment to be enabled | -| [`enable\_explainability`](#arthurai.core.models.ArthurModel.enable_explainability "arthurai.core.models.ArthurModel.enable_explainability") | Enable explainability for this model. | -| [`enable\_hotspots`](#arthurai.core.models.ArthurModel.enable_hotspots "arthurai.core.models.ArthurModel.enable_hotspots") | Updates the hotspots Enrichment to be enabled | -| [`explain\_inference`](#arthurai.core.models.ArthurModel.explain_inference "arthurai.core.models.ArthurModel.explain_inference") | Returns feature importance scores for each attribute of stage ModelPipelineInput | -| [`find\_hotspots`](#arthurai.core.models.ArthurModel.find_hotspots "arthurai.core.models.ArthurModel.find_hotspots") | Retrieve hotspots from the model | -| [`from\_dataframe`](#arthurai.core.models.ArthurModel.from_dataframe "arthurai.core.models.ArthurModel.from_dataframe") | Auto-generate attributes based on input data | -| `from\_dict` | -rtype -`TypeVar`(`A`, bound= `DataClassJsonMixin`) - - | -| `from\_json` | -rtype -`TypeVar`(`A`, bound= `DataClassJsonMixin`) - - | -| [`get\_alert\_rules`](#arthurai.core.models.ArthurModel.get_alert_rules "arthurai.core.models.ArthurModel.get_alert_rules") | Returns a paginated list of alert rules registered to this model | -| [`get\_alerts`](#arthurai.core.models.ArthurModel.get_alerts "arthurai.core.models.ArthurModel.get_alerts") | Returns a paginated list of alert registered to this model. | -| [`get\_attribute`](#arthurai.core.models.ArthurModel.get_attribute "arthurai.core.models.ArthurModel.get_attribute") | Retrieves an attribute by name and stage | -| [`get\_attribute\_names`](#arthurai.core.models.ArthurModel.get_attribute_names "arthurai.core.models.ArthurModel.get_attribute_names") | Returns a list of the names of attributes for the specified stage. | -| [`get\_attributes`](#arthurai.core.models.ArthurModel.get_attributes "arthurai.core.models.ArthurModel.get_attributes") | Returns a list of attributes for the specified stage. | -| [`get\_enrichment`](#arthurai.core.models.ArthurModel.get_enrichment "arthurai.core.models.ArthurModel.get_enrichment") | Returns configuration for the specified enrichment. | -| [`get\_enrichments`](#arthurai.core.models.ArthurModel.get_enrichments "arthurai.core.models.ArthurModel.get_enrichments") | Returns configuration for all enrichments. | -| [`get\_image`](#arthurai.core.models.ArthurModel.get_image "arthurai.core.models.ArthurModel.get_image") | Saves the image specified by image\_id to a file | -| [`get\_image\_attribute`](#arthurai.core.models.ArthurModel.get_image_attribute "arthurai.core.models.ArthurModel.get_image_attribute") | Returns the attribute with value\_type=Image for input\_type=Image models | -| [`get\_metrics`](#arthurai.core.models.ArthurModel.get_metrics "arthurai.core.models.ArthurModel.get_metrics") | Retrieves metrics associated with the current model. | -| [`get\_positive\_predicted\_class`](#arthurai.core.models.ArthurModel.get_positive_predicted_class "arthurai.core.models.ArthurModel.get_positive_predicted_class") | Checks if model is a binary classifier. | -| [`infer\_schema`](#arthurai.core.models.ArthurModel.infer_schema "arthurai.core.models.ArthurModel.infer_schema") | Auto-generate attributes based on input data | -| [`model\_is\_saved`](#arthurai.core.models.ArthurModel.model_is_saved "arthurai.core.models.ArthurModel.model_is_saved") | Returns True if and only if the model has been saved to the Arthur platform | -| [`one\_hot\_encode`](#arthurai.core.models.ArthurModel.one_hot_encode "arthurai.core.models.ArthurModel.one_hot_encode") | Creates a one hot encoding of a class label based on classes defined in a `ModelType.Multiclass` model | -| [`query`](#arthurai.core.models.ArthurModel.query "arthurai.core.models.ArthurModel.query") | Execute query against the model's inferences. | -| [`remove\_attribute`](#arthurai.core.models.ArthurModel.remove_attribute "arthurai.core.models.ArthurModel.remove_attribute") | Removes an already-made ArthurAttribute from the model. | -| [`rename\_attribute`](#arthurai.core.models.ArthurModel.rename_attribute "arthurai.core.models.ArthurModel.rename_attribute") | Renames an attribute by name and stage | -| [`review`](#arthurai.core.models.ArthurModel.review "arthurai.core.models.ArthurModel.review") | Prints a summary of the properties of all attributes in the model. | -| [`save`](#arthurai.core.models.ArthurModel.save "arthurai.core.models.ArthurModel.save") | Check and save this model | -| `schema` | -rtype -`SchemaF`[`TypeVar`(`A`)] - - | -| [`send\_batch\_ground\_truths`](#arthurai.core.models.ArthurModel.send_batch_ground_truths "arthurai.core.models.ArthurModel.send_batch_ground_truths") | -Deprecated since version 3.10.0. - | -| [`send\_batch\_inferences`](#arthurai.core.models.ArthurModel.send_batch_inferences "arthurai.core.models.ArthurModel.send_batch_inferences") | Send many inferences at once | -| [`send\_bulk\_ground\_truths`](#arthurai.core.models.ArthurModel.send_bulk_ground_truths "arthurai.core.models.ArthurModel.send_bulk_ground_truths") | Uploads a large batch of ground truth values to Arthur | -| [`send\_bulk\_inferences`](#arthurai.core.models.ArthurModel.send_bulk_inferences "arthurai.core.models.ArthurModel.send_bulk_inferences") | Uploads a large batch of inferences to Arthur | -| [`send\_inference`](#arthurai.core.models.ArthurModel.send_inference "arthurai.core.models.ArthurModel.send_inference") | -Deprecated since version 3.20.0. - | -| [`send\_inferences`](#arthurai.core.models.ArthurModel.send_inferences "arthurai.core.models.ArthurModel.send_inferences") | Send inferences to the Arthur API. | -| [`set\_attribute\_as\_sensitive`](#arthurai.core.models.ArthurModel.set_attribute_as_sensitive "arthurai.core.models.ArthurModel.set_attribute_as_sensitive") | Sets the passed-in attribute to be sensitive by setting attr.monitor\_for\_bias = True. | -| [`set\_attribute\_labels`](#arthurai.core.models.ArthurModel.set_attribute_labels "arthurai.core.models.ArthurModel.set_attribute_labels") | Sets labels for individual categories of a specific attribute | -| [`set\_predict\_function\_input\_order`](#arthurai.core.models.ArthurModel.set_predict_function_input_order "arthurai.core.models.ArthurModel.set_predict_function_input_order") | Sets the expected order of attributes used by the prediction function. | -| [`set\_reference\_data`](#arthurai.core.models.ArthurModel.set_reference_data "arthurai.core.models.ArthurModel.set_reference_data") | Validates and sets the reference data for the given stage to the provided data. | -| [`swap\_predicted\_attribute\_positions`](#arthurai.core.models.ArthurModel.swap_predicted_attribute_positions "arthurai.core.models.ArthurModel.swap_predicted_attribute_positions") | Swap the position of the model's two predicted attributes | -| [`to\_dict`](#arthurai.core.models.ArthurModel.to_dict "arthurai.core.models.ArthurModel.to_dict") | Creates a dictionary representation of this object | -| [`to\_json`](#arthurai.core.models.ArthurModel.to_json "arthurai.core.models.ArthurModel.to_json") | Creates a json representation of this object | -| [`update`](#arthurai.core.models.ArthurModel.update "arthurai.core.models.ArthurModel.update") | Update the current model object in the Arthur platform | -| [`update\_alert`](#arthurai.core.models.ArthurModel.update_alert "arthurai.core.models.ArthurModel.update_alert") | Updates alert to have a particular status. | -| [`update\_alert\_rule`](#arthurai.core.models.ArthurModel.update_alert_rule "arthurai.core.models.ArthurModel.update_alert_rule") | Updates alert rule fields included in the alert\_rule object for the specified alert rule id. | -| [`update\_enrichment`](#arthurai.core.models.ArthurModel.update_enrichment "arthurai.core.models.ArthurModel.update_enrichment") | Update the configuration for a single enrichment | -| [`update\_enrichments`](#arthurai.core.models.ArthurModel.update_enrichments "arthurai.core.models.ArthurModel.update_enrichments") | Update the configuration for 1 or more enrichments. | -| [`update\_inference\_ground\_truths`](#arthurai.core.models.ArthurModel.update_inference_ground_truths "arthurai.core.models.ArthurModel.update_inference_ground_truths") | Updates inferences with the supplied ground truth values | - - - -Attributes - - - - - - - - -| `archived` | | -| `attributes` | | -| `classifier\_threshold` | | -| `client` | | -| `created\_at` | | -| `dataclass\_json\_config` | | -| `description` | | -| `display\_name` | | -| `expected\_throughput\_gb\_per\_day` | | -| `explainability` | | -| [`ground\_truth\_type`](#arthurai.core.models.ArthurModel.ground_truth_type "arthurai.core.models.ArthurModel.ground_truth_type") | Returns GroundTruthClass if Arthur performed one-hot encoding in the creation of this model's current ground truth attribute. | -| `id` | | -| `image\_class\_labels` | | -| `is\_batch` | | -| `model\_group\_id` | | -| `pixel\_height` | | -| `pixel\_width` | | -| `reference\_dataframe` | | -| `tags` | | -| `text\_delimiter` | | -| `updated\_at` | | -| `version\_label` | | -| `version\_sequence\_num` | | -| `partner\_model\_id` | | -| `input\_type` | | -| `output\_type` | | - - - - - -add\_attribute(*name=None*, *value\_type=None*, *stage=None*, *label=None*, *position=None*, *categorical=False*, *min\_range=None*, *max\_range=None*, *monitor\_for\_bias=False*, *categories=None*, *bins=None*, *is\_unique=False*, *is\_positive\_predicted\_attribute=False*, *attribute\_link=None*, *arthur\_attribute=None*, *gt\_pred\_attrs\_map=None*)[#](#arthurai.core.models.ArthurModel.add_attribute "Permalink to this definition") -Adds a new attribute of stage ModelPipelineInput or NonInputData to the model. - - -For an introduction to attributes and stages, see - - -If you have built your model using arthur\_model.build(), your model attributes may already be inferred and you -do not need to add them with this function. - - -Formatting requirement: attribute names must contain only letters, numbers, and underscores, and cannot begin -with a number. - - - -``` -from arthurai.common.constants import Stage, ValueType - -# adds a float input attribute directly to the model -arthur\_model.add\_attribute( - name="attribute\_name", - value\_type=ValueType.Float, - stage=Stage.ModelPipelineInput -) - -``` - - - -Parameters -* **attribute\_link** (`Optional`[`str`]) – Only applicable for GroundTruth or PredictedValue staged attributes. -If stage is equal to GroundTruth, this represents the associated PredictedValue attribute and vice versa -* **is\_positive\_predicted\_attribute** (`bool`) – Only applicable for PredictedValue attributes on a Binary -Classification model. Should be set to True on the positive predicted value attribute. -* **is\_unique** (`bool`) – Boolean value used to signal if the values of this attribute are unique. -* **bins** (`Optional`[`List`[`Union`[`int`, `float`, [`AttributeBin`](arthurai.core.attributes.AttributeBin.html#arthurai.core.attributes.AttributeBin "arthurai.core.attributes.AttributeBin")]]]) – List of bin cut-offs used to discretize continuous attributes. Use None as an open ended value. -`[None, 18, 65, None]` represents the three following bins: `value < 18, 18 < value < 65, value > 65` -* **monitor\_for\_bias** (`bool`) – boolean value set to True if the attribute should be monitored for bias -* **max\_range** (`Union`[`int`, `float`, `None`]) – Max value for a continuous attribute -* **min\_range** (`Union`[`int`, `float`, `None`]) – Min value for a continuous attribute -* **categorical** (`bool`) – Boolean value set to True if the attribute has categorical values. -* **position** (`Optional`[`int`]) – The array position of attribute within the stage. Required in the PREDICT\_FUNCTION\_INPUT stage. -* **label** (`Optional`[`str`]) – Label for attribute. If attribute has an encoded name, a more readable label can be set. -* **stage** (`Optional`[[`Stage`](arthurai.common.constants.Stage.html#arthurai.common.constants.Stage "arthurai.common.constants.Stage")]) – [`arthurai.common.constants.Stage`](arthurai.common.constants.Stage.html#arthurai.common.constants.Stage "arthurai.common.constants.Stage") of this attribute in the model pipeline -* **value\_type** (`Optional`[[`ValueType`](arthurai.common.constants.ValueType.html#arthurai.common.constants.ValueType "arthurai.common.constants.ValueType")]) – [`arthurai.common.constants.ValueType`](arthurai.common.constants.ValueType.html#arthurai.common.constants.ValueType "arthurai.common.constants.ValueType") associated with this attributes values -* **name** (`Optional`[`str`]) – Name of the attribute. Attribute names can only contain alpha-numeric characters and underscores -and cannot start with a number. -* **categories** (`Optional`[`List`[`Union`[`str`, [`AttributeCategory`](arthurai.core.attributes.AttributeCategory.html#arthurai.core.attributes.AttributeCategory "arthurai.core.attributes.AttributeCategory")]]]) – [Only for Categorical Attributes] If the attribute is categorical, this will contain the -attribute’s categories. It is required only if the categorical flag is set to true. -* **arthur\_attribute** (`Optional`[[`ArthurAttribute`](arthurai.core.attributes.ArthurAttribute.html#arthurai.core.attributes.ArthurAttribute "arthurai.core.attributes.ArthurAttribute")]) – Optional ArthurAttribute to add to the model -* **gt\_pred\_attrs\_map** (`Optional`[`Dict`]) – - - -Deprecated since version version: 2.0.0 - - -Use ArthurModel.add\_[model\_type]\_output\_attributes() instead - - - -Return type -`List`[[`ArthurAttribute`](arthurai.core.attributes.ArthurAttribute.html#arthurai.core.attributes.ArthurAttribute "arthurai.core.attributes.ArthurAttribute")] - - - -Returns -ArthurAttribute Object - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - - - - - -add\_binary\_classifier\_output\_attributes(*positive\_predicted\_attr*, *pred\_to\_ground\_truth\_map*, *threshold=0.5*)[#](#arthurai.core.models.ArthurModel.add_binary_classifier_output_attributes "Permalink to this definition") -Registers GroundTruth and PredictedValue attributes and their thresholds - - -For an introduction to attributes and stages, -see - - -This function will create a predicted value and ground truth attribute for each mapping specified in -pred\_to\_ground\_truth\_map. - - - -``` -# map PredictedValue attributes to their corresponding GroundTruth attributes -PRED\_TO\_GROUND\_TRUTH\_MAP = {'pred\_0' : 'gt\_0', - 'pred\_1' : 'gt\_1'} - -# add the ground truth and predicted attributes to the model -# specifying that the `pred\_1` attribute is the -# positive predicted attribute, which means it corresponds to the -# probability that the binary target attribute is 1 -arthur\_model.add\_binary\_classifier\_output\_attributes(positive\_predicted\_attr='pred\_1', - pred\_to\_ground\_truth\_map=PRED\_TO\_GROUND\_TRUTH\_MAP) - -``` - - -For binary models, GroundTruth is always an integer, and PredictedAttribute is always a float. -Additionally, PredictedAttribute is expected to be a probability (e.g. the output of a scikit-learn -model’s predict\_proba method), rather than a classification to 0/1. - - -This assumes that separate columns for predicted values and ground truth values have already been created, -and that they have both been broken into two separate (pseudo-onehot) columns: for example, the column -ground\_truth\_label becomes ground\_truth\_label=0 and ground\_truth\_label=1, and the column pred\_prob -becomes pred\_prob=0 and pred\_prob=1. The pandas function pd.get\_dummies() can be useful for reformatting -the ground truth column, but be sure that the datatype is specified correctly as an int. - - - -Parameters -* **positive\_predicted\_attr** (`str`) – string name of the predicted attribute to register as the positive predicted attribute -* **pred\_to\_ground\_truth\_map** (`Dict`[`str`, `str`]) – Map of predicted value attributes to their corresponding ground truth attribute names. -The names provided in the dictionary will be used to register the one-hot encoded -version of the attributes. For example: {‘pred\_0’: ‘gt\_0’, ‘pred\_1’: ‘gt\_1’}, -Ensure the ordering of items in this dictionary is an accurate -representation of how model predictions (probability vectors) will be generated. -* **threshold** (`float`) – Threshold to use for the classifier model, defaults to 0.5 - - - -Return type -`Dict`[`str`, [`ArthurAttribute`](arthurai.core.attributes.ArthurAttribute.html#arthurai.core.attributes.ArthurAttribute "arthurai.core.attributes.ArthurAttribute")] - - - -Returns -Mapping of added attributes string name -> ArthurAttribute Object - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - - - - - -add\_classifier\_output\_attributes\_gtclass(*pred\_to\_ground\_truth\_class\_map*, *ground\_truth\_column*, *data*, *positive\_predicted\_attr=None*)[#](#arthurai.core.models.ArthurModel.add_classifier_output_attributes_gtclass "Permalink to this definition") -Registers ground truth and predicted value attributes for classification models - - -Registers a GroundTruthClass attribute. In addition, registers a predicted value attribute for each of the -model’s predicted values. - - -For an introduction to attributes and stages, -see - - -Create a predicted value attribute for each key in pred\_to\_ground\_truth\_class\_map and a ground truth class -attribute for the ground\_truth\_column. - - - -``` -# Map PredictedValue attribute to its corresponding GroundTruth attribute value. -# This tells Arthur that the `pred\_survived` column represents -# the probability that the ground truth column has the value 1 -PRED\_TO\_GROUND\_TRUTH\_MAP = { - "pred\_value": 1 -} - -# Add the ground truth and predicted attributes to the model, -# specifying which attribute represents ground truth and -# which attribute represents the predicted value. -arthur\_model.add\_classifier\_output\_attributes\_gtclass( - positive\_predicted\_attr = 'pred\_value', - pred\_to\_ground\_truth\_class\_map = PRED\_TO\_GROUND\_TRUTH\_MAP, - ground\_truth\_column = 'gt\_column' -) - -``` - - - -Parameters -* **pred\_to\_ground\_truth\_class\_map** (`Dict`[`str`, `Any`]) – map from predicted column names to corresponding ground truth values -* **ground\_truth\_column** (`str`) – column name of column in data holding the ground truth values -* **data** (`DataFrame`) – DataFrame containing ground truth column data -* **positive\_predicted\_attr** (`Optional`[`str`]) – string name of the predicted attribute to register as the positive predicted -attribute, if binary classification - - - - -return: Mapping of added attributes string name -> ArthurAttribute Object - - - -Return type -`Dict`[`str`, [`ArthurAttribute`](arthurai.core.attributes.ArthurAttribute.html#arthurai.core.attributes.ArthurAttribute "arthurai.core.attributes.ArthurAttribute")] - - - - - - - -add\_image\_attribute(*name=None*)[#](#arthurai.core.models.ArthurModel.add_image_attribute "Permalink to this definition") -Wraps add\_attribute for images (see [`ArthurModel.add\_attribute()`](#arthurai.core.models.ArthurModel.add_attribute "arthurai.core.models.ArthurModel.add_attribute")) - - -Automatically sets the stage as ModelPipelineInput - - - -Return type -`List`[[`ArthurAttribute`](arthurai.core.attributes.ArthurAttribute.html#arthurai.core.attributes.ArthurAttribute "arthurai.core.attributes.ArthurAttribute")] - - - -Returns -ArthurAttribute Object - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - - - - - -add\_multiclass\_classifier\_output\_attributes(*pred\_to\_ground\_truth\_map*)[#](#arthurai.core.models.ArthurModel.add_multiclass_classifier_output_attributes "Permalink to this definition") -Registers GroundTruth and PredictedValue attributes - - -For an introduction to attributes and stages, -see - - -This function will create a predicted value and -ground truth attribute for each mapping specified in pred\_to\_ground\_truth\_map. - - - -``` -# map PredictedValue attributes to their corresponding GroundTruth attributes -PRED\_TO\_GROUND\_TRUTH\_MAP = { - "dog": "dog\_gt", - "cat": "cat\_gt", - "horse": "horse\_gt" -} - -# add the ground truth and predicted attributes to the model -arthur\_model.add\_multiclass\_classifier\_output\_attributes( - pred\_to\_ground\_truth\_map = PRED\_TO\_GROUND\_TRUTH\_MAP -) - -``` - - - -Parameters -**pred\_to\_ground\_truth\_map** (`Dict`[`str`, `str`]) – Map of predicted value attributes to their corresponding ground truth attribute names. -The names provided in the dictionary will be used to register the one-hot encoded -version of the attributes. Ensure the ordering of items in this dictionary is an accurate -representation of how model predictions (probability vectors) will be generated. - - - -Return type -`Dict`[`str`, [`ArthurAttribute`](arthurai.core.attributes.ArthurAttribute.html#arthurai.core.attributes.ArthurAttribute "arthurai.core.attributes.ArthurAttribute")] - - - -Returns -Mapping of added attributes string name -> ArthurAttribute Object - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - - - - - -add\_object\_detection\_output\_attributes(*predicted\_attr\_name*, *gt\_attr\_name*, *image\_class\_labels*)[#](#arthurai.core.models.ArthurModel.add_object_detection_output_attributes "Permalink to this definition") -Registers ground truth and predicted value attributes for an object detection model, as well as -setting the image class labels. - - -For a guide to onboarding object detection models, -see - - -This function will create a predicted value attribute and ground truth attribute using the names provided, -giving each a value type of Bounding Box. Image class labels are also set on the model object. The index -of each label in the list should correspond to a class\_id the model outputs. - - -Ex: image\_class\_labels = [‘cat’, ‘dog’, ‘person’] -So a bounding box with class\_id of 0 would have label ‘cat’, -class\_id of 1 would have label ‘dog’, and class\_id of 2 would have label ‘person’ - - - -``` -predicted\_attribute\_name = "objects\_detected" -ground\_truth\_attribute\_name = "label" -class\_labels = ['cat', 'dog', 'person'] - -arthur\_model.add\_object\_detection\_output\_attributes( - predicted\_attribute\_name, - ground\_truth\_attribute\_name, - class\_labels) - -``` - - - -Parameters -* **predicted\_attr\_name** (`str`) – The name of the predicted value attribute -* **gt\_attr\_name** (`str`) – The name of the ground truth attribute -* **image\_class\_labels** (`List`[`str`]) – The labels for each class the model can predict, ordered by their class\_id - - - -Return type -`Dict`[`str`, [`ArthurAttribute`](arthurai.core.attributes.ArthurAttribute.html#arthurai.core.attributes.ArthurAttribute "arthurai.core.attributes.ArthurAttribute")] - - - -Returns -Mapping of added attributes string name -> ArthurAttribute Object - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - - - - - -add\_regression\_output\_attributes(*pred\_to\_ground\_truth\_map*, *value\_type*, *data=None*)[#](#arthurai.core.models.ArthurModel.add_regression_output_attributes "Permalink to this definition") -Registers ground truth attributes and predicted value attributes for regression models. - - -For an introduction to attributes and stages, see - - - -``` -from arthurai.common.constants import ValueType - -# map PredictedValue attributes to their corresponding GroundTruth attributes -PRED\_TO\_GROUND\_TRUTH\_MAP = { - "pred\_value": "gt\_value", -} - -# add the ground truth and predicted attributes to the model -arthur\_model.add\_regression\_output\_attributes( - pred\_to\_ground\_truth\_map = PRED\_TO\_GROUND\_TRUTH\_MAP, - value\_type = ValueType.Float -) - -``` - - - -Parameters -* **pred\_to\_ground\_truth\_map** (`Dict`[`str`, `str`]) – Map of predicted value attributes to their corresponding ground truth attribute names. -The names provided in the dictionary will be used to register the one-hot encoded -version of the attributes. -* **value\_type** ([`ValueType`](arthurai.common.constants.ValueType.html#arthurai.common.constants.ValueType "arthurai.common.constants.ValueType")) – Value type of regression model output attribute (usually either ValueType.Integer or ValueType.Float) -* **data** (`Optional`[`DataFrame`]) – a reference DataFrame to build the model from. This is optional since it is currently only used -to calculate the min\_range and max\_range values of the predicted + ground truth attributes. If data -is not passed, min\_range and max\_range are not set in the attributes - - - -Return type -`Dict`[`str`, [`ArthurAttribute`](arthurai.core.attributes.ArthurAttribute.html#arthurai.core.attributes.ArthurAttribute "arthurai.core.attributes.ArthurAttribute")] - - - -Returns -Mapping of added attributes string name -> ArthurAttribute Object - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - - - - - -archive()[#](#arthurai.core.models.ArthurModel.archive "Permalink to this definition") -Archives the model with a DELETE request - - - -Returns -the server response - - - -Raises -**Exception** – the model has no ID, or the model has not been archived - - - -Permissions -model delete - - - - - - - -binarize(*attribute\_value*)[#](#arthurai.core.models.ArthurModel.binarize "Permalink to this definition") -Creates a binary class probability based on classes defined in a `ModelType.Multiclass` model - - -This function is only valid for models with two PredictedValue attributes -which correspond to the positive and negative probabilities of a binary classifier - - - -``` -# creates a binary class probability -# evaluating the model's two predicted values against this value -model.binarize({'ground\_truth\_column' : value}) - -``` - - - -Parameters -**attribute\_value** – a mapping of the name of a predicted value attribute to its value - - - -Returns -A two-value dictionary with probabilities for both predicted classes. - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - - - - - -build(*data*, *pred\_to\_ground\_truth\_map*, *positive\_predicted\_attr=None*, *non\_input\_columns=None*, *ground\_truth\_column=None*, *set\_reference\_data=True*)[#](#arthurai.core.models.ArthurModel.build "Permalink to this definition") -Build an Arthur model from a Pandas DataFrame, -inferring the attribute metadata and registering the reference data to be stored with Arthur. - - -For a quickstart guide to building an ArthurModel, see - - -The pred\_to\_ground\_truth\_map parameter tells Arthur how the predicted value attributes -relate to the ground truth attributes of your model. - - -This dictionary can be formatted two different ways: - - -1. a prediction column name to ground truth column name mapping passed to pred\_to\_ground\_truth\_map - - - -``` -# map PredictedValue attribute to its corresponding GroundTruth attribute -# this tells Arthur that the `pred\_value` column represents -# the predicted value corresponding to the -# ground truth values in the `gt\_column` column -PRED\_TO\_GROUND\_TRUTH\_MAP = {'pred\_value' : 'gt\_column'} - -arthur\_model.build(reference\_df, - pred\_to\_ground\_truth\_map=PRED\_TO\_GROUND\_TRUTH\_MAP) - -``` - - -2. a prediction column name to ground truth class value mapping passed to pred\_to\_ground\_truth\_map,plus the name of the column holding the ground truth class values passed to ground\_truth\_column - - - -``` -# map PredictedValue attribute to its corresponding GroundTruth attribute value -# this tells Arthur that the `pred\_value` column represents -# the probability that the GroundTruth attribute `gt\_column` = 1 -# which we indicate in arthur\_model.build() with the `ground\_truth\_column` parameter -PRED\_TO\_GROUND\_TRUTH\_MAP = {'pred\_value' : 1} - -arthur\_model.build(reference\_df, - ground\_truth\_column="gt\_column", - pred\_to\_ground\_truth\_map=PRED\_TO\_GROUND\_TRUTH\_MAP) - -``` - - -Note that this function will remove any previously existing attributes. Combines calls to -[`ArthurModel.infer\_schema()`](#arthurai.core.models.ArthurModel.infer_schema "arthurai.core.models.ArthurModel.infer_schema") and (if set\_reference\_data is True) -[`ArthurModel.set\_reference\_data()`](#arthurai.core.models.ArthurModel.set_reference_data "arthurai.core.models.ArthurModel.set_reference_data") - - - -Parameters -* **data** (`DataFrame`) – a reference DataFrame to build the model from -* **pred\_to\_ground\_truth\_map** (`Dict`[`str`, `Any`]) – a mapping from predicted column names to their corresponding ground truth -column names, or ground truth values in ground\_truth\_column -* **positive\_predicted\_attr** (`Optional`[`str`]) – name of the predicted attribute to register as the positive predicted -attribute -* **non\_input\_columns** (`Optional`[`List`[`str`]]) – list of columns that contain auxiliary data not directly passed into the model -* **set\_reference\_data** – if True, register the provided DataFrame as the model’s reference dataset -* **ground\_truth\_column** (`Optional`[`str`]) – a single column name containing ground truth labels. -must be used with pred to ground truth class map - - - -Return type -`DataFrame` - - - -Returns -a DataFrame summarizing the inferred types - - - - - - - -check\_attr\_is\_bias(*attr\_name*)[#](#arthurai.core.models.ArthurModel.check_attr_is_bias "Permalink to this definition") -Returns True if and only if the model has an attribute with the given name attr\_name being monitored for bias by -Arthur - - - - - -check\_has\_bias\_attrs()[#](#arthurai.core.models.ArthurModel.check_has_bias_attrs "Permalink to this definition") -Returns True if and only if the model has any attributes being monitored for bias by Arthur - - - - - -*static* clean\_nones(*d*)[#](#arthurai.core.models.ArthurModel.clean_nones "Permalink to this definition") -Helper function to filter out None objects from a json or dictionary representation of an object - - - -Parameters -**d** – a Dictionary or Json representation of an ArthurBaseJsonDataclass object - - - -Returns -Dictionary of the object with all None components removed - - - - - - - -close\_batch(*batch\_id*, *num\_inferences=None*)[#](#arthurai.core.models.ArthurModel.close_batch "Permalink to this definition") -Closes the specified batch, optionally can supply the number of inferences that are contained in the batch - - - -Parameters -* **batch\_id** (`str`) – String batch\_id associated with the batch that will be closed -* **num\_inferences** (`Optional`[`int`]) – Optional number of inferences that are contained in the batch - - - -Return type -`Dict` - - - -Returns -Response of the batch close rest call - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - -Permissions -raw\_data write - - - - - - - -create\_alert\_rule(*metric\_id*, *bound*, *threshold*, *severity*, *name=None*, *lookback\_period=None*, *subsequent\_alert\_wait\_time=None*)[#](#arthurai.core.models.ArthurModel.create_alert_rule "Permalink to this definition") -Creates alert rules for the current model. - - -For an introduction to alerts, see - - -For a guide to configuring alerts, see - - - -Parameters -* **metric\_id** (`str`) – unique id (UUID) of the metric to use to create an alert rule. -* **name** (`Optional`[`str`]) – A name for the alert rule, a default will be generated if this is not supplied. -* **bound** ([`AlertRuleBound`](arthurai.core.alerts.AlertRuleBound.html#arthurai.core.alerts.AlertRuleBound "arthurai.core.alerts.AlertRuleBound")) – Whether the alert is triggered crossing the threshold from above or below. Either AlertRuleBound.Upper or AlertRuleBound.Lower -* **threshold** (`Union`[`int`, `float`]) – Threshold value of the alert rule. When the metric crosses this threshold, the alert is triggered. -* **severity** ([`AlertRuleSeverity`](arthurai.core.alerts.AlertRuleSeverity.html#arthurai.core.alerts.AlertRuleSeverity "arthurai.core.alerts.AlertRuleSeverity")) – AlertRuleSeverity of the alert which gets triggered when the metric violates the threshold of -the alert rule. -* **lookback\_period** (`Union`[`int`, `float`, `None`]) – The lookback time or “window length” in minutes to use when calculating the alert rule -metric. For example, a lookback period of 5 minutes for an alert rule on average -prediction will calculate average prediction for the past 5 minutes in a rolling window -format. This will default to 5 minutes -* **subsequent\_alert\_wait\_time** (`Union`[`int`, `float`, `None`]) – If metric continues to pass threshold this is the time in minutes to wait -before triggering another alert. This defaults to 0. This does not need to -be set for batch alerts. - - - -Return type -[`AlertRule`](arthurai.core.alerts.AlertRule.html#arthurai.core.alerts.AlertRule "arthurai.core.alerts.AlertRule") - - - -Returns -the created alert rule - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - -Permissions -alert\_rule write - - - - - - - -create\_metric(*name*, *query*, *is\_data\_drift=False*)[#](#arthurai.core.models.ArthurModel.create_metric "Permalink to this definition") -Creates a metric registered to this model and returns the UUID assigned to the newly created metric. - - -This metric can be used to create alert rules on. - - -For an introduction to creating metrics for alert rules, -see - - - -Parameters -* **name** (`str`) – Name of the metric to create. -* **query** (`Dict`[`str`, `Any`]) – Query which makes up the metric -* **is\_data\_drift** (`bool`) – Boolean to signal whether this query is a data drift metric or not. - - - -Return type -`str` - - - -Returns -UUID of the newly created metric - - - -Permissions -metric\_query write - - - - - - - -delete\_explainer()[#](#arthurai.core.models.ArthurModel.delete_explainer "Permalink to this definition") -Spin down the model explainability server - - -After calling this function, explainability will have to be re-enabled -if you want to compute feature importance scores for your model. - - - -Return type -`None` - - - -Returns -the server response - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - -Permissions -enrichment\_config write - - - - - - - -enable\_bias\_mitigation()[#](#arthurai.core.models.ArthurModel.enable_bias_mitigation "Permalink to this definition") -Updates the bias mitigation Enrichment to be enabled - - - -See also - - -This convenience function wraps [`ArthurModel.update\_enrichment()`](#arthurai.core.models.ArthurModel.update_enrichment "arthurai.core.models.ArthurModel.update_enrichment") - - - - -Permissions -enrichment\_config write - - - - - - - -enable\_explainability(*df=None*, *project\_directory=None*, *user\_predict\_function\_import\_path=None*, *streaming\_explainability\_enabled=True*, *requirements\_file='requirements.txt'*, *python\_version=None*, *sdk\_version='3.20.2'*, *model\_server\_num\_cpu=None*, *model\_server\_memory=None*, *model\_server\_max\_replicas=None*, *inference\_consumer\_num\_cpu=None*, *inference\_consumer\_memory=None*, *inference\_consumer\_thread\_pool\_size=None*, *inference\_consumer\_score\_percent=None*, *explanation\_nsamples=None*, *explanation\_algo=None*, *ignore\_dirs=None*)[#](#arthurai.core.models.ArthurModel.enable_explainability "Permalink to this definition") -Enable explainability for this model. - - - -Parameters -* **df** (`Optional`[`DataFrame`]) – a dataframe containing the `Stage.ModelPipelineInput` values for this model. Required -for non-image models. -* **project\_directory** (`Optional`[`str`]) – the name of the directory containing the model source code. Required. -* **user\_predict\_function\_import\_path** (`Optional`[`str`]) – the name of the file that implements or wraps the predict function. -Required. -* **streaming\_explainability\_enabled** (`Optional`[`bool`]) – Defaults to true. flag to turn on streaming explanations which will -explain every inference sent to the platform. If false, explanations will need to be manually generated for -each inference via the Arthur API. Set to false if worried about compute cost. -* **requirements\_file** (`str`) – the name of the file that contains the pip requirements (default: requirements.txt) -* **python\_version** (`Optional`[`str`]) – the python version (default: sys.version). Should be in the form of . -* **sdk\_version** (`str`) – the version of the sdk to initialize the model servier with -* **model\_server\_num\_cpu** (`Optional`[`str`]) – string number of CPUs to provide to model server docker container. If not -provided, 1 CPU is used. Specified in the format of Kubernetes CPU resources. ‘1’, ‘1.5’, ‘100m’, etc. -* **model\_server\_memory** (`Optional`[`str`]) – The amount of memory to allocate to the model server docker container. Provided -in the format of kubernetes memory resources “1Gi” or “500Mi” (default: None). -* **model\_server\_max\_replicas** (`Optional`[`int`]) – The max number of model servers to create -* **inference\_consumer\_num\_cpu** (`Optional`[`str`]) – string number of CPUs to provide to inference consumer docker container. -If not provided, 1 CPU is used. Specified in the format of Kubernetes CPU resources. ‘1’, ‘1.5’, ‘100m’, -etc. (default: ‘1’) -* **inference\_consumer\_memory** (`Optional`[`str`]) – The amount of memory to allocate to the model server docker container. -Provided in the format of kubernetes memory resources “1Gi” or “500Mi” (default: ‘1G’). -* **inference\_consumer\_thread\_pool\_size** (`Optional`[`int`]) – The number of inference consumer workers, this determines how -many requests to the model server can be made in parallel. Default of 5. If increasing, CPU should be -increased as well. -* **inference\_consumer\_score\_percent** (`Optional`[`float`]) – What percent of inferences should get scored. Should be a value -between 0.0 and 1.0. Default 1.0 (everything is scored) -* **explanation\_nsamples** (`Optional`[`int`]) – number of predictions to use in the explanation. For SHAP and LIME, the default is -2000. (default: None) -* **explanation\_algo** (`Optional`[`str`]) – the algorithm to use for explaining inferences. Valid values are ‘lime’ and ‘shap’. -Defaults to ‘lime’. -* **ignore\_dirs** (`Optional`[`List`[`str`]]) – a list of directories within the project\_directory that you do not want to include when -uploading the model. Path is relative to project\_directory. - - - -Return type -`Dict`[`str`, `Any`] - - - -Returns -response content - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - -Permissions -enrichment\_config write - - - - - - - -enable\_hotspots()[#](#arthurai.core.models.ArthurModel.enable_hotspots "Permalink to this definition") -Updates the hotspots Enrichment to be enabled - - - -See also - - -This convenience function wraps [`ArthurModel.update\_enrichment()`](#arthurai.core.models.ArthurModel.update_enrichment "arthurai.core.models.ArthurModel.update_enrichment") - - - - -Permissions -enrichment\_config write - - - - - - - -explain\_inference(*partner\_inference\_id*, *algorithm='lime'*, *page=1*, *page\_size=500*, *n\_samples=None*, *sort=None*)[#](#arthurai.core.models.ArthurModel.explain_inference "Permalink to this definition") -Returns feature importance scores for each attribute of stage ModelPipelineInput - - - -Parameters -* **partner\_inference\_id** (`str`) – the ID attached to the inference -* **algorithm** (`str`) – the explanation algorithm (‘lime’ or ‘shap’) used to generate the feature importance scores -* **page** (`int`) – the number of batches to split the results into -* **page\_size** (`int`) – the maximum number of inferences in each batch if returning inferences in batches -* **n\_samples** (`Optional`[`int`]) – # local perturbations for explanation (if None, uses default from lime or shap) -* **sort** (`Optional`[`str`]) – option for the ordering of returned explanations - - - -Return type -`Dict`[`str`, `Any`] - - - -Returns -Upload status response in the following format: - - - -``` -{ - "explanation": [ - { - "algorithm": "shap", - "predicted\_attribute\_name": "class\_a", - "importance\_scores": [ - { - "attribute\_name": "feature\_a", - "explanation\_value": 0.12, - "tokens": [ - { - "token": "dog", - "position": 0, - "explanation\_value": 0.48 - } - ] - } - ] - } - ], - "expected\_value": [ - { - "predicted\_attribute\_name": "feature\_a", - "expected\_value": 0.12 - } - ] -} - -``` - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - -Permissions -raw\_data read - - - - - - - -find\_hotspots(*metric='accuracy'*, *threshold=0.5*, *batch\_id=None*, *date=None*, *ref\_set\_id=None*)[#](#arthurai.core.models.ArthurModel.find_hotspots "Permalink to this definition") -Retrieve hotspots from the model - - -For an introduction to the hotspots Enrichment, -see - - - -Parameters -* **metric** ([`AccuracyMetric`](arthurai.common.constants.AccuracyMetric.html#arthurai.common.constants.AccuracyMetric "arthurai.common.constants.AccuracyMetric")) – accuracy metric used to filter hotspots tree by, defaults to “accuracy” -* **threshold** (`float`) – threshold for of performance metric used for filtering hotspots, defaults to 0.5 -* **batch\_id** (`Optional`[`str`]) – string id for the batch to find hotspots in, defaults to None -* **date** (`Optional`[`str`]) – string used to define date, defaults to None -* **ref\_set\_id** (`Optional`[`str`]) – string id for the reference set to find hotspots in, defaults to None - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - -Permissions -raw\_data read - - - -Return type -`Dict`[`str`, `Any`] - - - - - - - -from\_dataframe(*data*, *stage*)[#](#arthurai.core.models.ArthurModel.from_dataframe "Permalink to this definition") -Auto-generate attributes based on input data - - - -Deprecated since version 3.12.0: Please use [`ArthurModel.infer\_schema()`](#arthurai.core.models.ArthurModel.infer_schema "arthurai.core.models.ArthurModel.infer_schema") to add fields from a DataFrame to a model. - - - -Note that this does *not* automatically set reference -data; this method only reads the passed-in data, and then infers attribute names, types, etc. and sets them up -within the ArthurModel. - - - -See also - - -To also set your data as reference data, see [`ArthurModel.build()`](#arthurai.core.models.ArthurModel.build "arthurai.core.models.ArthurModel.build") - - - -For PredictedValue and GroundTruth stages, use the correct add\_\_output\_attributes() method instead. - - - -Parameters -* **data** (`Union`[`DataFrame`, `Series`]) – the data to infer attribute metadata from -* **stage** ([`Stage`](arthurai.common.constants.Stage.html#arthurai.common.constants.Stage "arthurai.common.constants.Stage")) – [`Stage`](arthurai.common.constants.Stage.html#arthurai.common.constants.Stage "arthurai.common.constants.Stage") of the data - - - -Return type -`None` - - - -Returns -a DataFrame summarizing the inferred types - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - - - - - -get\_alert\_rules(*page=1*, *page\_size=20*)[#](#arthurai.core.models.ArthurModel.get_alert_rules "Permalink to this definition") -Returns a paginated list of alert rules registered to this model - - -For an introduction to alerts, see - - -For a guide to configuring alerts, see - - - -Parameters -* **page** (`int`) – page of alert rules to retrieve, defaults to 1 -* **page\_size** (`int`) – number of alert rules to return per page, defaults to 20 - - - -Return type -`List`[[`AlertRule`](arthurai.core.alerts.AlertRule.html#arthurai.core.alerts.AlertRule "arthurai.core.alerts.AlertRule")] - - - -Returns -List of `arthurai.client.apiv3.AlertRule` objects - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - -Permissions -alert\_rule read - - - - - - - -get\_alerts(*page=1*, *page\_size=500*, *status=None*, *alert\_rule\_id=None*, *batch\_id=None*, *start\_time=None*, *end\_time=None*)[#](#arthurai.core.models.ArthurModel.get_alerts "Permalink to this definition") -Returns a paginated list of alert registered to this model. - - -For an introduction to alerts, see - - -For a guide to configuring alerts, see - - - -Parameters -* **page** (`int`) – page of alert rules to retrieve, defaults to 1 -* **page\_size** (`int`) – number of alert rules to return per page, defaults to 500 -* **status** (`Optional`[`str`]) – status of alert rule -* **alert\_rule\_id** (`Optional`[`str`]) – id of alert rule -* **batch\_id** (`Optional`[`str`]) – constrain returned alert rules to this batch id -* **start\_time** (`Optional`[`str`]) – constrain returned alert rules to after this time -* **end\_time** (`Optional`[`str`]) – constrain returned alert rules to before this time - - - -Return type -`List`[[`Alert`](arthurai.core.alerts.Alert.html#arthurai.core.alerts.Alert "arthurai.core.alerts.Alert")] - - - -Returns -List of `arthurai.client.apiv3.Alert` objects - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - -Permissions -alert read - - - - - - - -get\_attribute(*name*, *stage=None*)[#](#arthurai.core.models.ArthurModel.get_attribute "Permalink to this definition") -Retrieves an attribute by name and stage - - - -Parameters -* **name** (`str`) – string name of the attribute to retrieve -* **stage** (`Optional`[[`Stage`](arthurai.common.constants.Stage.html#arthurai.common.constants.Stage "arthurai.common.constants.Stage")]) – Optional Stage of attribute to retrieve - - - -Return type -[`ArthurAttribute`](arthurai.core.attributes.ArthurAttribute.html#arthurai.core.attributes.ArthurAttribute "arthurai.core.attributes.ArthurAttribute") - - - -Returns -ArthurAttribute Object - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - - - - - -get\_attribute\_names(*stage=None*)[#](#arthurai.core.models.ArthurModel.get_attribute_names "Permalink to this definition") -Returns a list of the names of attributes for the specified stage. If stage is not supplied the function -will return all attribute names. - - - -Parameters -**stage** (`Optional`[[`Stage`](arthurai.common.constants.Stage.html#arthurai.common.constants.Stage "arthurai.common.constants.Stage")]) – [`arthurai.common.constants.Stage`](arthurai.common.constants.Stage.html#arthurai.common.constants.Stage "arthurai.common.constants.Stage") to filter by - - - -Return type -`List`[`str`] - - - -Returns -List of string attribute names - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - - - - - -get\_attributes(*stage=None*)[#](#arthurai.core.models.ArthurModel.get_attributes "Permalink to this definition") -Returns a list of attributes for the specified stage. If stage is not supplied the function will return -all attributes. - - - -Parameters -**stage** (`Optional`[[`Stage`](arthurai.common.constants.Stage.html#arthurai.common.constants.Stage "arthurai.common.constants.Stage")]) – [`arthurai.common.constants.Stage`](arthurai.common.constants.Stage.html#arthurai.common.constants.Stage "arthurai.common.constants.Stage") to filter by - - - -Return type -`List`[[`ArthurAttribute`](arthurai.core.attributes.ArthurAttribute.html#arthurai.core.attributes.ArthurAttribute "arthurai.core.attributes.ArthurAttribute")] - - - -Returns -List of `arthurai.attributes.ArthurAttribute` - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - - - - - -get\_enrichment(*enrichment*)[#](#arthurai.core.models.ArthurModel.get_enrichment "Permalink to this definition") -Returns configuration for the specified enrichment. - - -For an introduction to enrichments, see - - -For a guide to configuring enrichments, see - - - -Parameters -**enrichment** ([`Enrichment`](arthurai.common.constants.Enrichment.html#arthurai.common.constants.Enrichment "arthurai.common.constants.Enrichment")) – Enrichment constant - - - -Return type -`Dict`[`str`, `Any`] - - - -Returns -Enrichment config - - - -``` -{ - "enabled": true, - "config": { - "python\_version": "3.7", - "sdk\_version": "3.0.11", - "streaming\_explainability\_enabled": false, - "user\_predict\_function\_import\_path": "entrypoint", - "shap\_expected\_values": "[0.7674405187893311, 0.23255948121066888]", - "model\_server\_cpu": "2", - "model\_server\_memory": "1Gi", - "model\_server\_max\_replicas": "5", - "explanation\_nsamples": 1000, - "explanation\_algo": "lime", - "inference\_consumer\_cpu": "100m", - "inference\_consumer\_memory": "512Mi", - "inference\_consumer\_score\_percent": "1.0", - "inference\_consumer\_thread\_pool\_size": "1", - "service\_account\_id": "8231affb-c107-478e-a1b4-e24e7f1f6619" - } -} - -``` - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - -Permissions -enrichment\_config read - - - - - - - -get\_enrichments()[#](#arthurai.core.models.ArthurModel.get_enrichments "Permalink to this definition") -Returns configuration for all enrichments. - - -For an introduction to enrichments, see - - -For a guide to configuring enrichments, see - - - -Return type -`Dict`[`str`, `Any`] - - - -Returns -Upload status response in the following format: - - - -``` -{ - "anomaly\_detection": { - "enabled": false - }, - "explainability": { - "config": { - "python\_version": "3.7", - "sdk\_version": "3.0.11", - "streaming\_explainability\_enabled": false, - "user\_predict\_function\_import\_path": "entrypoint", - "shap\_expected\_values": "[0.7674405187893311, 0.23255948121066888]", - "model\_server\_cpu": "2", - "model\_server\_memory": "1Gi", - "model\_server\_max\_replicas": "5", - "explanation\_nsamples": 1000, - "explanation\_algo": "lime", - "inference\_consumer\_cpu": "100m", - "inference\_consumer\_memory": "512Mi", - "inference\_consumer\_score\_percent": "1.0", - "inference\_consumer\_thread\_pool\_size": "1", - "service\_account\_id": "8231affb-c107-478e-a1b4-e24e7f1f6619" - }, - "enabled": true - } -} - -``` - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - -Permissions -enrichment\_config read - - - - - - - -get\_image(*image\_id*, *save\_path*, *type='raw\_image'*)[#](#arthurai.core.models.ArthurModel.get_image "Permalink to this definition") -Saves the image specified by image\_id to a file - - - -Parameters -* **image\_id** (`str`) – id of image in model -* **save\_path** (`str`) – directory to save the downloaded image to -* **type** ([`ImageResponseType`](arthurai.common.constants.ImageResponseType.html#arthurai.common.constants.ImageResponseType "arthurai.common.constants.ImageResponseType")) – type of response data - - - -Return type -`str` - - - -Returns -location of downloaded image file - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - -Permissions -raw\_data read - - - - - - - -get\_image\_attribute()[#](#arthurai.core.models.ArthurModel.get_image_attribute "Permalink to this definition") -Returns the attribute with value\_type=Image for input\_type=Image models - - - -Return type -[`ArthurAttribute`](arthurai.core.attributes.ArthurAttribute.html#arthurai.core.attributes.ArthurAttribute "arthurai.core.attributes.ArthurAttribute") - - - -Returns -ArthurAttribute Object - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - - - - - -get\_metrics(*default\_metrics=False*, *metric\_type=None*, *metric\_id=None*, *metric\_name=None*, *attribute\_name=None*)[#](#arthurai.core.models.ArthurModel.get_metrics "Permalink to this definition") -Retrieves metrics associated with the current model. Can add optional filters to search with function parameters. -:type default\_metrics: `bool` -:param default\_metrics: If set to True will return only metrics that are automatically created by default for your model -:type metric\_type: `Optional`[[`MetricType`](arthurai.core.alerts.MetricType.html#arthurai.core.alerts.MetricType "arthurai.core.alerts.MetricType")] -:param metric\_type: MetricType to filter metric query with -:type metric\_id: `Optional`[`str`] -:param metric\_id: Metric UUID to use in filtering metric search -:type metric\_name: `Optional`[`str`] -:param metric\_name: Metric name filter to use in metric search -:type attribute\_name: `Optional`[`str`] -:param attribute\_name: Attribute name filter to use in metric search -:rtype: `List`[[`Metric`](arthurai.core.alerts.Metric.html#arthurai.core.alerts.Metric "arthurai.core.alerts.Metric")] -:return: list of metrics returned from metric search -:permissions: metric\_query read - - - - - -get\_positive\_predicted\_class()[#](#arthurai.core.models.ArthurModel.get_positive_predicted_class "Permalink to this definition") -Checks if model is a binary classifier. Returns False if multiclass, otherwise returns the name of the positive -predicted attribute - - - - - -*property* ground\_truth\_type*: Optional[[arthurai.common.constants.Stage](arthurai.common.constants.Stage.html#arthurai.common.constants.Stage "arthurai.common.constants.Stage")]*[#](#arthurai.core.models.ArthurModel.ground_truth_type "Permalink to this definition") -Returns GroundTruthClass if Arthur performed one-hot encoding -in the creation of this model’s current ground truth attribute. -Otherwise, returns GroundTruth. - - -The GroundTruthClass stage is an Arthur-generated stage of attributes, -which are made after one-hot encoding attributes of the GroundTruth stage. - - - -Return type -`Optional`[[`Stage`](arthurai.common.constants.Stage.html#arthurai.common.constants.Stage "arthurai.common.constants.Stage")] - - - - - - - -infer\_schema(*data*, *stage*)[#](#arthurai.core.models.ArthurModel.infer_schema "Permalink to this definition") -Auto-generate attributes based on input data - - -For an introduction to the model schema, see - - -Note that this method does *not* automatically set reference -data; this method only reads the passed-in data, and then infers attribute names, types, etc. and sets them up -within the ArthurModel. - - - -See also - - -To infer the model schema *and* set reference data in a single call, see [`ArthurModel.build()`](#arthurai.core.models.ArthurModel.build "arthurai.core.models.ArthurModel.build"). - - -Once you’ve inferred the model schema with this function, you may want to set reference data separately -with [`ArthurModel.set\_reference\_data()`](#arthurai.core.models.ArthurModel.set_reference_data "arthurai.core.models.ArthurModel.set_reference_data"). - - - -For PredictedValue and GroundTruth stages, use the correct add\_\_output\_attributes() method instead. - - - -Parameters -* **data** (`Union`[`DataFrame`, `Series`]) – the data to infer attribute metadata from -* **stage** ([`Stage`](arthurai.common.constants.Stage.html#arthurai.common.constants.Stage "arthurai.common.constants.Stage")) – [`Stage`](arthurai.common.constants.Stage.html#arthurai.common.constants.Stage "arthurai.common.constants.Stage") of the data - - - -Return type -`None` - - - -Returns -a DataFrame summarizing the inferred types - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - - - - - -model\_is\_saved()[#](#arthurai.core.models.ArthurModel.model_is_saved "Permalink to this definition") -Returns True if and only if the model has been saved to the Arthur platform - - - -Return type -`bool` - - - - - - - -one\_hot\_encode(*value*)[#](#arthurai.core.models.ArthurModel.one_hot_encode "Permalink to this definition") -Creates a one hot encoding of a class label based on classes defined in a `ModelType.Multiclass` -model - - -This function does not modify your model’s attributes. - - - -``` -arthur\_model.one\_hot\_encode('attribute\_name') - -``` - - - -Parameters -**value** – the name of the ground truth attribute to one-hot-encode - - - -Returns -A dictionary with a one hot encoding of possible ground truth values. - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - - - - - -query(*body*, *query\_type='base'*)[#](#arthurai.core.models.ArthurModel.query "Permalink to this definition") -Execute query against the model’s inferences. -For full description of possible functions, aggregations, and transformations, see - - - - -Parameters -* **body** (`Dict`[`str`, `Any`]) – dict -* **query\_type** – str Can be either ‘base’, ‘drift’, or ‘drift\_psi\_bucket\_table’ - - - - - -``` -body = { - "select":[ - {"property":"batch\_id"}, - { - "function":"count", - "alias":"inference\_count" - } - ], - "group\_by":[ - {"property":"batch\_id"} - ] - } - -``` - - - -``` -body = { - "select":[, - {"property":"batch\_id"}, - { - "function":"rate", - "alias":"positive\_rate", - "parameters":{ - "property":"predicted\_1", - "comparator":"gt", - "value":0.75 - } - } - ], - "group\_by":[ - {"property":"batch\_id"} - ] - } - -``` - - - -Returns -the query response - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - -Permissions -raw\_data read - - - - - - - -remove\_attribute(*name=None*, *stage=None*, *attribute=None*)[#](#arthurai.core.models.ArthurModel.remove_attribute "Permalink to this definition") -Removes an already-made ArthurAttribute from the model. - - -Note that attributes may only be removed from unsaved models - for a saved model, attributes are immutable. - - - -Parameters -* **name** (`Optional`[`str`]) – Optional string, the name of the ArthurAttribute Object to remove from the model -* **stage** (`Optional`[[`Stage`](arthurai.common.constants.Stage.html#arthurai.common.constants.Stage "arthurai.common.constants.Stage")]) – Optional Stage, the stage of the ArthurAttribute Object to remove from the model -* **attribute** (`Optional`[[`ArthurAttribute`](arthurai.core.attributes.ArthurAttribute.html#arthurai.core.attributes.ArthurAttribute "arthurai.core.attributes.ArthurAttribute")]) – Optional ArthurAttribute Object to remove from the model - - - -Return type -`None` - - - -Returns -None - - - -Raises -* **MethodNotApplicableError** – failed due to incorrect usage on saved model -* **UserValueError** – failed due to user error inputting unrecognized attribute - - - - - - - -rename\_attribute(*old\_name*, *new\_name*, *stage*)[#](#arthurai.core.models.ArthurModel.rename_attribute "Permalink to this definition") -Renames an attribute by name and stage - - - -Parameters -* **old\_name** (`str`) – string name of the attribute to rename -* **new\_name** (`str`) – string new name of the attribute -* **stage** ([`Stage`](arthurai.common.constants.Stage.html#arthurai.common.constants.Stage "arthurai.common.constants.Stage")) – Stage of attribute - - - -Return type -[`ArthurAttribute`](arthurai.core.attributes.ArthurAttribute.html#arthurai.core.attributes.ArthurAttribute "arthurai.core.attributes.ArthurAttribute") - - - -Returns -ArthurAttribute Object - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - - - - - -review(*stage=None*, *props=None*, *print\_df=False*)[#](#arthurai.core.models.ArthurModel.review "Permalink to this definition") -Prints a summary of the properties of all attributes in the model. - - - -Parameters -* **stage** (`Optional`[[`Stage`](arthurai.common.constants.Stage.html#arthurai.common.constants.Stage "arthurai.common.constants.Stage")]) – restrict the output to a particular [`Stage`](arthurai.common.constants.Stage.html#arthurai.common.constants.Stage "arthurai.common.constants.Stage") (defaults to all stages) -* **props** (`Optional`[`List`[`str`]]) – a list of properties to display in the summary -valid properties are data\_type, categorical, is\_unique, -categories, cutoffs, range, monitor\_for\_bias, position -(defaults to data\_type, categorical, is\_unique) -* **print\_df** – boolean value whether to print df or return it, defaults to False - - - -Return type -`Optional`[`DataFrame`] - - - -Returns -a DataFrame summarizing the inferred types; or None if print\_df is True - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - - - - - -save()[#](#arthurai.core.models.ArthurModel.save "Permalink to this definition") -Check and save this model - - -After this method is called successfully, your model is sent to the Arthur Platform -where all its data and metrics are saved. - - -Returns the model’s ID in the Arthur platform once the upload is successful. - - - -``` -model\_id = arthur\_model.save() -with open("fullguide\_model\_id.txt", "w") as f: - f.write(model\_id) # saving this model's id to a local file - -``` - - - -Return type -`str` - - - -Returns -The model id - - - -Raises -* **MethodNotApplicableError** – the model has already been saved -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - -Permissions -model write AND (usually) reference\_data write - - - - - - - -send\_batch\_ground\_truths(*directory\_path=None*, *data=None*)[#](#arthurai.core.models.ArthurModel.send_batch_ground_truths "Permalink to this definition") - -Deprecated since version 3.10.0: Please use [`ArthurModel.send\_bulk\_ground\_truths()`](#arthurai.core.models.ArthurModel.send_bulk_ground_truths "arthurai.core.models.ArthurModel.send_bulk_ground_truths") for both streaming and batch data. - - - - -Parameters -* **directory\_path** (`Optional`[`str`]) – file path to a directory of parquet files containing ground truth data -* **data** (`Union`[`DataFrame`, `Series`, `None`]) – a DataFrame or Series containing the reference data for the `Stage` - - - -Returns -Upload status response in the following format: - - - -``` -{ - "counts": { - "success": 1, - "failure": 0, - "total": 1 - }, - "results": [ - { - "message": "success", - "status": 200 - } - ] -} - -``` - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - - - - - -send\_batch\_inferences(*batch\_id*, *directory\_path=None*, *data=None*, *complete\_batch=True*)[#](#arthurai.core.models.ArthurModel.send_batch_inferences "Permalink to this definition") -Send many inferences at once - - - -Deprecated since version 3.10.0: Use [`ArthurModel.send\_inferences()`](#arthurai.core.models.ArthurModel.send_inferences "arthurai.core.models.ArthurModel.send_inferences") to send batch or streaming data synchronously (recommended fewer -than 100,000 rows), or [`ArthurModel.send\_bulk\_inferences()`](#arthurai.core.models.ArthurModel.send_bulk_inferences "arthurai.core.models.ArthurModel.send_bulk_inferences") to send many inferences or Parquet files. - - - - -Parameters -* **batch\_id** (`Optional`[`str`]) – string id for the batch to upload; if supplied, this will override any batch\_id column -specified in the provided dataset -* **data** (`Optional`[`DataFrame`]) – a DataFrame containing the reference data. -* **directory\_path** (`Optional`[`str`]) – file path to a directory of parquet files containing ground truth data -* **complete\_batch** (`bool`) – Defaults to true and will automatically close a batch once it is sent - - - -Returns -A tuple of the batch upload response and the close batch response. -The batch upload response is in the following format: - - - -``` -{ - "counts": { - "success": 0, - "failure": 0, - "total": 0 - }, - "failures": [] -} - -``` - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - - - - - -send\_bulk\_ground\_truths(*directory\_path=None*, *data=None*)[#](#arthurai.core.models.ArthurModel.send_bulk_ground_truths "Permalink to this definition") -Uploads a large batch of ground truth values to Arthur - - -Uploads a DataFrame or directory containing parquet files to the Arthur bulk inferences ingestion endpoint. -Recommended for uploads of >100,000 rows of data. - - - -Parameters -* **directory\_path** (`Optional`[`str`]) – file path to a directory of parquet files containing ground truth data. Required if -data is not provided, and cannot be populated if data is provided. -* **data** (`Union`[`DataFrame`, `Series`, `None`]) – a DataFrame or Series containing the ground truth data. Required if directory\_path is not -provided, and cannot be populated it directory\_path is not provided. - - - -Returns -Upload status response in the following format: - - - -``` -{ - "counts": { - "success": 0, - "failure": 0, - "total": 0 - }, - "results": [ - { - "message": "success", - "status": 200 - } - ] -} - -``` - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - -Permissions -raw\_data write - - - - - - - -send\_bulk\_inferences(*batch\_id=None*, *directory\_path=None*, *data=None*, *complete\_batch=True*, *ignore\_join\_errors=False*)[#](#arthurai.core.models.ArthurModel.send_bulk_inferences "Permalink to this definition") -Uploads a large batch of inferences to Arthur - - -Uploads a DataFrame or directory containing parquet files to the Arthur bulk inferences ingestion endpoint. -Recommended for uploads of >100,000 rows of data. - - -Validates and uploads parquet files containing columns for inference data, partner\_inference\_id, -inference\_timestamp, and optionally a batch\_id. Either directory\_path or data must be -specified. - - - -See also - - -To send ground truth for your inferences, see `ArthurModel.send\_bulk\_ground\_truth()` - - - -The columns for predicted attributes should follow the column format specified in -`add\_\_classifier\_output\_attributes()`. Additionally, `partner\_inference\_id`, -must be specified for all inferences unless `ignore\_join\_errors` is True. - - - -Parameters -* **batch\_id** (`Optional`[`str`]) – string id for the batch to upload; if supplied, this will override any batch\_id column -specified in the provided dataset -* **directory\_path** (`Optional`[`str`]) – file path to a directory of parquet files containing inference data. Required if -`data` is not provided, and cannot be populated if data is provided. -* **data** (`Optional`[`DataFrame`]) – a DataFrame or Series containing the inference data. Required if `directory\_path` is not -provided, and cannot be populated if `directory\_path` is not provided. -* **complete\_batch** (`bool`) – Defaults to true and will automatically close a batch once it is sent -* **ignore\_join\_errors** (`bool`) – if True, allow inference data without `partner\_inference\_id` or ground truth data - - - -Returns -A tuple of the batch upload response and the close batch response. -The batch upload response is in the following format: - - - -``` -{ - "counts": { - "success": 1, - "failure": 0, - "total": 1 - }, - "results": [ - { - "message": "success", - "status": 200 - } - ] -} - -``` - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - -Permissions -raw\_data write - - - - - - - -send\_inference(*inference\_timestamp*, *partner\_inference\_id=''*, *model\_pipeline\_input=None*, *non\_input\_data=None*, *predicted\_value=None*, *ground\_truth=None*)[#](#arthurai.core.models.ArthurModel.send_inference "Permalink to this definition") - -Deprecated since version 3.20.0: Please use [`ArthurModel.send\_inferences()`](#arthurai.core.models.ArthurModel.send_inferences "arthurai.core.models.ArthurModel.send_inferences") to send a single inference. - - - - -Parameters -* **inference\_timestamp** (`Union`[`str`, `datetime`]) – timestamp for inference to send; generated by external partner (not Arthur) -* **partner\_inference\_id** (`str`) – an external id (partner\_inference\_id) to assign to the inferences -* **model\_pipeline\_input** – a mapping of the name of pipeline input attributes to their value -* **non\_input\_data** – a mapping of the name of non-input data attributes to their value -* **predicted\_value** – a mapping of the name of predicted value attributes to their value -* **ground\_truth** – a mapping of the name of ground truth attributes to their value - - - -Returns -Upload status response in the following format: - - - -``` -{ - "counts": { - "success": 0, - "failure": 0, - "total": 0 - }, - "results": [ - { - "message": "success", - "status": 200 - } - ] -} - -``` - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - -Permissions -raw\_data write - - - - - - - -send\_inferences(*inferences*, *predictions=None*, *inference\_timestamps=None*, *ground\_truths=None*, *ground\_truth\_timestamps=None*, *tz=None*, *partner\_inference\_ids=None*, *batch\_id=None*, *fail\_silently=False*, *complete\_batch=True*)[#](#arthurai.core.models.ArthurModel.send_inferences "Permalink to this definition") -Send inferences to the Arthur API. The inferences parameter may contain all the inference data, or only the -input data if predictions and metadata are supplied separately. At a minimum, input data and predictions should -be passed in: partner\_inference\_id, inference\_timestamp, and (if ground truth data is supplied) -ground\_truth\_timestamp fields are required by the Arthur API, but these will be generated if not supplied. - - - -See also - - -To send large amounts of data or Parquet files, see [`ArthurModel.send\_bulk\_inferences()`](#arthurai.core.models.ArthurModel.send_bulk_inferences "arthurai.core.models.ArthurModel.send_bulk_inferences") - - - -**Examples:** - - -An input dataframe and predicted probabilities array, leaving the partner inference IDs and timestamps to be -auto-generated: - - - -``` -input\_df = pd.DataFrame({"input\_attr": [2]}) -pred\_array = my\_sklearn\_model.predict\_proba(input\_df) -arthur\_model.send\_inferences(input\_df, predictions=pred\_array, batch\_id='batch1') - -``` - - -All data in the inferences parameter in the format expected by the -[Arthur API POST Inferences Endpoint](https://docs.arthur.ai/api-documentation/v3-api-docs.html#tag/inferences/paths/~1models~1%7Bmodel_id%7D~1inferences/post): - - - -``` -inference\_data = [ - { - "inference\_timestamp": "2021-06-16T16:52:11Z", - "partner\_inference\_id": "inf1", - "batch\_id": "batch1", - "inference\_data": { - "input\_attr": 2, - "predicted\_attr": 0.6 - }, - "ground\_truth\_timestamp": "2021-06-16T16:53:45Z", - "ground\_truth\_data": { - "ground\_truth\_attr": 1 - } - } -] -arthur\_model.send\_inferences(inference\_data) - -``` - - -A list of dicts without nested inference\_data or ground\_truth fields: - - - -``` -inference\_data = [ - { - "inference\_timestamp": "2021-06-16T16:52:11Z", - "partner\_inference\_id": "inf1", - "batch\_id": "batch1", - "input\_attr": 2, - "predicted\_attr": 0.6, - "ground\_truth\_timestamp": "2021-06-16T16:53:45Z", - "ground\_truth\_attr": 1 - } -] -arthur\_model.send\_inferences(inference\_data) - -``` - - - -Parameters -* **inferences** (`Union`[`List`[`Dict`[`str`, `Any`]], `Dict`[`str`, `List`[`Any`]], `DataFrame`]) – inference data to send, containing at least input values and optionally predictions, ground -truth, timestamps, partner inference ids, and batch IDs. -* **predictions** (`Union`[`List`[`Dict`[`str`, `Any`]], `Dict`[`str`, `List`[`Any`]], `DataFrame`, `Sequence`[`Any`], `None`]) – the model predictions, in a table-like format for one or more columns or a list-like format -if the model has only one predicted column. overwrites any predictions supplied in the inferences parameter -* **inference\_timestamps** (`Optional`[`Sequence`[`Union`[`datetime`, `str`]]]) – the inference timestamps, in a list-like format as ISO-8601 strings or datetime -objects. if no timestamps are supplied in inferences or this parameter, they will be generated from the -current time. overwrites any timestamps in the inferences parameter. -* **ground\_truths** (`Union`[`List`[`Dict`[`str`, `Any`]], `Dict`[`str`, `List`[`Any`]], `DataFrame`, `Sequence`[`Any`], `None`]) – the optional ground truth data (true labels), in a table-like format for one or more -columns or a list-like format if the model has only one ground truth column. overwrites any ground truth values -supplied in the inferences parameter -* **ground\_truth\_timestamps** (`Optional`[`Sequence`[`Union`[`datetime`, `str`]]]) – the ground truth timestamps, in a list-like format as ISO-8601 strings or -datetime objects. if no ground truth timestamps are supplied in inferences or this parameter but ground truth -data is supplied, they will be generated from the current time. overwrites any timestamps in the inferences -parameter. -* **tz** (`Optional`[`str`]) – datetime timezone object or timezone string -* **partner\_inference\_ids** (`Optional`[`Sequence`[`str`]]) – partner\_inference\_ids to be attached to these inferences, which can be used to -send ground truth data later or retrieve specific inferences, in a list-like format containing strings. if no -partner\_inference\_ids are supplied in inference or this parameter, they will be auto-generated. -* **batch\_id** (`Optional`[`str`]) – a single batch ID to use for all inferences supplied. overwrites any batch IDs in the -inferences parameter -* **fail\_silently** (`bool`) – if True, log failed inferences but do not raise an exception -* **complete\_batch** (`bool`) – if True, mark all batches in this dataset as completed - - - -Returns -Upload status response in the following format: - - - -``` -{ - "counts": { - "success": 1, - "failure": 0, - "total": 1 - }, - "results": [ - { - "partner\_inference\_id" "inf-id", - "message": "success", - "status": 200 - } - ] -} - -``` - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - -Permissions -raw\_data write - - - - - - - -set\_attribute\_as\_sensitive(*attribute\_name*, *attribute\_stage=None*)[#](#arthurai.core.models.ArthurModel.set_attribute_as_sensitive "Permalink to this definition") -Sets the passed-in attribute to be sensitive by setting attr.monitor\_for\_bias = True. - - -You will need to call self.save() or self.update() after this method; we do not -automatically call the API in this method. - - - -Parameters -* **attribute\_name** (`str`) – Name of attribute to set as sensitive. -* **attribute\_stage** (`Optional`[[`Stage`](arthurai.common.constants.Stage.html#arthurai.common.constants.Stage "arthurai.common.constants.Stage")]) – Stage of attribute to set as sensitive. - - - -Return type -`None` - - - -Returns -None - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - - - - - -set\_attribute\_labels(*attribute\_name*, *labels*, *attribute\_stage=None*)[#](#arthurai.core.models.ArthurModel.set_attribute_labels "Permalink to this definition") -Sets labels for individual categories of a specific attribute - - -This function should be used to set the labels corresponding to the -different possible values that an attribute can take. - - - -``` -# labels the value 0 for the attribute 'education\_level' -# to have the label 'elementary', etc. -arthur\_model.set\_attribute\_labels( - 'education\_level', - {0 : 'elementary', 1 : 'middle', 2 : 'high', 3 : 'university'} -) - -``` - - - -Parameters -* **attribute\_name** (`str`) – Attribute name to set the categories labels -* **attribute\_stage** (`Optional`[[`Stage`](arthurai.common.constants.Stage.html#arthurai.common.constants.Stage "arthurai.common.constants.Stage")]) – Optional stage of the attribute which is being updated -* **labels** (`Dict`[`Union`[`int`, `str`], `str`]) – Dictionary where the key is the categorical value and the value is the string categorical label - - - -Returns -None - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - - - - - -set\_predict\_function\_input\_order(*attributes*)[#](#arthurai.core.models.ArthurModel.set_predict_function_input_order "Permalink to this definition") -Sets the expected order of attributes used by the prediction function. - - -This function should be used when enabling explainability: -in particular, if your model’s predict function requires attributes -in a specific order, but the attribute positions have not yet been inferred correctly. - - - -Parameters -**attributes** (`List`[`str`]) – a list of attribute names - - - -Return type -`None` - - - -Returns -None - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - - - - - -set\_reference\_data(*directory\_path=None*, *data=None*)[#](#arthurai.core.models.ArthurModel.set_reference_data "Permalink to this definition") -Validates and sets the reference data for the given stage to the provided data. - - -For an introduction to reference data, see - - -To set reference data at the same time as inferring the model schema, see [`ArthurModel.build()`](#arthurai.core.models.ArthurModel.build "arthurai.core.models.ArthurModel.build") -To infer the model schema without setting reference data, see [`ArthurModel.infer\_schema()`](#arthurai.core.models.ArthurModel.infer_schema "arthurai.core.models.ArthurModel.infer_schema") - - - -``` -# reference dataframe of model inputs -reference\_set = ... - -# produce model predictions on reference set -# in this example, the predictions are classification probabilities -preds = model.predict\_proba(reference\_set) - -# assign the column corresponding to the positive class -# as the `pred` attribute in the reference data -reference\_set["pred"] = preds[:, 1] - -# set ground truth labels -reference\_set["gt"] = ... - -# configure the ArthurModel to use this dataframe as reference data -arthur\_model.set\_reference\_data(data=reference\_set) - -``` - - -Either directory\_path or data must be provided. Additionally, there must be -one column per ModelPipelineInput and NonInput attribute. - - -For Image models, the image file path should be included as the image atribute value, in either -the parquet files specified by directory\_path or the DataFrame provided. - - - -Parameters -* **directory\_path** (`Optional`[`str`]) – file path to a directory of parquet files to upload for batch data -* **data** (`Union`[`DataFrame`, `Series`, `None`]) – a DataFrame or Series containing the ground truth data - - - -Returns -Returns a tuple, the first variable is the response from sending the reference set and the second -is the response from closing the dataset. - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - -Permissions -reference\_data write - - - - - - - -swap\_predicted\_attribute\_positions(*persist\_if\_saved=True*)[#](#arthurai.core.models.ArthurModel.swap_predicted_attribute_positions "Permalink to this definition") -Swap the position of the model’s two predicted attributes - - -This function should be used when enabling explainability: -in particular, if your model’s predict function requires attributes -in a specific order, but the attribute positions have not yet been inferred correctly. - - - -Parameters -**persist\_if\_saved** – if the model has been saved, call update() to persist the change - - - -Returns - - - - - - -to\_dict(*skip\_none=True*)[#](#arthurai.core.models.ArthurModel.to_dict "Permalink to this definition") -Creates a dictionary representation of this object - - -This function can be applied to any extension of the ArthurBaseJsonDataClass - - - -Return type -`dict` - - - -Returns -Dictionary of object data - - - - - - - -to\_json(*skip\_none=True*)[#](#arthurai.core.models.ArthurModel.to_json "Permalink to this definition") -Creates a json representation of this object - - -This function can be applied to any extension of the ArthurBaseJsonDataClass - - - -Return type -`str` - - - -Returns -json of object data - - - - - - - -update()[#](#arthurai.core.models.ArthurModel.update "Permalink to this definition") -Update the current model object in the Arthur platform - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - -Permissions -model write - - - - - - - -update\_alert(*status*, *alert\_id*)[#](#arthurai.core.models.ArthurModel.update_alert "Permalink to this definition") -Updates alert to have a particular status. - - -For an introduction to alerts, see - - -For a guide to configuring alerts, see - - - -Parameters -* **status** ([`AlertStatus`](arthurai.core.alerts.AlertStatus.html#arthurai.core.alerts.AlertStatus "arthurai.core.alerts.AlertStatus")) – one of “resolved” or “acknowledged” -* **alert\_id** (`str`) – alert id - - - -Return type -[`Alert`](arthurai.core.alerts.Alert.html#arthurai.core.alerts.Alert "arthurai.core.alerts.Alert") - - - -Returns -updated alert object - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - -Permissions -alert write - - - - - - - -update\_alert\_rule(*alert\_rule*, *alert\_rule\_id=None*)[#](#arthurai.core.models.ArthurModel.update_alert_rule "Permalink to this definition") -Updates alert rule fields included in the alert\_rule object for the specified alert rule id. If the -alert rules id field is present in the alert\_rule parameter that is used otherwise alert\_rule\_id -must be supplied - - -For an introduction to alerts, see - - -For a guide to configuring alerts, see - - - -Parameters -* **alert\_rule** ([`AlertRule`](arthurai.core.alerts.AlertRule.html#arthurai.core.alerts.AlertRule "arthurai.core.alerts.AlertRule")) – Object which contains fields to update on the specified alert rule -* **alert\_rule\_id** (`Optional`[`str`]) – If the alert rule id is not specified in the alert\_rule\_to\_update object then this -must be provided to determine which alert rule to update. - - - -Returns -Updates alert rule object - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - -Permissions -alert\_rule write - - - - - - - -update\_enrichment(*enrichment*, *enabled=None*, *config=None*)[#](#arthurai.core.models.ArthurModel.update_enrichment "Permalink to this definition") -Update the configuration for a single enrichment - - -For an introduction to enrichments, see - - -For a guide to configuring enrichments, see - - - -Parameters -* **enrichment** ([`Enrichment`](arthurai.common.constants.Enrichment.html#arthurai.common.constants.Enrichment "arthurai.common.constants.Enrichment")) – the enrichment to update -* **enabled** (`Optional`[`bool`]) – whether the enrichment should be enabled or disabled -* **config** (`Optional`[`Dict`[`str`, `Any`]]) – the configuration for the enrichment, None by default - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - -Permissions -enrichment\_config write - - - -Return type -`Dict`[`str`, `Any`] - - - - - - - -update\_enrichments(*enrichment\_configs*)[#](#arthurai.core.models.ArthurModel.update_enrichments "Permalink to this definition") -Update the configuration for 1 or more enrichments. - - -For an introduction to enrichments, see - - -For a guide to configuring enrichments, see - - - -Parameters -**enrichment\_configs** (`Dict`[`Union`[`str`, [`Enrichment`](arthurai.common.constants.Enrichment.html#arthurai.common.constants.Enrichment "arthurai.common.constants.Enrichment")], `Any`]) – - -Dict containing the configuration for each enrichment - - - -``` -{ - "anomaly\_detection": { - "enabled": false - }, - "explainability": { - "config": { - "streaming\_explainability\_enabled": false, - "explanation\_nsamples": 1000, - "explanation\_algo": "lime", - "inference\_consumer\_score\_percent": "1.0" - }, - "enabled": true - } - "hotspots": { - "enabled": false - } -} - -``` - - - -Return type -`Dict`[`str`, `Any`] - - - -Returns -the resulting enrichments configuration - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - -Permissions -enrichment\_config write - - - - - - - -update\_inference\_ground\_truths(*ground\_truths*, *partner\_inference\_ids=None*, *ground\_truth\_timestamps=None*, *tz=None*, *fail\_silently=False*)[#](#arthurai.core.models.ArthurModel.update_inference_ground_truths "Permalink to this definition") -Updates inferences with the supplied ground truth values - - -For an introduction to sending data to Arthur, -see - - -The `ground\_truth` parameter may contain all the required data, or only the data for the attributes from -Stage.GroundTruth if metadata is supplied separately. At a minimum, Stage.GroundTruth attribute data and -`partner\_inference\_id` should be passed in, either along with the attribute data in the `ground\_truths` -parameter, or in the `partner\_inference\_ids` parameter. -Additionally, a `ground\_truth\_timestamp` field is required by the Arthur API, but this will be generated if -not supplied. - - - -See also - - -To send large amounts of data or Parquet files, see [`ArthurModel.send\_bulk\_ground\_truths()`](#arthurai.core.models.ArthurModel.send_bulk_ground_truths "arthurai.core.models.ArthurModel.send_bulk_ground_truths") - - - -**Examples:** - - -A DataFrame containing all required values: - - - -``` -y\_test = [1, 0, 1] -existing\_inference\_ids = [f"batch\_1-inf\_{i}" for i in len(y\_test)] -ground\_truth\_df = pd.DataFrame({"ground\_truth\_positive\_labels": y\_test, - "ground\_truth\_negative\_labels": 1 - y\_test, - "partner\_inference\_id": existing\_inference\_ids}) -arthur\_model.update\_inference\_ground\_truths(ground\_truth\_df) - -``` - - -A single list of values, with partner\_inference\_ids supplied separately: - - - -``` -y\_test = [14.3, 19.6, 15.7] -existing\_inference\_ids = [f"batch\_1-inf\_{i}" for i in len(y\_test)] -arthur\_model.update\_inference\_ground\_truths(y\_test, partner\_inference\_ids=existing\_inference\_ids) - -``` - - -All data in the inferences parameter in the format expected by the -[Arthur API PATCH Inferences Endpoint](https://docs.arthur.ai/api-documentation/v3-api-docs.html#tag/inferences/paths/~1models~1%7Bmodel_id%7D~1inferences/patch): - - - -``` -ground\_truth\_data = [ - { - "partner\_inference\_id": "inf1", - "ground\_truth\_timestamp": "2021-06-16T16:53:45Z", - "ground\_truth\_data": { - "ground\_truth\_attr": 1 - } - } -] -arthur\_model.update\_inference\_ground\_truths(ground\_truth\_data) - -``` - - -A list of dicts without nested ground\_truth fields: - - - -``` -inference\_data = [ - { - "partner\_inference\_id": "inf1", - "ground\_truth\_timestamp": "2021-06-16T16:53:45Z", - "ground\_truth\_attr": 1 - } -] -arthur\_model.send\_inferences(inference\_data) - -``` - - - -Parameters -* **ground\_truths** (`Union`[`List`[`Dict`[`str`, `Any`]], `Dict`[`str`, `List`[`Any`]], `DataFrame`, `Sequence`[`Any`]]) – ground truth data to send, containing at least values for the ground truth attributes, -and optionally `ground\_truth\_timestamp` and `partner\_inference\_id`. -* **partner\_inference\_ids** (`Optional`[`Sequence`[`str`]]) – partner\_inference\_ids for the existing inferences to be updated, in a list-like -format as strings. Required if not a field in `ground\_truths`. -* **ground\_truth\_timestamps** (`Optional`[`Sequence`[`Union`[`datetime`, `str`]]]) – the ground truth timestamps, in a list-like format as ISO-8601 strings or -datetime objects. if no ground truth timestamps are supplied in `inferences` or this parameter, -they will be generated from the current time. overwrites any timestamps in the `ground\_truths` parameter. -* **tz** (`Optional`[`str`]) – datetime timezone object or timezone string -* **fail\_silently** (`bool`) – if True, log failed inferences but do not raise an exception. - - - -Returns -Upload status response in the following format: - - - -``` -{ - "counts": { - "success": 1, - "failure": 0, - "total": 1 - }, - "results": [ - { - "message": "success", - "status": 200 - } - ] -} - -``` - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - -Permissions -raw\_data write - - - - - - - - - - - -[Next - -arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) -[Previous - -arthurai.core.models](arthurai.core.models.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.models.ExplainabilityParameters.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.models.ExplainabilityParameters.md.txt deleted file mode 100644 index 0eda9ccc8c622ea4342d5ac3b0eb12e7473c15f6..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.models.ExplainabilityParameters.md.txt +++ /dev/null @@ -1,517 +0,0 @@ - - - - - - -arthurai.core.models.ExplainabilityParameters - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](#) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.models.ExplainabilityParameters[#](#arthurai-core-models-explainabilityparameters "Permalink to this headline") -============================================================================================================================= - - - - -*class* arthurai.core.models.ExplainabilityParameters(*enabled*, *explanation\_algo=None*, *model\_server\_cpu=None*, *model\_server\_memory=None*, *explanation\_nsamples=None*)[#](#arthurai.core.models.ExplainabilityParameters "Permalink to this definition") -Bases: [`arthurai.core.base.ArthurBaseJsonDataclass`](arthurai.core.base.ArthurBaseJsonDataclass.html#arthurai.core.base.ArthurBaseJsonDataclass "arthurai.core.base.ArthurBaseJsonDataclass") - - -Methods - - - - - - - - -| [`clean\_nones`](#arthurai.core.models.ExplainabilityParameters.clean_nones "arthurai.core.models.ExplainabilityParameters.clean_nones") | Helper function to filter out None objects from a json or dictionary representation of an object | -| `from\_dict` | -rtype -`TypeVar`(`A`, bound= `DataClassJsonMixin`) - - | -| `from\_json` | -rtype -`TypeVar`(`A`, bound= `DataClassJsonMixin`) - - | -| `schema` | -rtype -`SchemaF`[`TypeVar`(`A`)] - - | -| [`to\_dict`](#arthurai.core.models.ExplainabilityParameters.to_dict "arthurai.core.models.ExplainabilityParameters.to_dict") | Creates a dictionary representation of this object | -| [`to\_json`](#arthurai.core.models.ExplainabilityParameters.to_json "arthurai.core.models.ExplainabilityParameters.to_json") | Creates a json representation of this object | - - - -Attributes - - - - - - - - -| `dataclass\_json\_config` | | -| `explanation\_algo` | | -| `explanation\_nsamples` | | -| `model\_server\_cpu` | | -| `model\_server\_memory` | | -| `enabled` | | - - - - - -*static* clean\_nones(*d*)[#](#arthurai.core.models.ExplainabilityParameters.clean_nones "Permalink to this definition") -Helper function to filter out None objects from a json or dictionary representation of an object - - - -Parameters -**d** – a Dictionary or Json representation of an ArthurBaseJsonDataclass object - - - -Returns -Dictionary of the object with all None components removed - - - - - - - -to\_dict(*skip\_none=True*)[#](#arthurai.core.models.ExplainabilityParameters.to_dict "Permalink to this definition") -Creates a dictionary representation of this object - - -This function can be applied to any extension of the ArthurBaseJsonDataClass - - - -Return type -`dict` - - - -Returns -Dictionary of object data - - - - - - - -to\_json(*skip\_none=True*)[#](#arthurai.core.models.ExplainabilityParameters.to_json "Permalink to this definition") -Creates a json representation of this object - - -This function can be applied to any extension of the ArthurBaseJsonDataClass - - - -Return type -`str` - - - -Returns -json of object data - - - - - - - - - - - -[Next - -arthurai.core.util](arthurai.core.util.html) -[Previous - -arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.models.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.models.md.txt deleted file mode 100644 index c9208c45b0955bc7919c89f3af628933946cf9a9..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.models.md.txt +++ /dev/null @@ -1,414 +0,0 @@ - - - - - - -arthurai.core.models - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](#)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.models[#](#module-arthurai.core.models "Permalink to this headline") -================================================================================== - - -Classes - - - - - - - - -| [`ArthurModel`](arthurai.core.models.ArthurModel.html#arthurai.core.models.ArthurModel "arthurai.core.models.ArthurModel")(partner\_model\_id, input\_type, ...) | Arthur Model class represents the metadata which represents a registered model in the application | -| [`ArthurModelGroup`](arthurai.core.models.ArthurModelGroup.html#arthurai.core.models.ArthurModelGroup "arthurai.core.models.ArthurModelGroup")([id, name, description, ...]) | (BETA) The ArthurModelGroup class is a collection of the metadata which represents a group of models within a Model Group on the Arthur platform. | -| [`ExplainabilityParameters`](arthurai.core.models.ExplainabilityParameters.html#arthurai.core.models.ExplainabilityParameters "arthurai.core.models.ExplainabilityParameters")(enabled[, ...]) | | - - - - - - - - -[Next - -arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) -[Previous - -arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.util.NumpyEncoder.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.util.NumpyEncoder.md.txt deleted file mode 100644 index 077bf4d7f2fd027a07cbc449f9c37b017a1df7ca..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.util.NumpyEncoder.md.txt +++ /dev/null @@ -1,522 +0,0 @@ - - - - - - -arthurai.core.util.NumpyEncoder - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](#) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.util.NumpyEncoder[#](#arthurai-core-util-numpyencoder "Permalink to this headline") -================================================================================================= - - - - -*class* arthurai.core.util.NumpyEncoder(*\**, *skipkeys=False*, *ensure\_ascii=True*, *check\_circular=True*, *allow\_nan=True*, *sort\_keys=False*, *indent=None*, *separators=None*, *default=None*)[#](#arthurai.core.util.NumpyEncoder "Permalink to this definition") -Bases: `json.encoder.JSONEncoder` - - -Special json encoder for numpy types - - -Methods - - - - - - - - -| [`convert\_value`](#arthurai.core.util.NumpyEncoder.convert_value "arthurai.core.util.NumpyEncoder.convert_value") | Converts the given object from a numpy data type to a python data type, if the object is already a python data type it is returned | -| [`default`](#arthurai.core.util.NumpyEncoder.default "arthurai.core.util.NumpyEncoder.default") | Implement this method in a subclass such that it returns a serializable object for `o`, or calls the base implementation (to raise a `TypeError`). | -| [`encode`](#arthurai.core.util.NumpyEncoder.encode "arthurai.core.util.NumpyEncoder.encode") | Return a JSON string representation of a Python data structure. | -| [`iterencode`](#arthurai.core.util.NumpyEncoder.iterencode "arthurai.core.util.NumpyEncoder.iterencode") | Encode the given object and yield each string representation as available. | - - - -Attributes - - - - - - - - -| `item\_separator` | | -| `key\_separator` | | - - - - - -*static* convert\_value(*obj*)[#](#arthurai.core.util.NumpyEncoder.convert_value "Permalink to this definition") -Converts the given object from a numpy data type to a python data type, if the object is already a -python data type it is returned - - - -Parameters -**obj** – object to convert - - - -Returns -python data type version of the object - - - - - - - -default(*o*)[#](#arthurai.core.util.NumpyEncoder.default "Permalink to this definition") -Implement this method in a subclass such that it returns -a serializable object for `o`, or calls the base implementation -(to raise a `TypeError`). - - -For example, to support arbitrary iterators, you could -implement default like this: - - - -``` -def default(self, o): - try: - iterable = iter(o) - except TypeError: - pass - else: - return list(iterable) - # Let the base class default method raise the TypeError - return JSONEncoder.default(self, o) - -``` - - - - - -encode(*o*)[#](#arthurai.core.util.NumpyEncoder.encode "Permalink to this definition") -Return a JSON string representation of a Python data structure. - - - -``` ->>> from json.encoder import JSONEncoder ->>> JSONEncoder().encode({"foo": ["bar", "baz"]}) -'{"foo": ["bar", "baz"]}' - -``` - - - - - -iterencode(*o*, *\_one\_shot=False*)[#](#arthurai.core.util.NumpyEncoder.iterencode "Permalink to this definition") -Encode the given object and yield each string -representation as available. - - -For example: - - - -``` -for chunk in JSONEncoder().iterencode(bigobject): - mysocket.write(chunk) - -``` - - - - - - - - - -[Next - -arthurai.core.viz](arthurai.core.viz.html) -[Previous - -arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.util.dataframe_like_to_list_of_dicts.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.util.dataframe_like_to_list_of_dicts.md.txt deleted file mode 100644 index 233c338a3ecc8ce4f26c26693e3d809f198537e7..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.util.dataframe_like_to_list_of_dicts.md.txt +++ /dev/null @@ -1,412 +0,0 @@ - - - - - - -arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](#) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts[#](#arthurai-core-util-dataframe-like-to-list-of-dicts "Permalink to this headline") -============================================================================================================================================ - - - - -arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts(*data*)[#](#arthurai.core.util.dataframe_like_to_list_of_dicts "Permalink to this definition") -Standardize data in a List of Dicts format (e.g. [{‘a’: 1, ‘b’: 2}, {‘a’: 3, ‘b’: 4}]). Input can be formatted as -a List of Dicts, Dict of Lists (e.g. {‘a’: [1, 3], ‘b’: [2, 4]}), or a Pandas DataFrame. May return the same -object as input if it already matches the correct format. -:type data: `Union`[`List`[`Dict`[`str`, `Any`]], `Dict`[`str`, `List`[`Any`]], `DataFrame`] -:param data: the input data to format -:return: the data restructured as a Dict of Lists -:raises UserTypeError: if the data is in an unexpected format - - - - - - - - -[Next - -arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) -[Previous - -arthurai.core.util](arthurai.core.util.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.util.intersection_is_non_empty.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.util.intersection_is_non_empty.md.txt deleted file mode 100644 index 23b7f02bc3bea2c00267d177ea9a0783e38b01ea..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.util.intersection_is_non_empty.md.txt +++ /dev/null @@ -1,411 +0,0 @@ - - - - - - -arthurai.core.util.intersection\_is\_non\_empty - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](#) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.util.intersection\_is\_non\_empty[#](#arthurai-core-util-intersection-is-non-empty "Permalink to this headline") -============================================================================================================================== - - - - -arthurai.core.util.intersection\_is\_non\_empty(*iter1*, *iter2*)[#](#arthurai.core.util.intersection_is_non_empty "Permalink to this definition") -Returns True if the two iterables share at least one element -:type iter1: `Iterable`[`Any`] -:param iter1: -:type iter2: `Iterable`[`Any`] -:param iter2: -:return: - - - - - - - - -[Next - -arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) -[Previous - -arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.util.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.util.md.txt deleted file mode 100644 index e4329b1c2b48aaa9a80141d9c7632a45edc029c2..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.util.md.txt +++ /dev/null @@ -1,443 +0,0 @@ - - - - - - -arthurai.core.util - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](#)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.util[#](#module-arthurai.core.util "Permalink to this headline") -============================================================================== - - -Functions - - - - - - - - -| [`dataframe\_like\_to\_list\_of\_dicts`](arthurai.core.util.dataframe_like_to_list_of_dicts.html#arthurai.core.util.dataframe_like_to_list_of_dicts "arthurai.core.util.dataframe_like_to_list_of_dicts")(data) | Standardize data in a List of Dicts format (e.g. | -| [`intersection\_is\_non\_empty`](arthurai.core.util.intersection_is_non_empty.html#arthurai.core.util.intersection_is_non_empty "arthurai.core.util.intersection_is_non_empty")(iter1, iter2) | Returns True if the two iterables share at least one element :type iter1: `Iterable`[`Any`] :param iter1: :type iter2: `Iterable`[`Any`] :param iter2: :return: | -| [`retrieve\_parquet\_files`](arthurai.core.util.retrieve_parquet_files.html#arthurai.core.util.retrieve_parquet_files "arthurai.core.util.retrieve_parquet_files")(directory\_path) | Checks whether a given directory and its subdirectories contain parquet files, if so this will return a list of the files | -| [`standardize\_pd\_obj`](arthurai.core.util.standardize_pd_obj.html#arthurai.core.util.standardize_pd_obj "arthurai.core.util.standardize_pd_obj")(data, dropna, replacedatetime) | Standardize pandas object for nans and datetimes. | -| [`update\_column\_in\_list\_of\_dicts`](arthurai.core.util.update_column_in_list_of_dicts.html#arthurai.core.util.update_column_in_list_of_dicts "arthurai.core.util.update_column_in_list_of_dicts")(data, ...) | Adds column\_values to target\_column in a list of dicts **in place**. | - - - -Classes - - - - - - - - -| [`NumpyEncoder`](arthurai.core.util.NumpyEncoder.html#arthurai.core.util.NumpyEncoder "arthurai.core.util.NumpyEncoder")(\*[, skipkeys, ensure\_ascii, ...]) | Special json encoder for numpy types | - - - - - - - - -[Next - -arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) -[Previous - -arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - On this page - - - - -* [arthurai.core.util](#) - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.util.retrieve_parquet_files.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.util.retrieve_parquet_files.md.txt deleted file mode 100644 index 8b47872eb4cd525c7d26ff6f215de88cf1a1c2ab..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.util.retrieve_parquet_files.md.txt +++ /dev/null @@ -1,424 +0,0 @@ - - - - - - -arthurai.core.util.retrieve\_parquet\_files - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](#) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.util.retrieve\_parquet\_files[#](#arthurai-core-util-retrieve-parquet-files "Permalink to this headline") -======================================================================================================================= - - - - -arthurai.core.util.retrieve\_parquet\_files(*directory\_path*)[#](#arthurai.core.util.retrieve_parquet_files "Permalink to this definition") -Checks whether a given directory and its subdirectories contain parquet files, -if so this will return a list of the files - - - -Parameters -**directory\_path** (`str`) – local path to check files types - - - -Return type -`List`[`Path`] - - - -Returns -List of paths for parquet files that are found - - - - - - - - - - -[Next - -arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) -[Previous - -arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.util.standardize_pd_obj.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.util.standardize_pd_obj.md.txt deleted file mode 100644 index 180ae81fe4170d5de13fd5d0d23da246fd052c55..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.util.standardize_pd_obj.md.txt +++ /dev/null @@ -1,436 +0,0 @@ - - - - - - -arthurai.core.util.standardize\_pd\_obj - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](#) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.util.standardize\_pd\_obj[#](#arthurai-core-util-standardize-pd-obj "Permalink to this headline") -=============================================================================================================== - - - - -arthurai.core.util.standardize\_pd\_obj(*data*, *dropna*, *replacedatetime*, *attributes=None*)[#](#arthurai.core.util.standardize_pd_obj "Permalink to this definition") -Standardize pandas object for nans and datetimes. - - -Standardization includes casting correct type for int columns that are float due to nans and -for converting datetime objects into isoformatted strings. - - - -Parameters -* **data** (`Union`[`DataFrame`, `Series`]) – the pandas data to standardize -* **dropna** (`bool`) – if True, drop nans from numeric date columns -* **replacedatetime** (`bool`) – if True, replace timestamps with isoformatted strings -* **attributes** (`Optional`[`Dict`[`str`, `Union`[`str`, [`ValueType`](arthurai.common.constants.ValueType.html#arthurai.common.constants.ValueType "arthurai.common.constants.ValueType")]]]) – if used for sending inferences, will handle column type conversions for columns with any nulls - - - -Return type -`Union`[`DataFrame`, `Series`] - - - -Returns -the standardized pandas data - - - -Raises -* **TypeError** – timestamp is not of type datetime.datetime -* **ValueError** – timestamp is not timezone aware and no location data is provided to remedy - - - - - - - - - - -[Next - -arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) -[Previous - -arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.util.update_column_in_list_of_dicts.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.util.update_column_in_list_of_dicts.md.txt deleted file mode 100644 index f5a13f2d166c24da5dcc9aa5d60168107417ae81..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.util.update_column_in_list_of_dicts.md.txt +++ /dev/null @@ -1,416 +0,0 @@ - - - - - - -arthurai.core.util.update\_column\_in\_list\_of\_dicts - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](#) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.util.update\_column\_in\_list\_of\_dicts[#](#arthurai-core-util-update-column-in-list-of-dicts "Permalink to this headline") -========================================================================================================================================== - - - - -arthurai.core.util.update\_column\_in\_list\_of\_dicts(*data*, *target\_column*, *column\_values*)[#](#arthurai.core.util.update_column_in_list_of_dicts "Permalink to this definition") -Adds column\_values to target\_column in a list of dicts **in place**. If values are present for target\_column, they are -overwritten. -:type data: `List`[`Dict`[`str`, `Any`]] -:param data: the List of Dict data to modify -:type target\_column: `str` -:param target\_column: the name of the column to write values into -:type column\_values: `Sequence`[`Any`] -:param column\_values: the values to write -:rtype: `None` -:return: None (in place) -:raises UserValueError: if the lengths don’t match or aren’t retrievable - - - - - - - - -[Next - -arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) -[Previous - -arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.viz.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.viz.md.txt deleted file mode 100644 index 1f79a098f7ebccae417298a867a6d69afd8d03f0..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.viz.md.txt +++ /dev/null @@ -1,411 +0,0 @@ - - - - - - -arthurai.core.viz - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](#)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.viz[#](#module-arthurai.core.viz "Permalink to this headline") -============================================================================ - - - - - - - - -| [`arthurai.core.viz.style`](arthurai.core.viz.style.html#module-arthurai.core.viz.style "arthurai.core.viz.style") | | -| [`arthurai.core.viz.utils`](arthurai.core.viz.utils.html#module-arthurai.core.viz.utils "arthurai.core.viz.utils") | | -| [`arthurai.core.viz.visualizer`](arthurai.core.viz.visualizer.html#module-arthurai.core.viz.visualizer "arthurai.core.viz.visualizer") | | - - - - - - - - -[Next - -arthurai.core.viz.style](arthurai.core.viz.style.html) -[Previous - -arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.viz.style.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.viz.style.md.txt deleted file mode 100644 index a9d8105501ea412bf157654a3b2ecc3bc5fa586f..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.viz.style.md.txt +++ /dev/null @@ -1,399 +0,0 @@ - - - - - - -arthurai.core.viz.style - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](#) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.viz.style[#](#module-arthurai.core.viz.style "Permalink to this headline") -======================================================================================== - - - - - - - -[Next - -arthurai.core.viz.utils](arthurai.core.viz.utils.html) -[Previous - -arthurai.core.viz](arthurai.core.viz.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.viz.utils.get_pred_and_gt_attrs.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.viz.utils.get_pred_and_gt_attrs.md.txt deleted file mode 100644 index 9feb1a334599972fbb4eb6069f609167152f2e53..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.viz.utils.get_pred_and_gt_attrs.md.txt +++ /dev/null @@ -1,413 +0,0 @@ - - - - - - -arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](#) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs[#](#arthurai-core-viz-utils-get-pred-and-gt-attrs "Permalink to this headline") -================================================================================================================================= - - - - -arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs(*arthur\_model*)[#](#arthurai.core.viz.utils.get_pred_and_gt_attrs "Permalink to this definition") -Returns the name of the predicted attribute and ground truth attribute for a model. - - - -Parameters -**arthur\_model** – an ArthurModel object - - - - - - - - - - -[Next - -arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) -[Previous - -arthurai.core.viz.utils](arthurai.core.viz.utils.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.viz.utils.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.viz.utils.md.txt deleted file mode 100644 index 0915b935251d6281a07bb05a997d4132489b591f..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.viz.utils.md.txt +++ /dev/null @@ -1,413 +0,0 @@ - - - - - - -arthurai.core.viz.utils - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](#)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.viz.utils[#](#module-arthurai.core.viz.utils "Permalink to this headline") -======================================================================================== - - -Functions - - - - - - - - -| [`get\_pred\_and\_gt\_attrs`](arthurai.core.viz.utils.get_pred_and_gt_attrs.html#arthurai.core.viz.utils.get_pred_and_gt_attrs "arthurai.core.viz.utils.get_pred_and_gt_attrs")(arthur\_model) | Returns the name of the predicted attribute and ground truth attribute for a model. | -| [`savgol\_filter`](arthurai.core.viz.utils.savgol_filter.html#arthurai.core.viz.utils.savgol_filter "arthurai.core.viz.utils.savgol_filter")(signal) | Simple instantiation of Savitzky-Golay filter (cubic). | - - - - - - - - -[Next - -arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) -[Previous - -arthurai.core.viz.style](arthurai.core.viz.style.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.viz.utils.savgol_filter.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.viz.utils.savgol_filter.md.txt deleted file mode 100644 index 0b5fd5f3f37ce1a7b89a06e22b494a870c78ecab..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.viz.utils.savgol_filter.md.txt +++ /dev/null @@ -1,413 +0,0 @@ - - - - - - -arthurai.core.viz.utils.savgol\_filter - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](#) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.viz.utils.savgol\_filter[#](#arthurai-core-viz-utils-savgol-filter "Permalink to this headline") -============================================================================================================== - - - - -arthurai.core.viz.utils.savgol\_filter(*signal*)[#](#arthurai.core.viz.utils.savgol_filter "Permalink to this definition") -Simple instantiation of Savitzky-Golay filter (cubic). - - - -Parameters -**signal** – a numpy 1D array - - - - - - - - - - -[Next - -arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html) -[Previous - -arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.viz.visualizer.DataVisualizer.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.viz.visualizer.DataVisualizer.md.txt deleted file mode 100644 index 932ae60cdc863f401b8bd3e11313df7453112965..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.viz.visualizer.DataVisualizer.md.txt +++ /dev/null @@ -1,478 +0,0 @@ - - - - - - -arthurai.core.viz.visualizer.DataVisualizer - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](#) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.viz.visualizer.DataVisualizer[#](#arthurai-core-viz-visualizer-datavisualizer "Permalink to this headline") -========================================================================================================================= - - - - -*class* arthurai.core.viz.visualizer.DataVisualizer(*arthur\_models*)[#](#arthurai.core.viz.visualizer.DataVisualizer "Permalink to this definition") -Bases: `object` - - -Methods - - - - - - - - -| [`drift\_series`](#arthurai.core.viz.visualizer.DataVisualizer.drift_series "arthurai.core.viz.visualizer.DataVisualizer.drift_series") | Generates a line series visualization of data drift metrics for selected attributes. | -| [`metric\_series`](#arthurai.core.viz.visualizer.DataVisualizer.metric_series "arthurai.core.viz.visualizer.DataVisualizer.metric_series") | Generates a line series visualization for selected metrics. | -| [`timeline`](#arthurai.core.viz.visualizer.DataVisualizer.timeline "arthurai.core.viz.visualizer.DataVisualizer.timeline") | Generates a visualization of the distribution of an attribute over time. | - - - - - -drift\_series(*attribute\_names*, *drift\_metric='PSI'*, *time\_resolution='day'*)[#](#arthurai.core.viz.visualizer.DataVisualizer.drift_series "Permalink to this definition") -Generates a line series visualization of data drift metrics for selected attributes. - - - -``` -# plot the KLDivergence drift of features X1, X2, and X3 by the hour -arthur\_model.viz.drift\_series(["X1", "X2", "X3"], drift\_metric="KLDivergence", time\_resolution="hour") - -``` - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - - - - - -metric\_series(*metric\_names*, *time\_resolution='day'*)[#](#arthurai.core.viz.visualizer.DataVisualizer.metric_series "Permalink to this definition") -Generates a line series visualization for selected metrics. - - - -``` -# plot both the model's AUC metric and the model's FPR metric by the hour -arthur\_model.viz.metric\_series(["auc", "falsePositiveRate"], time\_resolution="hour") - -``` - - - -Raises -* **ArthurUserError** – failed due to user error -* **ArthurInternalError** – failed due to an internal error - - - - - - - -timeline(*attribute\_name*)[#](#arthurai.core.viz.visualizer.DataVisualizer.timeline "Permalink to this definition") -Generates a visualization of the distribution of an attribute over time. -For categorical attributes, a stacked area chart over time. -For continuous attributes, a joyplot showing probability densities over time. -:raises ArthurUserError: failed due to user error -:raises ArthurInternalError: failed due to an internal error - - - - - - - - - -[Next - -arthurai.explainability](arthurai.explainability.html) -[Previous - -arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.core.viz.visualizer.md.txt b/files/arthur-docs-markdown/sdk/arthurai.core.viz.visualizer.md.txt deleted file mode 100644 index d92886dcc96cf2e3d34568e1638bcb246250ec73..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.core.viz.visualizer.md.txt +++ /dev/null @@ -1,412 +0,0 @@ - - - - - - -arthurai.core.viz.visualizer - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](#)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.core.viz.visualizer[#](#module-arthurai.core.viz.visualizer "Permalink to this headline") -================================================================================================== - - -Classes - - - - - - - - -| [`DataVisualizer`](arthurai.core.viz.visualizer.DataVisualizer.html#arthurai.core.viz.visualizer.DataVisualizer "arthurai.core.viz.visualizer.DataVisualizer")(arthur\_models) | | - - - - - - - - -[Next - -arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) -[Previous - -arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.explainability.arthur_explainer.ArthurExplainer.md.txt b/files/arthur-docs-markdown/sdk/arthurai.explainability.arthur_explainer.ArthurExplainer.md.txt deleted file mode 100644 index d70a74f6c4c7052a8afc40fa1e1dc8be3a9019fb..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.explainability.arthur_explainer.ArthurExplainer.md.txt +++ /dev/null @@ -1,874 +0,0 @@ - - - - - - -arthurai.explainability.arthur\_explainer.ArthurExplainer - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](#) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.explainability.arthur\_explainer.ArthurExplainer[#](#arthurai-explainability-arthur-explainer-arthurexplainer "Permalink to this headline") -==================================================================================================================================================== - - - - -*class* arthurai.explainability.arthur\_explainer.ArthurExplainer(*model\_type*, *model\_input\_type*, *predicted\_attributes*, *predict\_func*, *data*, *label\_mapping*, *categorical\_features=None*, *enable\_shap=True*, *shap\_training\_samples=20*, *enable\_lime=True*, *text\_delimiter='\\\\W+'*, *load\_image\_func=None*, *predictions\_df=None*)[#](#arthurai.explainability.arthur_explainer.ArthurExplainer "Permalink to this definition") -Bases: `object` - - -Class for explaining inferences with a variety of libs - - -Methods - - - - - - - - -| `build\_image\_explainers` | -rtype -`None` - - | -| `build\_nlp\_explainers` | -rtype -`None` - - | -| `build\_tabular\_explainers` | -rtype -`None` - - | -| [`decode\_labels`](#arthurai.explainability.arthur_explainer.ArthurExplainer.decode_labels "arthurai.explainability.arthur_explainer.ArthurExplainer.decode_labels") | Decodes into strings | -| [`encode\_labels`](#arthurai.explainability.arthur_explainer.ArthurExplainer.encode_labels "arthurai.explainability.arthur_explainer.ArthurExplainer.encode_labels") | Encodes labels into integers | -| `explain\_image` | -rtype -`List`[`Dict`[`str`, `Any`]] - - | -| `explain\_image\_lime` | -rtype -`List`[`Dict`[`str`, `Any`]] - - | -| `explain\_nlp` | -rtype -`List`[`List`[`List`[`List`[`float`]]]] - - | -| `explain\_nlp\_lime` | -rtype -`List`[`List`[`List`[`List`[`float`]]]] - - | -| `explain\_tabular` | -rtype -`List`[`List`[`List`[`float`]]] - - | -| [`explain\_tabular\_lime`](#arthurai.explainability.arthur_explainer.ArthurExplainer.explain_tabular_lime "arthurai.explainability.arthur_explainer.ArthurExplainer.explain_tabular_lime") | Calculate lime values. | -| [`explain\_tabular\_shap`](#arthurai.explainability.arthur_explainer.ArthurExplainer.explain_tabular_shap "arthurai.explainability.arthur_explainer.ArthurExplainer.explain_tabular_shap") | Calculate SHAP values. | -| [`format\_lime\_image\_results`](#arthurai.explainability.arthur_explainer.ArthurExplainer.format_lime_image_results "arthurai.explainability.arthur_explainer.ArthurExplainer.format_lime_image_results") | Format LIME results for images | -| [`format\_lime\_results`](#arthurai.explainability.arthur_explainer.ArthurExplainer.format_lime_results "arthurai.explainability.arthur_explainer.ArthurExplainer.format_lime_results") | LIME's .as\_map() method returns scores looking like the following: | -| [`format\_lime\_results\_for\_one\_class`](#arthurai.explainability.arthur_explainer.ArthurExplainer.format_lime_results_for_one_class "arthurai.explainability.arthur_explainer.ArthurExplainer.format_lime_results_for_one_class") | This method unpacks the results for a single classes's explanation: | -| [`format\_lime\_text\_results`](#arthurai.explainability.arthur_explainer.ArthurExplainer.format_lime_text_results "arthurai.explainability.arthur_explainer.ArthurExplainer.format_lime_text_results") | Format LIME results for Text models | -| [`predict\_tabular`](#arthurai.explainability.arthur_explainer.ArthurExplainer.predict_tabular "arthurai.explainability.arthur_explainer.ArthurExplainer.predict_tabular") | Takes in customer provided data and returns the prediction values as numpy array (both regression and classification) | -| [`predict\_wrapper`](#arthurai.explainability.arthur_explainer.ArthurExplainer.predict_wrapper "arthurai.explainability.arthur_explainer.ArthurExplainer.predict_wrapper") | Wraps user supplied predict function. | -| [`shap\_expected\_values`](#arthurai.explainability.arthur_explainer.ArthurExplainer.shap_expected_values "arthurai.explainability.arthur_explainer.ArthurExplainer.shap_expected_values") | Returns expected values from the shap explainer for this model input type | - - - -Attributes - - - - - - - - -| `LIME` | | -| `SHAP` | | -| `num\_predicted\_attributes` | -rtype -`int` - - | - - - - - -decode\_labels(*feature\_vector*)[#](#arthurai.explainability.arthur_explainer.ArthurExplainer.decode_labels "Permalink to this definition") -Decodes into strings - - - -Return type -`Iterable` - - - - - - - -encode\_labels(*feature\_vector*)[#](#arthurai.explainability.arthur_explainer.ArthurExplainer.encode_labels "Permalink to this definition") -Encodes labels into integers - - - -Return type -`Iterable` - - - - - - - -explain\_tabular\_lime(*raw\_feature\_vectors*, *\*\*kwargs*)[#](#arthurai.explainability.arthur_explainer.ArthurExplainer.explain_tabular_lime "Permalink to this definition") -Calculate lime values. For one or more inferences. - - - -Parameters -* **raw\_feature\_vectors** (`List`) – An iterable of one or more feature vectors to explain. -* **kwargs** – Additional args to pass to LIME. - - - -Return type -`List`[`List`[`List`[`float`]]] - - - -Returns -A List of explanations for each feature vector. A single explanation is -a list of lists that contain the explanation for each model output by input feature. -In this example, the model has 4 features and 3 output classes: - - - -``` -[ - [ - [-0.011, 0.009, -0.128, -0.161], - [-0.009, 0.003, -0.091, -0.065], - [0.02, -0.013, 0.220, 0.226] - ] -] - -``` - - - - - - - -explain\_tabular\_shap(*raw\_feature\_vectors*, *\*\*kwargs*)[#](#arthurai.explainability.arthur_explainer.ArthurExplainer.explain_tabular_shap "Permalink to this definition") -Calculate SHAP values. For one or more inferences. - - - -Parameters -* **raw\_feature\_vectors** (`List`) – An iterable of one or more feature vectors to explain. -* **kwargs** – Additional args to pass to SHAP. - - - -Return type -`List`[`List`[`List`[`float`]]] - - - -Returns -A List of explanations for each feature vector. A single explanation is a list of lists that contain -the explanation for each model output by input feature. In this example, the model has 4 features and -3 output classes. - - - -``` -[ - [-0.011, 0.009, -0.128, -0.161], - [-0.009, 0.003, -0.091, -0.065], - [0.02, -0.013, 0.220, 0.226] -] - -``` - - - - - - - -*static* format\_lime\_image\_results(*results*)[#](#arthurai.explainability.arthur_explainer.ArthurExplainer.format_lime_image_results "Permalink to this definition") -Format LIME results for images - - - -Return type -`List`[`Dict`[`str`, `Any`]] - - - -Returns -formatted output in the following format: - - - -``` -{ - "lime\_segment\_mask": [ - [1, 1, 1, 3, 3, 1, 0], - [1, 1, 1, 3, 3, 1, 0], - [1, 1, 1, 3, 3, 1, 0], - [2, 2, 2, 3, 3, 1, 0] - ], - "lime\_region\_mapping": { - "0": [[0, 0.23], [1, 0.3], [2, 0.001], [3, -0.5]] - } -} - -``` - - - - - - - -format\_lime\_results(*results*)[#](#arthurai.explainability.arthur_explainer.ArthurExplainer.format_lime_results "Permalink to this definition") -LIME’s .as\_map() method returns scores looking like the following: - - - -> -> -> ``` -> { -> 0:[ -> (3, -0.1614709564346036), -> (2, -0.12871035938256958), -> (0, -0.011225126011010974), -> (1, 0.009948039509525414) -> ], -> 1:[ -> (2, -0.0914379318506283), -> (3, -0.06513690080871648), -> (0, -0.009164069675758498), -> (1, 0.003622751782692439) -> ], -> 2:[ -> (3, 0.2266078572433201), -> (2, 0.22014829123319787), -> (0, 0.02038919568676947), -> (1, -0.013570791292217853) -> ] -> } -> -> ``` -> -> -> - - -Where the keys are the class labels, and the values are lists of feature index, score tuples for that class. - - -This method unpacks the result to a list of lists for EACH explanation: - - - -> -> -> ``` -> [ -> [-0.011, 0.009, -0.128, -0.161], -> [-0.009, 0.003, -0.091, -0.065], -> [0.02, -0.013, 0.220, 0.226] -> ] -> -> ``` -> -> -> - - -For regression, this will return a list of lists for one class per inference: - - - -> -> -> ``` -> [ -> [-0.011, 0.009, -0.128, -0.161] -> ] -> -> ``` -> -> -> - - - -Return type -`List`[`List`[`List`[`float`]]] - - - - - - - -*static* format\_lime\_results\_for\_one\_class(*feature\_index\_score\_pairs*)[#](#arthurai.explainability.arthur_explainer.ArthurExplainer.format_lime_results_for_one_class "Permalink to this definition") -This method unpacks the results for a single classes’s explanation: - - - -> -> -> ``` -> [ -> (3, -0.1614709564346036), -> (2, -0.12871035938256958), -> (0, -0.011225126011010974), -> (1, 0.009948039509525414) -> ] -> -> ``` -> -> -> - - - -Return type -`List`[`float`] - - - -Returns -unpacked lime results for a single class - - - -``` -[-0.011, 0.009, -0.128, -0.161] - -``` - - - - - - - -format\_lime\_text\_results(*results*)[#](#arthurai.explainability.arthur_explainer.ArthurExplainer.format_lime_text_results "Permalink to this definition") -Format LIME results for Text models - - -LIME’s .as\_map() method returns scores looking like the following: - - - -``` -{0: [('I', -0.1614709564346036), ('a', -0.12871035938256958), ('am', -0.011225126011010974), ('developer', 0.009948039509525414)], - 1: [('am', -0.0914379318506283), ('a', -0.06513690080871648), ('I', -0.009164069675758498), ('developer', 0.003622751782692439)], - 2: [('developer', 0.2266078572433201), ('am', 0.22014829123319787), ('a', 0.02038919568676947), ('I', -0.013570791292217853)]} - -``` - - -Where the keys are the class labels, and the values are lists of word, score tuples for that class. - - -This method unpacks the result to a list of lists for EACH explanation: - - - -``` -[ - [['I', -0.011], ['am', 0.009], ['a', -0.128], ['developer', -0.161]], - [['I', -0.02], ['am', 0.007], ['a', -0.8], ['developer', 0.11]], - [['I', -0.03], ['am', 0.89], ['a', -0.28], ['developer', -0.16]] -] - -``` - - -For regression, this will return a list of lists for one class per inference: - - - -``` -[ - [['I', -0.011], ['am', 0.009], ['a', -0.128], ['developer', -0.161]] -] - -``` - - - -Return type -`List`[`List`[`List`[`List`[`float`]]]] - - - -Returns -formatted results in the following format - - - -``` -[ - [['I', -0.011], ['am', 0.009], ['a', -0.128], ['developer', -0.161]], - [['I', -0.02], ['am', 0.007], ['a', -0.8], ['developer', 0.11]], - [['I', -0.03], ['am', 0.89], ['a', -0.28], ['developer', -0.16]] -] - -``` - - - - - - - -predict\_tabular(*input\_feature\_vectors*)[#](#arthurai.explainability.arthur_explainer.ArthurExplainer.predict_tabular "Permalink to this definition") -Takes in customer provided data and returns the prediction values as numpy array (both regression and classification) - - - -Return type -`ndarray` - - - - - - - -predict\_wrapper(*encoded\_feature\_vectors*)[#](#arthurai.explainability.arthur_explainer.ArthurExplainer.predict_wrapper "Permalink to this definition") -Wraps user supplied predict function. Handles decoding back into original format. -For binary classifiers, checks the output size and reshapes to two dimensions if necessary - - - -Return type -`ndarray` - - - - - - - -shap\_expected\_values()[#](#arthurai.explainability.arthur_explainer.ArthurExplainer.shap_expected_values "Permalink to this definition") -Returns expected values from the shap explainer for this model input type - - - -Return type -`List`[`float`] - - - - - - - - - - - -[Next - -arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) -[Previous - -arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.explainability.arthur_explainer.md.txt b/files/arthur-docs-markdown/sdk/arthurai.explainability.arthur_explainer.md.txt deleted file mode 100644 index f4f3dac98560b6e3f16c186007e25cc786f17044..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.explainability.arthur_explainer.md.txt +++ /dev/null @@ -1,413 +0,0 @@ - - - - - - -arthurai.explainability.arthur\_explainer - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](#)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.explainability.arthur\_explainer[#](#module-arthurai.explainability.arthur_explainer "Permalink to this headline") -=========================================================================================================================== - - -Classes - - - - - - - - -| [`ArthurExplainer`](arthurai.explainability.arthur_explainer.ArthurExplainer.html#arthurai.explainability.arthur_explainer.ArthurExplainer "arthurai.explainability.arthur_explainer.ArthurExplainer")(model\_type, ...[, ...]) | Class for explaining inferences with a variety of libs | -| [`EmptyLimeExplanation`](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html#arthurai.explainability.arthur_explainer.EmptyLimeExplanation "arthurai.explainability.arthur_explainer.EmptyLimeExplanation")(class\_int\_labels, ...) | Class for representing an all-NaN LIME Explanation. | - - - - - - - - -[Next - -arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) -[Previous - -arthurai.explainability](arthurai.explainability.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.explainability.explanation_packager.ExplanationPackager.md.txt b/files/arthur-docs-markdown/sdk/arthurai.explainability.explanation_packager.ExplanationPackager.md.txt deleted file mode 100644 index 925e6f393a1ac6b4a07ab7fafdbac71ea261b3ea..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.explainability.explanation_packager.ExplanationPackager.md.txt +++ /dev/null @@ -1,627 +0,0 @@ - - - - - - -arthurai.explainability.explanation\_packager.ExplanationPackager - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](#) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.explainability.explanation\_packager.ExplanationPackager[#](#arthurai-explainability-explanation-packager-explanationpackager "Permalink to this headline") -==================================================================================================================================================================== - - - - -*class* arthurai.explainability.explanation\_packager.ExplanationPackager(*model*, *\*\*kwargs*)[#](#arthurai.explainability.explanation_packager.ExplanationPackager "Permalink to this definition") -Bases: `object` - - -Manages the project source code and explainer for this model. -Intended only for internal use. Used to create explainer object, package files and format config for the -update enrichments API endpoint. - - -See model.update\_enrichments() for more details on usage - - -Methods - - - - - - - - -| [`build\_categorical\_lookup\_table`](#arthurai.explainability.explanation_packager.ExplanationPackager.build_categorical_lookup_table "arthurai.explainability.explanation_packager.ExplanationPackager.build_categorical_lookup_table") | Builds the lookup table that ArthurExplainer needs for encoding strings | -| [`contains\_file\_fields`](#arthurai.explainability.explanation_packager.ExplanationPackager.contains_file_fields "arthurai.explainability.explanation_packager.ExplanationPackager.contains_file_fields") | Returns (onePresent, allPresent) onePresent is true if at least one file field was supplied AllPresent is true if all file fields are supplied | -| [`copy\_files`](#arthurai.explainability.explanation_packager.ExplanationPackager.copy_files "arthurai.explainability.explanation_packager.ExplanationPackager.copy_files") | Copy the files that are required for testing the docker image. | -| [`create`](#arthurai.explainability.explanation_packager.ExplanationPackager.create "arthurai.explainability.explanation_packager.ExplanationPackager.create") | Create an explainer for this model. | -| [`create\_test\_script`](#arthurai.explainability.explanation_packager.ExplanationPackager.create_test_script "arthurai.explainability.explanation_packager.ExplanationPackager.create_test_script") | Create a test script. | -| [`get\_request\_config`](#arthurai.explainability.explanation_packager.ExplanationPackager.get_request_config "arthurai.explainability.explanation_packager.ExplanationPackager.get_request_config") | Generates config dict for explainer. | -| [`get\_request\_files`](#arthurai.explainability.explanation_packager.ExplanationPackager.get_request_files "arthurai.explainability.explanation_packager.ExplanationPackager.get_request_files") | Returns files needed for request, for use with model.update\_enrichments | -| [`make\_zip`](#arthurai.explainability.explanation_packager.ExplanationPackager.make_zip "arthurai.explainability.explanation_packager.ExplanationPackager.make_zip") | Create the zip file for the project directory. | -| [`test`](#arthurai.explainability.explanation_packager.ExplanationPackager.test "arthurai.explainability.explanation_packager.ExplanationPackager.test") | Download the docker container, install the files, and make sure the predict function can be run. | -| [`validate\_requirements\_add\_sklearn`](#arthurai.explainability.explanation_packager.ExplanationPackager.validate_requirements_add_sklearn "arthurai.explainability.explanation_packager.ExplanationPackager.validate_requirements_add_sklearn") | Checks the user requirements file to make sure versions are correct. | - - - -Attributes - - - - - - - - -| `FILE\_FIELDS` | | - - - - - -build\_categorical\_lookup\_table()[#](#arthurai.explainability.explanation_packager.ExplanationPackager.build_categorical_lookup_table "Permalink to this definition") -Builds the lookup table that ArthurExplainer needs for encoding strings - - - -Return type -`List`[`Optional`[`Dict`[`str`, `int`]]] - - - - - - - -contains\_file\_fields()[#](#arthurai.explainability.explanation_packager.ExplanationPackager.contains_file_fields "Permalink to this definition") -Returns (onePresent, allPresent) -onePresent is true if at least one file field was supplied -AllPresent is true if all file fields are supplied - - - -Return type -`Tuple`[`bool`, `bool`] - - - - - - - -copy\_files(*example*)[#](#arthurai.explainability.explanation_packager.ExplanationPackager.copy_files "Permalink to this definition") -Copy the files that are required for testing the docker image. - - - -Param -example: the example to use in the test script - - - -Return type -`None` - - - - - - - -create()[#](#arthurai.explainability.explanation_packager.ExplanationPackager.create "Permalink to this definition") -Create an explainer for this model. - - - -Param -df: the training data for the explainer - - - -Param -shap\_nrows: number of rows to sample the dataframe passed in - - - -Return type -`None` - - - - - - - -create\_test\_script(*example*)[#](#arthurai.explainability.explanation_packager.ExplanationPackager.create_test_script "Permalink to this definition") -Create a test script. - - - -Param -example:the example to use in the test script - - - -Return type -`str` - - - -Returns -the script contents - - - - - - - -get\_request\_config()[#](#arthurai.explainability.explanation_packager.ExplanationPackager.get_request_config "Permalink to this definition") -Generates config dict for explainer. For use with model.update\_enrichments - - - -Return type -`Dict`[`str`, `str`] - - - - - - - -get\_request\_files()[#](#arthurai.explainability.explanation_packager.ExplanationPackager.get_request_files "Permalink to this definition") -Returns files needed for request, for use with model.update\_enrichments - - - -Return type -`List`[`Any`] - - - - - - - -make\_zip()[#](#arthurai.explainability.explanation_packager.ExplanationPackager.make_zip "Permalink to this definition") -Create the zip file for the project directory. - - - -Return type -`None` - - - - - - - -test()[#](#arthurai.explainability.explanation_packager.ExplanationPackager.test "Permalink to this definition") -Download the docker container, install the files, and make sure the predict function can be run. - - - -Return type -`None` - - - - - - - -validate\_requirements\_add\_sklearn()[#](#arthurai.explainability.explanation_packager.ExplanationPackager.validate_requirements_add_sklearn "Permalink to this definition") -Checks the user requirements file to make sure versions are correct. - - -Also handles making sure scikit-learn version is pinned in user requirements -file, if it is installed in local environment and not specified. - - -scikit-learn is a dependency of shap, and arthurai doesn’t require scikit-learn explicitly. -This can lead to version A being installed and used locally when pickling explainer, then version B -getting installed on model server as part of shap install. This can lead to pickle errors, -since the pickled version of shap (client side) used a different version of sklearn than what is on model -server. - - - -Return type -`List`[`str`] - - - - - - - - - - - -[Next - -arthurai.explainability.validation](arthurai.explainability.validation.html) -[Previous - -arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.explainability.explanation_packager.md.txt b/files/arthur-docs-markdown/sdk/arthurai.explainability.explanation_packager.md.txt deleted file mode 100644 index 108de7420026f6ea6c7e99dec745d18dc2c45b7d..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.explainability.explanation_packager.md.txt +++ /dev/null @@ -1,412 +0,0 @@ - - - - - - -arthurai.explainability.explanation\_packager - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](#)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.explainability.explanation\_packager[#](#module-arthurai.explainability.explanation_packager "Permalink to this headline") -=================================================================================================================================== - - -Classes - - - - - - - - -| [`ExplanationPackager`](arthurai.explainability.explanation_packager.ExplanationPackager.html#arthurai.explainability.explanation_packager.ExplanationPackager "arthurai.explainability.explanation_packager.ExplanationPackager")(model, \*\*kwargs) | Manages the project source code and explainer for this model. | - - - - - - - - -[Next - -arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) -[Previous - -arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.explainability.md.txt b/files/arthur-docs-markdown/sdk/arthurai.explainability.md.txt deleted file mode 100644 index 14b334b6afbbec79b8e9998f9a4d5e684c9c2635..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.explainability.md.txt +++ /dev/null @@ -1,414 +0,0 @@ - - - - - - -arthurai.explainability - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](#)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.explainability[#](#module-arthurai.explainability "Permalink to this headline") -======================================================================================== - - -Explainability functionality - - - - - - - - -| [`arthurai.explainability.arthur\_explainer`](arthurai.explainability.arthur_explainer.html#module-arthurai.explainability.arthur_explainer "arthurai.explainability.arthur_explainer") | | -| [`arthurai.explainability.explanation\_packager`](arthurai.explainability.explanation_packager.html#module-arthurai.explainability.explanation_packager "arthurai.explainability.explanation_packager") | | -| [`arthurai.explainability.validation`](arthurai.explainability.validation.html#module-arthurai.explainability.validation "arthurai.explainability.validation") | | - - - - - - - - -[Next - -arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html) -[Previous - -arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.explainability.validation.md.txt b/files/arthur-docs-markdown/sdk/arthurai.explainability.validation.md.txt deleted file mode 100644 index aeff4a06f88035c58d0235a1560605b26fc313d2..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.explainability.validation.md.txt +++ /dev/null @@ -1,413 +0,0 @@ - - - - - - -arthurai.explainability.validation - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](#)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.explainability.validation[#](#module-arthurai.explainability.validation "Permalink to this headline") -============================================================================================================== - - -Functions - - - - - - - - -| [`validate\_predicted\_attribute\_order\_matches\_dataframe`](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html#arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe "arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe")(...) | Helper function to check that the order of the predicted attributes matches the output from the user predict() function. | -| [`validate\_predicted\_attribute\_order\_matches\_remote`](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html#arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote "arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote")(model) | Checks that the position field of each predicted attribute matches the value when the model is fetched by ID from the API | - - - - - - - - -[Next - -arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) -[Previous - -arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.md.txt b/files/arthur-docs-markdown/sdk/arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.md.txt deleted file mode 100644 index 01c314048ef4be1513367f768ae3fa33baf84045..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.md.txt +++ /dev/null @@ -1,432 +0,0 @@ - - - - - - -arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](#) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe[#](#arthurai-explainability-validation-validate-predicted-attribute-order-matches-dataframe "Permalink to this headline") -====================================================================================================================================================================================================================== - - - - -arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe(*actual\_preds*, *sample\_data*, *predicted\_attributes*)[#](#arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe "Permalink to this definition") -Helper function to check that the order of the predicted attributes matches the output from the user predict() -function. - - -A common failure case is a user registering a binary classifier with a single positive predicted -attribute, but returning the value of predict\_proba() from their classifier. The result is that the implicit -negative column is registered as the second column (, ) but SkLearn and most other libraries -output with the negative prediction in the first column (, ). - - - -Parameters -* **actual\_preds** (`ndarray`) – predictions pulled from the user’s predict() function -* **sample\_data** (`DataFrame`) – a DataFrame containing user-provided predictions -* **predicted\_attributes** (`List`[[`ArthurAttribute`](arthurai.core.attributes.ArthurAttribute.html#arthurai.core.attributes.ArthurAttribute "arthurai.core.attributes.ArthurAttribute")]) – the model’s predicted attributes - - - -Returns -None - - - -Raises -**UserValueError** – if the prediction order doesn’t match or it cannot be determined - - - - - - - - - - -[Next - -arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) -[Previous - -arthurai.explainability.validation](arthurai.explainability.validation.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.md.txt b/files/arthur-docs-markdown/sdk/arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.md.txt deleted file mode 100644 index 80152df8b2ff515d9af85586fa1ba98b0c9119b7..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.md.txt +++ /dev/null @@ -1,429 +0,0 @@ - - - - - - -arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](#) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote[#](#arthurai-explainability-validation-validate-predicted-attribute-order-matches-remote "Permalink to this headline") -================================================================================================================================================================================================================ - - - - -arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote(*model*)[#](#arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote "Permalink to this definition") -Checks that the position field of each predicted attribute matches the value when the model is fetched by ID from -the API - - - -Parameters -**model** – model to validate - - - -Return type -`None` - - - -Returns -None - - - -Raises -**UserValueError** – if the positions don’t match - - - - - - - - - - -[Next - -arthurai.util](arthurai.util.html) -[Previous - -arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.md.txt b/files/arthur-docs-markdown/sdk/arthurai.md.txt deleted file mode 100644 index 86797aef32b411ce06f2b1f4df2cbd487465b368..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.md.txt +++ /dev/null @@ -1,414 +0,0 @@ - - - - - - -arthurai - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](#)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai[#](#module-arthurai "Permalink to this headline") -========================================================== - - - - - - - - -| [`arthurai.client`](arthurai.client.html#module-arthurai.client "arthurai.client") | Arthur HTTP client and general (non-model) functions | -| [`arthurai.common`](arthurai.common.html#module-arthurai.common "arthurai.common") | Constants, exceptions, and logging for use in other packages | -| [`arthurai.core`](arthurai.core.html#module-arthurai.core "arthurai.core") | Primary ArthurAI functionality | -| [`arthurai.explainability`](arthurai.explainability.html#module-arthurai.explainability "arthurai.explainability") | Explainability functionality | -| [`arthurai.util`](arthurai.util.html#module-arthurai.util "arthurai.util") | | -| [`arthurai.version`](arthurai.version.html#module-arthurai.version "arthurai.version") | | - - - - - - - - -[Next - -arthurai.client](arthurai.client.html) -[Previous - -Permissions by Function](../permissions.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.util.format_timestamp.md.txt b/files/arthur-docs-markdown/sdk/arthurai.util.format_timestamp.md.txt deleted file mode 100644 index 61e3aa1bfd3277178867c6dcc617492d27081840..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.util.format_timestamp.md.txt +++ /dev/null @@ -1,437 +0,0 @@ - - - - - - -arthurai.util.format\_timestamp - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](#) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.util.format\_timestamp[#](#arthurai-util-format-timestamp "Permalink to this headline") -================================================================================================ - - - - -arthurai.util.format\_timestamp(*timestamp*, *tz=None*)[#](#arthurai.util.format_timestamp "Permalink to this definition") -Check if timestamp is time aware and convert to ISO8601 conventioned string. - - -This helper function converts datetime objects into timezone aware ISO8601 strings, which is necessary when sending -JSON to Arthur’s backend. If timestamp argument is timezone aware, no location needs to be provided; otherwise, -a string pytz location like “US/Eastern” needs to be provided to establish timezone. String timestamp are -supported for backwards compatability and for simplicity are assumed to already be in UTC format, but string support -will be deprecated. - - - -Parameters -* **timestamp** (`Union`[`datetime`, `str`]) – timestamp to format -* **tz** (`Union`[`timezone`, `str`, `None`]) – datetime timezone object or timezone string - - - -Return type -`str` - - - -Returns -ISO8601 formatted timestamp - - - -Raises -* **TypeError** – timestamp is not of type datetime.datetime -* **ValueError** – timestamp is not timezone aware and no location data is provided to remedy - - - - - - - - - - -[Next - -arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) -[Previous - -arthurai.util](arthurai.util.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.util.format_timestamps.md.txt b/files/arthur-docs-markdown/sdk/arthurai.util.format_timestamps.md.txt deleted file mode 100644 index ec05b7a33c2b8981ee7cb81f74b9373c34ecbc16..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.util.format_timestamps.md.txt +++ /dev/null @@ -1,431 +0,0 @@ - - - - - - -arthurai.util.format\_timestamps - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](#) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.util.format\_timestamps[#](#arthurai-util-format-timestamps "Permalink to this headline") -================================================================================================== - - - - -arthurai.util.format\_timestamps(*inferences*, *tz=None*, *timestamp\_attributes=None*)[#](#arthurai.util.format_timestamps "Permalink to this definition") -Checks list of json inferences to ensure their timestamps have been converted to ISO8601 conventions. - - - -Parameters -* **inferences** (`List`[`Dict`[`str`, `Any`]]) – Input to send\_inferences() function. -* **tz** (`Union`[`timezone`, `str`, `None`]) – datetime timezone object or timezone string -* **timestamp\_attributes** (`Optional`[`List`[`str`]]) – List of attributes of the model of timestamp type - - - -Return type -`List`[`Dict`[`str`, `Any`]] - - - -Returns -updated list of json inferences with ISO8601 formatted timestamps - - - -Raises -* **TypeError** – timestamp is not of type datetime.datetime -* **ValueError** – timestamp is not timezone aware and no location data is provided to remedy - - - - - - - - - - -[Next - -arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) -[Previous - -arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.util.generate_timestamps.md.txt b/files/arthur-docs-markdown/sdk/arthurai.util.generate_timestamps.md.txt deleted file mode 100644 index fbbfa7f4d97da030098af2fb9674787b79af685c..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.util.generate_timestamps.md.txt +++ /dev/null @@ -1,438 +0,0 @@ - - - - - - -arthurai.util.generate\_timestamps - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](#) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.util.generate\_timestamps[#](#arthurai-util-generate-timestamps "Permalink to this headline") -====================================================================================================== - - - - -arthurai.util.generate\_timestamps(*total*, *duration='7d'*, *end='now'*, *freq='D'*, *noisiness=0.3*)[#](#arthurai.util.generate_timestamps "Permalink to this definition") -Generates timestamps over a period of time, defaulting to daily timestamps over the last week. Creates uniques -unique timestamp values evenly spaced between start and end inclusively. Repeats values if -total ≠ uniques. This is useful for generating timestamps for test inferences outside of a production setting. - - - -Parameters -* **total** (`int`) – the total number of timestamps to generate -* **end** (`Union`[`str`, `datetime`]) – the final timestamp value -* **duration** (`Union`[`str`, `timedelta`]) – the difference between the first and last timestamp values. day or hour strings (e.g. “7d”, “4h”) -and timedelta objects are supported -* **freq** (`Union`[`str`, `DateOffset`]) – the frequency with which to generate unique values. See -[Pandas Offset Aliases](https://pandas.pydata.org/docs/user_guide/timeseries.html#offset-aliases) for values -* **noisiness** (`float`) – how much to noise to add to the number of timestamps repeated at each interval. specifically, the -coefficient of variation (standard deviation / mean) to use when selecting the number of times to repeat each -timestamp - - - -Raises -**UserValueError** – if an input is invalid or values contain future timestamps and allow\_future is False - - - -Return type -`List`[`datetime`] - - - -Returns -a list of generated timestamps - - - - - - - - - - -[Next - -arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) -[Previous - -arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.util.md.txt b/files/arthur-docs-markdown/sdk/arthurai.util.md.txt deleted file mode 100644 index 78485867e2226397869a811fbc9e513816687b57..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.util.md.txt +++ /dev/null @@ -1,421 +0,0 @@ - - - - - - -arthurai.util - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](#)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.util[#](#module-arthurai.util "Permalink to this headline") -==================================================================== - - -Functions - - - - - - - - -| [`format\_timestamp`](arthurai.util.format_timestamp.html#arthurai.util.format_timestamp "arthurai.util.format_timestamp")(timestamp[, tz]) | Check if timestamp is time aware and convert to ISO8601 conventioned string. | -| [`format\_timestamps`](arthurai.util.format_timestamps.html#arthurai.util.format_timestamps "arthurai.util.format_timestamps")(inferences[, tz, ...]) | Checks list of json inferences to ensure their timestamps have been converted to ISO8601 conventions. | -| [`generate\_timestamps`](arthurai.util.generate_timestamps.html#arthurai.util.generate_timestamps "arthurai.util.generate_timestamps")(total[, duration, end, ...]) | Generates timestamps over a period of time, defaulting to daily timestamps over the last week. | -| [`is\_valid\_datetime\_string`](arthurai.util.is_valid_datetime_string.html#arthurai.util.is_valid_datetime_string "arthurai.util.is_valid_datetime_string")(dt\_obj) | " | -| [`normal\_random\_ints\_fixed\_sum`](arthurai.util.normal_random_ints_fixed_sum.html#arthurai.util.normal_random_ints_fixed_sum "arthurai.util.normal_random_ints_fixed_sum")(num\_values, ...) | Return num\_values roughly normally-distributed integers summing to total\_sum. | -| [`value\_type\_to\_python\_type`](arthurai.util.value_type_to_python_type.html#arthurai.util.value_type_to_python_type "arthurai.util.value_type_to_python_type")(value\_type) | -rtype -`Type` - - | - - - - - - - - -[Next - -arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) -[Previous - -arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.util.normal_random_ints_fixed_sum.md.txt b/files/arthur-docs-markdown/sdk/arthurai.util.normal_random_ints_fixed_sum.md.txt deleted file mode 100644 index 3c9d86b141d8b8df84f25105c3b736a8c3fdcd7a..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.util.normal_random_ints_fixed_sum.md.txt +++ /dev/null @@ -1,416 +0,0 @@ - - - - - - -arthurai.util.normal\_random\_ints\_fixed\_sum - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](#) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.util.normal\_random\_ints\_fixed\_sum[#](#arthurai-util-normal-random-ints-fixed-sum "Permalink to this headline") -=========================================================================================================================== - - - - -arthurai.util.normal\_random\_ints\_fixed\_sum(*num\_values*, *total\_sum*, *relative\_std\_dev=0.5*)[#](#arthurai.util.normal_random_ints_fixed_sum "Permalink to this definition") -Return num\_values roughly normally-distributed integers summing to total\_sum. Numbers are first sampled from -the normal distribution, then adjusted to fit the sum. Adjustments are made first by shifting the resulting -distribution to be at least total\_sum, then decrementing a subset of the values to match total\_sum. -:type num\_values: `int` -:param num\_values: number of integers to return -:type total\_sum: `int` -:param total\_sum: total sum the integers returned -:type relative\_std\_dev: `float` -:param relative\_std\_dev: the relative standard deviation (std\_dev / mean) of the initial distribution. -:rtype: `ndarray` -:return: - - - - - - - - -[Next - -arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) -[Previous - -arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.util.value_type_to_python_type.md.txt b/files/arthur-docs-markdown/sdk/arthurai.util.value_type_to_python_type.md.txt deleted file mode 100644 index 2f0a64cc6746081d7b6ab15e5a0e490d454ca844..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.util.value_type_to_python_type.md.txt +++ /dev/null @@ -1,410 +0,0 @@ - - - - - - -arthurai.util.value\_type\_to\_python\_type - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](#) - + [arthurai.version](arthurai.version.html) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.util.value\_type\_to\_python\_type[#](#arthurai-util-value-type-to-python-type "Permalink to this headline") -===================================================================================================================== - - - - -arthurai.util.value\_type\_to\_python\_type(*value\_type*)[#](#arthurai.util.value_type_to_python_type "Permalink to this definition") - -Return type -`Type` - - - - - - - - - - -[Next - -arthurai.version](arthurai.version.html) -[Previous - -arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - - diff --git a/files/arthur-docs-markdown/sdk/arthurai.version.md.txt b/files/arthur-docs-markdown/sdk/arthurai.version.md.txt deleted file mode 100644 index f8499cf470e3e8d0b39c39df6292e47c7ebb3102..0000000000000000000000000000000000000000 --- a/files/arthur-docs-markdown/sdk/arthurai.version.md.txt +++ /dev/null @@ -1,396 +0,0 @@ - - - - - - -arthurai.version - Arthur SDK Reference documentation - - - - - - body { - --color-code-background: #f8f8f8; - --color-code-foreground: black; - --color-foreground-primary: #1a0016; - --color-foreground-secondary: #473351; - --color-background-primary: #ffffff; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #e4e0e4; - --color-background-border: #e4e0e4; - --color-inline-code-background: #e4e0e4; - --color-icon: #473351; - --color-toc-item-text: #1a0016; - --color-toc-item-text--active: #473351; - --color-highlight-on-target: #c7fdd1; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #e4e0e4; - - } - @media not print { - body[data-theme="dark"] { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - @media (prefers-color-scheme: dark) { - body:not([data-theme="light"]) { - --color-code-background: #202020; - --color-code-foreground: #d0d0d0; - --color-foreground-primary: #ffffff; - --color-foreground-secondary: #e4e0e4; - --color-background-primary: #1a0016; - --color-background-secondary: #473351; - --color-brand-primary: #b536fb; - --color-api-background: #473351; - --color-background-border: #473351; - --color-inline-code-background: #473351; - --color-icon: #e4e0e4; - --color-toc-item-text: #ffffff; - --color-toc-item-text--active: #e4e0e4; - --color-highlight-on-target: #473351; - --color-brand-content: #329ad7; - --color-sidebar-background: #473351; - --color-sidebar-link-text: #ffffff; - --color-sidebar-link-text--top-level: #c7fdd1; - --color-sidebar-item-background--hover: #ffffff; - --color-sidebar-text--hover: #1a0016; - --color-sidebar-search-text: #ffffff; - --color-sidebar-search-border: #e4e0e4; - --color-sidebar-search-foreground: #1a0016; - --color-sidebar-search-foreground--inactive: #e4e0e4; - --color-sidebar-search-background--focus: #ffffff; - --font-stack: Graphik, sans-serif; - --font-stack--monospace: IBM Plex Mono, monospace; - --color-table-header-background: #473351; - - } - } - } - - - - document.body.dataset.theme = localStorage.getItem("theme") || "auto"; - - - -Contents - - - - - -Menu - - - - - - - -Expand - - - - - -Light mode - - - - - - - - - - - - - -Dark mode - - - - - - -Auto light/dark mode - - - - - - - - - - - - - - -Hide navigation sidebar - - -Hide table of contents sidebar - - - - - -Toggle site navigation sidebar - - - - -[Arthur SDK Reference documentation](../index.html) - - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - - -[![Light Logo](../_static/images/dark-mode-logo.svg) -![Dark Logo](../_static/images/dark-mode-logo.svg)](../index.html) - - - - - -* [Arthur Docs](https://docs.arthur.ai) -* [SDK Home](../index.html) -* [Permissions by Function](../permissions.html) -* [arthurai](arthurai.html)Toggle child pages in navigation - + [arthurai.client](arthurai.client.html)Toggle child pages in navigation - - [arthurai.client.apiv3](arthurai.client.apiv3.html) - - [arthurai.client.client](arthurai.client.client.html)Toggle child pages in navigation - * [arthurai.client.client.new\_requests\_client](arthurai.client.client.new_requests_client.html) - * [arthurai.client.client.ArthurAI](arthurai.client.client.ArthurAI.html) - - [arthurai.client.helper](arthurai.client.helper.html)Toggle child pages in navigation - * [arthurai.client.helper.construct\_url](arthurai.client.helper.construct_url.html) - * [arthurai.client.helper.get\_arthur\_internal\_user\_org](arthurai.client.helper.get_arthur_internal_user_org.html) - * [arthurai.client.helper.get\_auth\_info](arthurai.client.helper.get_auth_info.html) - * [arthurai.client.helper.get\_current\_org](arthurai.client.helper.get_current_org.html) - * [arthurai.client.helper.user\_login](arthurai.client.helper.user_login.html) - - [arthurai.client.http](arthurai.client.http.html)Toggle child pages in navigation - * [arthurai.client.http.arthur](arthurai.client.http.arthur.html)Toggle child pages in navigation - + [arthurai.client.http.arthur.ArthurHTTPClient](arthurai.client.http.arthur.ArthurHTTPClient.html) - * [arthurai.client.http.base](arthurai.client.http.base.html)Toggle child pages in navigation - + [arthurai.client.http.base.AbstractHTTPClient](arthurai.client.http.base.AbstractHTTPClient.html) - * [arthurai.client.http.requests](arthurai.client.http.requests.html)Toggle child pages in navigation - + [arthurai.client.http.requests.HTTPClient](arthurai.client.http.requests.HTTPClient.html) - - [arthurai.client.validation](arthurai.client.validation.html)Toggle child pages in navigation - * [arthurai.client.validation.validate\_multistatus\_response\_and\_get\_failures](arthurai.client.validation.validate_multistatus_response_and_get_failures.html) - * [arthurai.client.validation.validate\_response\_status](arthurai.client.validation.validate_response_status.html) - + [arthurai.common](arthurai.common.html)Toggle child pages in navigation - - [arthurai.common.constants](arthurai.common.constants.html)Toggle child pages in navigation - * [arthurai.common.constants.AccuracyMetric](arthurai.common.constants.AccuracyMetric.html) - * [arthurai.common.constants.Enrichment](arthurai.common.constants.Enrichment.html) - * [arthurai.common.constants.ImageContentType](arthurai.common.constants.ImageContentType.html) - * [arthurai.common.constants.ImageResponseType](arthurai.common.constants.ImageResponseType.html) - * [arthurai.common.constants.InputType](arthurai.common.constants.InputType.html) - * [arthurai.common.constants.ListableStrEnum](arthurai.common.constants.ListableStrEnum.html) - * [arthurai.common.constants.OutputType](arthurai.common.constants.OutputType.html) - * [arthurai.common.constants.Role](arthurai.common.constants.Role.html) - * [arthurai.common.constants.Stage](arthurai.common.constants.Stage.html) - * [arthurai.common.constants.TextDelimiter](arthurai.common.constants.TextDelimiter.html) - * [arthurai.common.constants.ValueType](arthurai.common.constants.ValueType.html) - - [arthurai.common.exceptions](arthurai.common.exceptions.html)Toggle child pages in navigation - * [arthurai.common.exceptions.arthur\_excepted](arthurai.common.exceptions.arthur_excepted.html) - - [arthurai.common.log](arthurai.common.log.html)Toggle child pages in navigation - * [arthurai.common.log.disable\_debug\_logging](arthurai.common.log.disable_debug_logging.html) - * [arthurai.common.log.enable\_debug\_logging](arthurai.common.log.enable_debug_logging.html) - * [arthurai.common.log.initialize\_logging](arthurai.common.log.initialize_logging.html) - * [arthurai.common.log.InfoFilter](arthurai.common.log.InfoFilter.html) - + [arthurai.core](arthurai.core.html)Toggle child pages in navigation - - [arthurai.core.alerts](arthurai.core.alerts.html)Toggle child pages in navigation - * [arthurai.core.alerts.Alert](arthurai.core.alerts.Alert.html) - * [arthurai.core.alerts.AlertRule](arthurai.core.alerts.AlertRule.html) - * [arthurai.core.alerts.AlertRuleBound](arthurai.core.alerts.AlertRuleBound.html) - * [arthurai.core.alerts.AlertRuleSeverity](arthurai.core.alerts.AlertRuleSeverity.html) - * [arthurai.core.alerts.AlertStatus](arthurai.core.alerts.AlertStatus.html) - * [arthurai.core.alerts.Metric](arthurai.core.alerts.Metric.html) - * [arthurai.core.alerts.MetricType](arthurai.core.alerts.MetricType.html) - - [arthurai.core.attributes](arthurai.core.attributes.html)Toggle child pages in navigation - * [arthurai.core.attributes.ArthurAttribute](arthurai.core.attributes.ArthurAttribute.html) - * [arthurai.core.attributes.AttributeBin](arthurai.core.attributes.AttributeBin.html) - * [arthurai.core.attributes.AttributeCategory](arthurai.core.attributes.AttributeCategory.html) - - [arthurai.core.auth\_info](arthurai.core.auth_info.html)Toggle child pages in navigation - * [arthurai.core.auth\_info.AuthInfo](arthurai.core.auth_info.AuthInfo.html) - - [arthurai.core.base](arthurai.core.base.html)Toggle child pages in navigation - * [arthurai.core.base.ArthurBaseJsonDataclass](arthurai.core.base.ArthurBaseJsonDataclass.html) - - [arthurai.core.bias](arthurai.core.bias.html)Toggle child pages in navigation - * [arthurai.core.bias.bias\_metrics](arthurai.core.bias.bias_metrics.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_metrics.BiasMetrics](arthurai.core.bias.bias_metrics.BiasMetrics.html) - * [arthurai.core.bias.bias\_wrapper](arthurai.core.bias.bias_wrapper.html)Toggle child pages in navigation - + [arthurai.core.bias.bias\_wrapper.ArthurBiasWrapper](arthurai.core.bias.bias_wrapper.ArthurBiasWrapper.html) - * [arthurai.core.bias.threshold\_mitigation](arthurai.core.bias.threshold_mitigation.html)Toggle child pages in navigation - + [arthurai.core.bias.threshold\_mitigation.Curves](arthurai.core.bias.threshold_mitigation.Curves.html) - + [arthurai.core.bias.threshold\_mitigation.ThresholdMitigation](arthurai.core.bias.threshold_mitigation.ThresholdMitigation.html) - - [arthurai.core.data\_service](arthurai.core.data_service.html)Toggle child pages in navigation - * [arthurai.core.data\_service.DatasetService](arthurai.core.data_service.DatasetService.html) - * [arthurai.core.data\_service.ImageZipper](arthurai.core.data_service.ImageZipper.html) - - [arthurai.core.decorators](arthurai.core.decorators.html)Toggle child pages in navigation - * [arthurai.core.decorators.log\_prediction](arthurai.core.decorators.log_prediction.html) - - [arthurai.core.inferences](arthurai.core.inferences.html)Toggle child pages in navigation - * [arthurai.core.inferences.add\_inference\_metadata\_to\_dataframe](arthurai.core.inferences.add_inference_metadata_to_dataframe.html) - * [arthurai.core.inferences.add\_predictions\_or\_ground\_truth](arthurai.core.inferences.add_predictions_or_ground_truth.html) - * [arthurai.core.inferences.nest\_inference\_and\_ground\_truth\_data](arthurai.core.inferences.nest_inference_and_ground_truth_data.html) - * [arthurai.core.inferences.parse\_stage\_attributes](arthurai.core.inferences.parse_stage_attributes.html) - - [arthurai.core.model\_utils](arthurai.core.model_utils.html)Toggle child pages in navigation - * [arthurai.core.model\_utils.check\_attr\_is\_bias](arthurai.core.model_utils.check_attr_is_bias.html) - * [arthurai.core.model\_utils.check\_has\_bias\_attrs](arthurai.core.model_utils.check_has_bias_attrs.html) - * [arthurai.core.model\_utils.get\_positive\_predicted\_class](arthurai.core.model_utils.get_positive_predicted_class.html) - - [arthurai.core.models](arthurai.core.models.html)Toggle child pages in navigation - * [arthurai.core.models.ArthurModel](arthurai.core.models.ArthurModel.html) - * [arthurai.core.models.ArthurModelGroup](arthurai.core.models.ArthurModelGroup.html) - * [arthurai.core.models.ExplainabilityParameters](arthurai.core.models.ExplainabilityParameters.html) - - [arthurai.core.util](arthurai.core.util.html)Toggle child pages in navigation - * [arthurai.core.util.dataframe\_like\_to\_list\_of\_dicts](arthurai.core.util.dataframe_like_to_list_of_dicts.html) - * [arthurai.core.util.intersection\_is\_non\_empty](arthurai.core.util.intersection_is_non_empty.html) - * [arthurai.core.util.retrieve\_parquet\_files](arthurai.core.util.retrieve_parquet_files.html) - * [arthurai.core.util.standardize\_pd\_obj](arthurai.core.util.standardize_pd_obj.html) - * [arthurai.core.util.update\_column\_in\_list\_of\_dicts](arthurai.core.util.update_column_in_list_of_dicts.html) - * [arthurai.core.util.NumpyEncoder](arthurai.core.util.NumpyEncoder.html) - - [arthurai.core.viz](arthurai.core.viz.html)Toggle child pages in navigation - * [arthurai.core.viz.style](arthurai.core.viz.style.html) - * [arthurai.core.viz.utils](arthurai.core.viz.utils.html)Toggle child pages in navigation - + [arthurai.core.viz.utils.get\_pred\_and\_gt\_attrs](arthurai.core.viz.utils.get_pred_and_gt_attrs.html) - + [arthurai.core.viz.utils.savgol\_filter](arthurai.core.viz.utils.savgol_filter.html) - * [arthurai.core.viz.visualizer](arthurai.core.viz.visualizer.html)Toggle child pages in navigation - + [arthurai.core.viz.visualizer.DataVisualizer](arthurai.core.viz.visualizer.DataVisualizer.html) - + [arthurai.explainability](arthurai.explainability.html)Toggle child pages in navigation - - [arthurai.explainability.arthur\_explainer](arthurai.explainability.arthur_explainer.html)Toggle child pages in navigation - * [arthurai.explainability.arthur\_explainer.ArthurExplainer](arthurai.explainability.arthur_explainer.ArthurExplainer.html) - * [arthurai.explainability.arthur\_explainer.EmptyLimeExplanation](arthurai.explainability.arthur_explainer.EmptyLimeExplanation.html) - - [arthurai.explainability.explanation\_packager](arthurai.explainability.explanation_packager.html)Toggle child pages in navigation - * [arthurai.explainability.explanation\_packager.ExplanationPackager](arthurai.explainability.explanation_packager.ExplanationPackager.html) - - [arthurai.explainability.validation](arthurai.explainability.validation.html)Toggle child pages in navigation - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_dataframe](arthurai.explainability.validation.validate_predicted_attribute_order_matches_dataframe.html) - * [arthurai.explainability.validation.validate\_predicted\_attribute\_order\_matches\_remote](arthurai.explainability.validation.validate_predicted_attribute_order_matches_remote.html) - + [arthurai.util](arthurai.util.html)Toggle child pages in navigation - - [arthurai.util.format\_timestamp](arthurai.util.format_timestamp.html) - - [arthurai.util.format\_timestamps](arthurai.util.format_timestamps.html) - - [arthurai.util.generate\_timestamps](arthurai.util.generate_timestamps.html) - - [arthurai.util.is\_valid\_datetime\_string](arthurai.util.is_valid_datetime_string.html) - - [arthurai.util.normal\_random\_ints\_fixed\_sum](arthurai.util.normal_random_ints_fixed_sum.html) - - [arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - + [arthurai.version](#) - - - - - - - - - - -[Back to top](#) - - - -Toggle Light / Dark / Auto color theme - - - - - - -Toggle table of contents sidebar - - - - - -arthurai.version[#](#module-arthurai.version "Permalink to this headline") -========================================================================== - - - - - - - -[Previous - -arthurai.util.value\_type\_to\_python\_type](arthurai.util.value_type_to_python_type.html) - - - - - Copyright © 2022, Arthur - - Made with [Sphinx](https://www.sphinx-doc.org/) and [@pradyunsg](https://pradyunsg.me)'s - - [Furo](https://github.com/pradyunsg/furo) - - - - - - - - - - - - - - - - -