woodwork.demo.load_retail#

woodwork.demo.load_retail(id='demo_retail_data', nrows=None, init_woodwork=True)[source]#

Load a demo retail dataset into a DataFrame, optionally initializing Woodwork’s typing information.

Parameters:

  • id (str, optional) – The name to assign to the DataFrame, if returning a DataFrame with Woodwork typing information initialized. If not returning a DataFrame with Woodwork initialized, this will be ignored. Defaults to demo_retail_data.

  • nrows (int, optional) – The number of rows to return in the dataset. If None, will return all possible rows. Defaults to None.

  • init_woodwork (bool) – If True, will return a pandas DataFrame with Woodwork typing information initialized. If False, will return a DataFrame without Woodwork initialized. Defaults to False.

Returns:

A DataFrame containing the demo data with Woodwork typing initialized. If init_woodwork is False, will return an uninitialized DataFrame.

Return type:

pd.DataFrame