Share via

LocationClosestSelector Class

  • Reference

Defines a join of customer data with public data using the criteria of closest spherical distance.

Initialize with location granularity.

Inheritance
EnricherLocationSelector
LocationClosestSelector

Constructor

LocationClosestSelector(_granularity: LocationClosestGranularity, enable_telemetry: bool = True)

Parameters

Name Description
_granularity
Required
LocationClosestGranularity

A location granularity to use in the joining of data.
enable_telemetry
bool

Indicates whether to enable telemetry.

Default value: True

Remarks

The static method process(self, env, customer_data, public_data, aggregator, join_keys, debug) is used to join the data based on this selector where:

  • customer_data is an instance of azureml.opendatasets.accessories.location_data.LocationData

  • public_data is an instance of azureml.opendatasets.accessories.location_data.LocationData

  • aggregator is one of azureml.opendatasets.aggregators.aggregator.Aggregator

  • join_keys is a list of join key pairs

  • debug indicates whether to print debug logs.

This method returns a tuple of: altered customer data class instance, altered public data class instance, and a list of join key pairs.

Methods

process

Join customer data and public data using the specified aggregator.

process

Join customer data and public data using the specified aggregator.

process(env: SparkEnv | PandasEnv, customer_data: LocationData, public_data: LocationData, aggregator: Aggregator, join_keys: list, debug: bool)

Parameters

Name Description
env
Required
RuntimeEnv

The runtime environment.
customer_data
Required
LocationData

An instance of a LocationData derived class.
public_data
Required
LocationData

An instance of a LocationData derived class.
aggregator
Required
Aggregator

An aggregator.
join_keys
Required
list

A list of join key pairs.
debug
Required
bool

Indicates whether to print debug logs.

Returns

Type Description
tuple

A tuple of: altered customer data class instance, altered public data class instance, and a list of join key pairs.