Shourya Bose commited on
Commit
eed52e7
·
1 Parent(s): 45cc56d

update readme

Browse files
Files changed (1) hide show
  1. README.md +8 -0
README.md CHANGED
@@ -18,6 +18,14 @@ The file `custom_dataset.py` contains the function `get_data_and_generate_train_
18
  - `normalize` (boolean): If set to `True`, data is normalized per-feature.
19
  - `transformer` (boolean): If set to `True` and `normalize` is also `True`, then categorical time features are not normalized. Useful for embedding said features in Transformers.
20
 
 
 
 
 
 
 
 
 
21
  ## ComStock Notice
22
 
23
  This data includes information from the ComStock™ dataset developed by the National Renewable Energy Laboratory (NREL) with funding from the U.S. Department of Energy (DOE). This model was trained using ComStock release 2023.2. NREL regularly publishes updated datasets which generally improve the representation of building energy consumption. Users interested in training their own models should review the latest dataset releases to assess whether recent updates offer features relevant to their modeling objectives.
 
18
  - `normalize` (boolean): If set to `True`, data is normalized per-feature.
19
  - `transformer` (boolean): If set to `True` and `normalize` is also `True`, then categorical time features are not normalized. Useful for embedding said features in Transformers.
20
 
21
+ The outputs are as follows:
22
+
23
+ - `train`: `torch.utils.data.Dataset` containing the train data.
24
+ - `val`: `torch.utils.data.Dataset` containing the validation data.
25
+ - `test`: `torch.utils.data.Dataset` containing the test data.
26
+ - `mean`: `np.ndarray` containing the featurewise mean. If `normalization` is `False`, then it defaults to all `0`s.
27
+ - `std`: `np.ndarray` containing the featurewise standard deviation. If `normalization` is `False`, then it defaults to all `1`s.
28
+
29
  ## ComStock Notice
30
 
31
  This data includes information from the ComStock™ dataset developed by the National Renewable Energy Laboratory (NREL) with funding from the U.S. Department of Energy (DOE). This model was trained using ComStock release 2023.2. NREL regularly publishes updated datasets which generally improve the representation of building energy consumption. Users interested in training their own models should review the latest dataset releases to assess whether recent updates offer features relevant to their modeling objectives.