whylogs.api.writer.whylabs_estimation_result_writer#

Module Contents#

Classes#

WhyLabsEstimationResultWriter

Base class for WhyLabs writers

Attributes#

whylogs.api.writer.whylabs_estimation_result_writer.logger#
class whylogs.api.writer.whylabs_estimation_result_writer.WhyLabsEstimationResultWriter(org_id: Optional[str] = None, api_key: Optional[str] = None, dataset_id: Optional[str] = None, api_client: Optional[whylabs_client.ApiClient] = None, ssl_ca_cert: Optional[str] = None, _timeout_seconds: Optional[float] = None, whylabs_client: Optional[whylogs.api.writer.whylabs_client.WhyLabsClient] = None)#

Bases: whylogs.api.writer.whylabs_base.WhyLabsWriterBase

Base class for WhyLabs writers

Parameters
property key_id: str#
Return type

str

write(file: whylogs.api.writer.writer.Writable, dest: Optional[str] = None, **kwargs: Any) Tuple[bool, Union[str, List[Tuple[bool, str]]]]#

Calls Writable::write() to serialize the Wriable file to temporary file(s), then “sends” the temporary file(s) to dest according to the type of Writer. If dest is None, it uses the Writer’s default destination.

kwargs:

zip: bool Create a ZipFile containing the Writable’s file(s) if the Writer supports it zip_name: str Name of the ZipFile, will be auto-generated if None

Parameters
Return type

Tuple[bool, Union[str, List[Tuple[bool, str]]]]

transaction_status() Dict[str, Any]#
Return type

Dict[str, Any]

check_interval(interval_seconds: int) None#

Validate an interval configuration for a given writer.

Some writers only accepts certain interval configuration. Raise BadConfigError for an unacceptable interval.

Parameters

interval_seconds (int) –

Return type

None

option(**kwargs) whylogs.api.writer.writer.Writer#
Parameters
  • ID (org_id the organization) –

  • Id (dataset_id the dataset) –

  • key (api_key the API) –

  • profile (reference_profile_name the name of the reference) –

  • client (configuration the additional configuration for the REST) –

  • transaction (transaction_id to ID of currently active) –

  • org_id (Optional[str] = None,) –

  • dataset_id (Optional[str] = None,) –

  • api_key (Optional[str] = None,) –

  • reference_profile_name (Optional[str] = None,) –

  • configuration (Optional[Configuration] = None,) –

  • transaction_id (Optional[str] = None,) –

  • ssl_ca_cert (Optional[str] = None,) –

  • api_client (Optional[ApiClient] = None,) –

  • timeout_seconds (Optional[float] = None,) –

  • prefer_sync (Optional[bool] = None,) –

  • configured (Returns a "WhyLabsWriter" with these options) –

  • -------

Return type

whylogs.api.writer.writer.Writer