Offset Mapping

[jeff-hernandez]

Offset aliases are not user friendly. Would be helpful to create a mapping to easily specify which offset to use. Couple suggestion in the examples below.

• Regex Parser

  lm = cp.LabelMaker(
  window_size='first of every 2 months',
  ...
  )

• Modules and Functions

  
  from composeml.offsets import first_of_every

lm = cp.LabelMaker( window_size=first_of_every.months(2), ... )

[kmax12]

it seems to me window size can be

1. an fixed amount of time (1 month, 10 observations, 6 days, etc)
2. until some stop time (1st of month, end of year, next day)

I think the case where it is an amount of time is easy because it's just <VALUE><SPACE><UNIT>.

the until case is a little tougher, but perhaps we start by just hardcoding some common patterns. anything more complex, you'd have to use pandas offsets

Until start of next <UNIT>

• "Until start of next month"
• "Until start of next day"
• "Until start of next week"
• "Until start of hour week"
• "Until start of next year"

[jeff-hernandez]

Okay, sounds good. Will start with this template.

until start of next <unit>

Then maybe later can be:

until start of next <value><space><unit>

[jeff-hernandez]

There are offsets available for these time spans.

'Until start of next year'  # ->  pd.offsets.YearBegin
'Until start of next month' # ->  pd.offsets.MonthBegin

However, I didn't see any for these.

Until start of next week
Until start of next day
Until start of next hour