modelhub.ModelHub.add_conversion_event

add_conversion_event

(location_stack=None, event_type=None, name=None)

[source]

Label events that are used as conversions. All labeled conversion events are set in conversion_events.

Parameters

  • location_stack (Optional[modelhub.series.series_objectiv.SeriesLocationStack]) – the location stack that is labeled as conversion. Can be any slice in of a modelhub.SeriesLocationStack type column. Optionally use in conjunction with event_type to label a conversion.
  • event_type (Optional[str]) – the event type that is labeled as conversion. Optionally use in conjunction with objectiv_location_stack to label a conversion.
  • name (Optional[str]) – the name to use for the labeled conversion event. If None it will use ‘conversion_#’, where # is the number of the added conversion.