Skip to main content

stats

atscale.eda.stats.corrcoef​

Returns the correlation of two given features.

  • Parameters:
    • dbconn (SQLConnection) – The database connection to interact with.
    • data_model (DataModel) – The data model corresponding to the features provided.
    • feature1 (str) – The first feature.
    • feature2 (str) – The second feature.
    • granularity_levels (List *[*str ]) – The categorical features corresponding to the level of granularity desired in the given features.
    • if_exists (enums.TableExistsAction , optional) – The default action that taken when creating a table with a preexisting name. Does not accept APPEND. Defaults to ERROR.
    • write_database (str) – The database that this functionality will write tables to. Defaults to the database associated with the given dbconn.
    • write_schema (str) – The schema that this functionality will write tables to. Defaults to the database associated with the given dbconn.
  • Returns: The features’ correlation.
  • Return type: float

atscale.eda.stats.covariance​

Returns the covariance of two given features.

  • Parameters:
    • dbconn (SQLConnection) – The database connection to interact with.
    • data_model (DataModel) – The data model corresponding to the features provided.
    • feature1 (str) – The first feature.
    • feature2 (str) – The second feature.
    • granularity_levels (List *[*str ]) – The categorical features corresponding to the level of granularity desired in the given features.
    • sample (bool , optional) – Whether to calculate the sample covariance. Defaults to True; otherwise, calculates the population covariance.
    • if_exists (enums.TableExistsAction , optional) – The default action that taken when creating a table with a preexisting name. Does not accept APPEND. Defaults to ERROR.
    • write_database (str) – The database that this functionality will write tables to. Defaults to the database associated with the given dbconn.
    • write_schema (str) – The schema that this functionality will write tables to. Defaults to the database associated with the given dbconn.
  • Returns: The features’ covariance.
  • Return type: float

atscale.eda.stats.std​

Returns the standard deviation of a given feature.

  • Parameters:
    • dbconn (SQLConnection) – The database connection to interact with.
    • data_model (DataModel) – The data model corresponding to the features provided.
    • feature (str) – The feature whose standard deviation is calculated.
    • granularity_levels (List *[*str ]) – The categorical features corresponding to the level of granularity desired in the given feature.
    • sample (bool , optional) – Whether to calculate the sample standard deviation. Defaults to True; otherwise, calculates the population standard deviation.
    • if_exists (enums.TableExistsAction , optional) – The default action that taken when creating a table with a preexisting name. Does not accept APPEND. Defaults to ERROR.
    • write_database (str) – The database that this functionality will write tables to. Defaults to the database associated with the given dbconn.
    • write_schema (str) – The schema that this functionality will write tables to. Defaults to the database associated with the given dbconn.
  • Returns: The feature’s standard deviation.
  • Return type: float

atscale.eda.stats.variance​

Returns the variance of a given feature.

  • Parameters:
    • dbconn (SQLConnection) – The database connection to interact with.
    • data_model (DataModel) – The data model corresponding to the features provided.
    • feature (str) – The feature whose variance is calculated.
    • granularity_levels (List *[*str ]) – The categorical features corresponding to the level of granularity desired in the given feature.
    • sample (bool , optional) – Whether to calculate the sample variance. Defaults to True; otherwise, calculates the population variance.
    • if_exists (enums.TableExistsAction , optional) – The default action that taken when creating a table with a preexisting name. Does not accept APPEND. Defaults to ERROR.
    • write_database (str) – The database that this functionality will write tables to. Defaults to the database associated with the given dbconn.
    • write_schema (str) – The schema that this functionality will write tables to. Defaults to the database associated with the given dbconn.
  • Returns: The feature’s variance.
  • Return type: float