class_docstr: Returns datasets included in the library in `pandas.DataFrame` or
  `~greykite.framework.input.univariate_time_series.UnivariateTimeSeries` format.
  
  Extends `~greykite.common.data_loader.DataLoader`
class_docstr_tok: ["Returns","datasets","included","in","the","library","in","`","pandas.DataFrame","`","or","`","~greykite.framework.input.univariate_time_series.UnivariateTimeSeries","`","format",".","Extends","`","~greykite.common.data_loader.DataLoader","`"]
docstr: Loads the Beijing Particulate Matter (PM2.5) dataset.
  https://archive.ics.uci.edu/ml/datasets/Beijing+PM2.5+Data
  
  This hourly data set contains the PM2.5 data of US Embassy in Beijing. Meanwhile, meteorological data
  from Beijing Capital International Airport are also included.
  
  The dataset's time period is between Jan 1st, 2010 to Dec 31st, 2014. Missing data are denoted as NA.
  
  Below is the dataset attribute information:
  
      No : row number
      year : year of data in this row
      month : month of data in this row
      day : day of data in this row
      hour : hour of data in this row
      pm2.5: PM2.5 concentration (ug/m^3)
      DEWP : dew point (celsius)
      TEMP : temperature (celsius)
      PRES : pressure (hPa)
      cbwd : combined wind direction
      Iws : cumulated wind speed (m/s)
      Is : cumulated hours of snow
      Ir : cumulated hours of rain
  
  Returns
  -------
  ts : `~greykite.framework.input.univariate_time_series.UnivariateTimeSeries`
      Beijing PM2.5 data. Time and value column:
  
          ``time_col`` : TIME_COL
              hourly timestamp
          ``value_col`` : "pm"
               PM2.5 concentration (ug/m^3)
  
      Additional regressors:
  
          "dewp" : dew point (celsius)
          "temp" : temperature (celsius)
          "pres" : pressure (hPa)
          "cbwd" : combined wind direction
          "iws" : cumulated wind speed (m/s)
          "is" : cumulated hours of snow
          "ir" : cumulated hours of rain
docstr_tok: ["Loads","the","Beijing","Particulate","Matter","(","PM2.5",")","dataset",".","https",":","\/\/archive.ics.uci.edu\/ml\/datasets\/Beijing+PM2.5+Data","This","hourly","data","set","contains","the","PM2.5","data","of","US","Embassy","in","Beijing",".","Meanwhile",",","meteorological","data","from","Beijing","Capital","International","Airport","are","also","included",".","The","dataset","'s","time","period","is","between","Jan","1st",",","2010","to","Dec","31st",",","2014",".","Missing","data","are","denoted","as","NA",".","Below","is","the","dataset","attribute","information",":","No",":","row","number","year",":","year","of","data","in","this","row","month",":","month","of","data","in","this","row","day",":","day","of","data","in","this","row","hour",":","hour","of","data","in","this","row","pm2.5",":","PM2.5","concentration","(","ug\/m^3",")","DEWP",":","dew","point","(","celsius",")","TEMP",":","temperature","(","celsius",")","PRES",":","pressure","(","hPa",")","cbwd",":","combined","wind","direction","Iws",":","cumulated","wind","speed","(","m\/s",")","Is",":","cumulated","hours","of","snow","Ir",":","cumulated","hours","of","rain","Returns","--","--","--","-","ts",":","`","~greykite.framework.input.univariate_time_series.UnivariateTimeSeries","`","Beijing","PM2.5","data",".","Time","and","value","column",":","``","time_col","``",":","TIME_COL","hourly","timestamp","``","value_col","``",":","``","pm","''","PM2.5","concentration","(","ug\/m^3",")","Additional","regressors",":","``","dewp","''",":","dew","point","(","celsius",")","``","temp","''",":","temperature","(","celsius",")","``","pres","''",":","pressure","(","hPa",")","``","cbwd","''",":","combined","wind","direction","``","iws","''",":","cumulated","wind","speed","(","m\/s",")","``","is","''",":","cumulated","hours","of","snow","``","ir","''",":","cumulated","hours","of","rain"]
code: def load_beijing_pm_ts(self):
      """Loads the Beijing Particulate Matter (PM2.5) dataset.
      https://archive.ics.uci.edu/ml/datasets/Beijing+PM2.5+Data
  
      This hourly data set contains the PM2.5 data of US Embassy in Beijing. Meanwhile, meteorological data
      from Beijing Capital International Airport are also included.
  
      The dataset's time period is between Jan 1st, 2010 to Dec 31st, 2014. Missing data are denoted as NA.
  
      Below is the dataset attribute information:
  
          No : row number
          year : year of data in this row
          month : month of data in this row
          day : day of data in this row
          hour : hour of data in this row
          pm2.5: PM2.5 concentration (ug/m^3)
          DEWP : dew point (celsius)
          TEMP : temperature (celsius)
          PRES : pressure (hPa)
          cbwd : combined wind direction
          Iws : cumulated wind speed (m/s)
          Is : cumulated hours of snow
          Ir : cumulated hours of rain
  
      Returns
      -------
      ts : `~greykite.framework.input.univariate_time_series.UnivariateTimeSeries`
          Beijing PM2.5 data. Time and value column:
  
              ``time_col`` : TIME_COL
                  hourly timestamp
              ``value_col`` : "pm"
                   PM2.5 concentration (ug/m^3)
  
          Additional regressors:
  
              "dewp" : dew point (celsius)
              "temp" : temperature (celsius)
              "pres" : pressure (hPa)
              "cbwd" : combined wind direction
              "iws" : cumulated wind speed (m/s)
              "is" : cumulated hours of snow
              "ir" : cumulated hours of rain
      """
      df = self.load_beijing_pm()
      ts = UnivariateTimeSeries()
      ts.load_data(
          df=df,
          time_col=TIME_COL,
          value_col="pm",
          freq="H",
          regressor_cols=[
              "dewp",
              "temp",
              "pres",
              "cbwd",
              "iws",
              "is",
              "ir",
          ],
      )
      return ts
  
file_path: greykite/greykite/framework/benchmark/data_loader_ts.py
imports: from greykite.common.constants import TIME_COL
  from greykite.common.constants import VALUE_COL
  from greykite.common.data_loader import DataLoader
  from greykite.framework.input.univariate_time_series import UnivariateTimeSeries
label_desc: Use image node_id 5 for calling the DataLoaderTS obj's underlying member method code with example usage: obj.load_beijing_pm_ts() and returns: ts