`whylogs.api.whylabs.session.session`#

Module Contents#

Classes#

`UploadResult`
`Session`	Helper class that provides a standard way to create an ABC using
`GuestSession`	Helper class that provides a standard way to create an ABC using
`LocalSession`	Helper class that provides a standard way to create an ABC using
`ApiKeySession`	Helper class that provides a standard way to create an ABC using

Attributes#

whylogs.api.whylabs.session.session.logger#

class whylogs.api.whylabs.session.session.UploadResult#

result: Optional[Any]#

viewing_url: str#: The url to view uploaded profiles individually if this was a batch upload

individual_viewing_urls: Optional[List[str]]#

class whylogs.api.whylabs.session.session.Session(session_config: whylogs.api.whylabs.session.config.SessionConfig)#

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

Parameters: session_config (whylogs.api.whylabs.session.config.SessionConfig) –

get_type() → whylogs.api.whylabs.session.session_types.SessionType#

Return type: whylogs.api.whylabs.session.session_types.SessionType

get_config() → whylogs.api.whylabs.session.config.SessionConfig#

Return type: whylogs.api.whylabs.session.config.SessionConfig

abstract upload_reference_profiles(profile_aliases: Dict[str, whylogs.api.logger.result_set.ResultSet]) → Union[UploadResult, whylogs.api.whylabs.session.session_types.NotSupported]#

Parameters: profile_aliases (Dict[str, whylogs.api.logger.result_set.ResultSet]) –
Return type: Union[UploadResult, whylogs.api.whylabs.session.session_types.NotSupported]

abstract upload_batch_profile(result_set: whylogs.api.logger.result_set.ResultSet) → Union[UploadResult, whylogs.api.whylabs.session.session_types.NotSupported]#

Parameters: result_set (whylogs.api.logger.result_set.ResultSet) –
Return type: Union[UploadResult, whylogs.api.whylabs.session.session_types.NotSupported]

class whylogs.api.whylabs.session.session.GuestSession(config: whylogs.api.whylabs.session.config.SessionConfig)#

Bases: Session

Helper class that provides a standard way to create an ABC using inheritance.

Parameters: config (whylogs.api.whylabs.session.config.SessionConfig) –

upload_batch_profile(result_set: whylogs.api.logger.result_set.ResultSet) → Union[UploadResult, whylogs.api.whylabs.session.session_types.NotSupported]#

Parameters: result_set (whylogs.api.logger.result_set.ResultSet) –
Return type: Union[UploadResult, whylogs.api.whylabs.session.session_types.NotSupported]

upload_reference_profiles(profile_aliases: Dict[str, whylogs.api.logger.result_set.ResultSet]) → Union[UploadResult, whylogs.api.whylabs.session.session_types.NotSupported]#

Parameters: profile_aliases (Dict[str, whylogs.api.logger.result_set.ResultSet]) –
Return type: Union[UploadResult, whylogs.api.whylabs.session.session_types.NotSupported]

get_type() → whylogs.api.whylabs.session.session_types.SessionType#

Return type: whylogs.api.whylabs.session.session_types.SessionType

get_config() → whylogs.api.whylabs.session.config.SessionConfig#

Return type: whylogs.api.whylabs.session.config.SessionConfig

class whylogs.api.whylabs.session.session.LocalSession(session_config: whylogs.api.whylabs.session.config.SessionConfig)#

Bases: Session

Helper class that provides a standard way to create an ABC using inheritance.

Parameters: session_config (whylogs.api.whylabs.session.config.SessionConfig) –

upload_reference_profiles(profile_aliases: Dict[str, whylogs.api.logger.result_set.ResultSet]) → Union[UploadResult, whylogs.api.whylabs.session.session_types.NotSupported]#

Parameters: profile_aliases (Dict[str, whylogs.api.logger.result_set.ResultSet]) –
Return type: Union[UploadResult, whylogs.api.whylabs.session.session_types.NotSupported]

upload_batch_profile(profile: whylogs.api.logger.result_set.ResultSet) → Union[UploadResult, whylogs.api.whylabs.session.session_types.NotSupported]#

Parameters: profile (whylogs.api.logger.result_set.ResultSet) –
Return type: Union[UploadResult, whylogs.api.whylabs.session.session_types.NotSupported]

get_type() → whylogs.api.whylabs.session.session_types.SessionType#

Return type: whylogs.api.whylabs.session.session_types.SessionType

get_config() → whylogs.api.whylabs.session.config.SessionConfig#

Return type: whylogs.api.whylabs.session.config.SessionConfig

class whylogs.api.whylabs.session.session.ApiKeySession(config: whylogs.api.whylabs.session.config.SessionConfig)#

Bases: Session

Helper class that provides a standard way to create an ABC using inheritance.

Parameters: config (whylogs.api.whylabs.session.config.SessionConfig) –

upload_reference_profiles(profile_aliases: Dict[str, whylogs.api.logger.result_set.ResultSet]) → Union[UploadResult, whylogs.api.whylabs.session.session_types.NotSupported]#

Parameters: profile_aliases (Dict[str, whylogs.api.logger.result_set.ResultSet]) –
Return type: Union[UploadResult, whylogs.api.whylabs.session.session_types.NotSupported]

upload_batch_profile(profile: whylogs.api.logger.result_set.ResultSet) → Union[UploadResult, whylogs.api.whylabs.session.session_types.NotSupported]#

Parameters: profile (whylogs.api.logger.result_set.ResultSet) –
Return type: Union[UploadResult, whylogs.api.whylabs.session.session_types.NotSupported]

get_type() → whylogs.api.whylabs.session.session_types.SessionType#

Return type: whylogs.api.whylabs.session.session_types.SessionType

get_config() → whylogs.api.whylabs.session.config.SessionConfig#

Return type: whylogs.api.whylabs.session.config.SessionConfig