Skip to content

Commit 16a566f

Browse files
author
The TensorFlow Datasets Authors
committed
Automated documentation update.
PiperOrigin-RevId: 665493662
1 parent a1f96b0 commit 16a566f

File tree

3 files changed

+210
-0
lines changed

3 files changed

+210
-0
lines changed

‎docs/catalog/_toc.yaml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,9 @@ toc:
128128
title: robomimic_mh
129129
- path: /datasets/catalog/robomimic_ph
130130
title: robomimic_ph
131+
- path: /datasets/catalog/smart_buildings
132+
status: nightly
133+
title: smart_buildings
131134
title: Computer science
132135
- section:
133136
- path: /datasets/catalog/imagenet2012
@@ -953,6 +956,9 @@ toc:
953956
title: robomimic_mh
954957
- path: /datasets/catalog/robomimic_ph
955958
title: robomimic_ph
959+
- path: /datasets/catalog/smart_buildings
960+
status: nightly
961+
title: smart_buildings
956962
title: Reinforcement learning
957963
- section:
958964
- path: /datasets/catalog/nyu_depth_v2
@@ -1159,6 +1165,9 @@ toc:
11591165
- section:
11601166
- path: /datasets/catalog/databricks_dolly
11611167
title: databricks_dolly
1168+
- path: /datasets/catalog/smart_buildings
1169+
status: nightly
1170+
title: smart_buildings
11621171
title: Sequence modeling
11631172
- section:
11641173
- path: /datasets/catalog/big_patent
@@ -1703,6 +1712,9 @@ toc:
17031712
title: robomimic_mh
17041713
- path: /datasets/catalog/robomimic_ph
17051714
title: robomimic_ph
1715+
- path: /datasets/catalog/smart_buildings
1716+
status: nightly
1717+
title: smart_buildings
17061718
- path: /datasets/catalog/smartwatch_gestures
17071719
title: smartwatch_gestures
17081720
title: Time series

‎docs/catalog/overview.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,8 @@ for ex in tfds.load('cifar10', split='train'):
108108
* [`robomimic_mg`](robomimic_mg.md)
109109
* [`robomimic_mh`](robomimic_mh.md)
110110
* [`robomimic_ph`](robomimic_ph.md)
111+
* [`smart_buildings`](smart_buildings.md)
112+
<span class="material-icons" title="Available only in the tfds-nightly package">nights_stay</span>
111113

112114
### `Conditional image generation`
113115

@@ -605,6 +607,8 @@ for ex in tfds.load('cifar10', split='train'):
605607
* [`robomimic_mg`](robomimic_mg.md)
606608
* [`robomimic_mh`](robomimic_mh.md)
607609
* [`robomimic_ph`](robomimic_ph.md)
610+
* [`smart_buildings`](smart_buildings.md)
611+
<span class="material-icons" title="Available only in the tfds-nightly package">nights_stay</span>
608612

609613
### `Rgb d`
610614

@@ -724,6 +728,8 @@ for ex in tfds.load('cifar10', split='train'):
724728
### `Sequence modeling`
725729

726730
* [`databricks_dolly`](databricks_dolly.md)
731+
* [`smart_buildings`](smart_buildings.md)
732+
<span class="material-icons" title="Available only in the tfds-nightly package">nights_stay</span>
727733

728734
### `Sequence to sequence language modeling`
729735

@@ -1024,6 +1030,8 @@ for ex in tfds.load('cifar10', split='train'):
10241030
* [`robomimic_mg`](robomimic_mg.md)
10251031
* [`robomimic_mh`](robomimic_mh.md)
10261032
* [`robomimic_ph`](robomimic_ph.md)
1033+
* [`smart_buildings`](smart_buildings.md)
1034+
<span class="material-icons" title="Available only in the tfds-nightly package">nights_stay</span>
10271035
* [`smartwatch_gestures`](smartwatch_gestures.md)
10281036

10291037
### `Token classification`

‎docs/catalog/smart_buildings.md

Lines changed: 190 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
1+
<div itemscope itemtype="http://schema.org/Dataset">
2+
<div itemscope itemprop="includedInDataCatalog" itemtype="http://schema.org/DataCatalog">
3+
<meta itemprop="name" content="TensorFlow Datasets" />
4+
</div>
5+
<meta itemprop="name" content="smart_buildings" />
6+
<meta itemprop="description" content="# Smart Buildings Dataset&#10;&#10;Dataset accompanying the paper &quot;Real-World Data and&#10;Calibrated Simulation Suite for Offline Training of&#10;Reinforcement Learning Agents to Optimize Energy and&#10;Emission in Office Buildings&quot; by Judah Goldfeder and&#10;John Sipple, containing 6 years of detailed telemetric&#10;readouts from 3 commercial office buildings.&#10;&#10;To use this dataset:&#10;&#10;```python&#10;import tensorflow_datasets as tfds&#10;&#10;ds = tfds.load(&#x27;smart_buildings&#x27;, split=&#x27;train&#x27;)&#10;for ex in ds.take(4):&#10; print(ex)&#10;```&#10;&#10;See [the guide](https://www.tensorflow.org/datasets/overview) for more&#10;informations on [tensorflow_datasets](https://www.tensorflow.org/datasets).&#10;&#10;" />
7+
<meta itemprop="url" content="https://www.tensorflow.org/datasets/catalog/smart_buildings" />
8+
<meta itemprop="sameAs" content="https://github.com/google/sbsim" />
9+
<meta itemprop="citation" content="// TODO(smart_buildings_dataset): BibTeX citation" />
10+
</div>
11+
12+
# `smart_buildings`
13+
14+
15+
Note: This dataset was added recently and is only available in our
16+
`tfds-nightly` package
17+
<span class="material-icons" title="Available only in the tfds-nightly package">nights_stay</span>.
18+
19+
* **Description**:
20+
21+
# Smart Buildings Dataset
22+
23+
Dataset accompanying the paper "Real-World Data and Calibrated Simulation Suite
24+
for Offline Training of Reinforcement Learning Agents to Optimize Energy and
25+
Emission in Office Buildings" by Judah Goldfeder and John Sipple, containing 6
26+
years of detailed telemetric readouts from 3 commercial office buildings.
27+
28+
* **Config description**: Building sb1
29+
30+
* **Homepage**:
31+
[https://github.com/google/sbsim](https://github.com/google/sbsim)
32+
33+
* **Source code**:
34+
[`tfds.datasets.smart_buildings.Builder`](https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/datasets/smart_buildings/smart_buildings_dataset_builder.py)
35+
36+
* **Versions**:
37+
38+
* **`1.0.0`** (default): Initial release.
39+
40+
* **Download size**: `Unknown size`
41+
42+
* **Dataset size**: `Unknown size`
43+
44+
* **Auto-cached**
45+
([documentation](https://www.tensorflow.org/datasets/performances#auto-caching)):
46+
Unknown
47+
48+
* **Splits**:
49+
50+
Split | Examples
51+
:---- | -------:
52+
53+
* **Feature structure**:
54+
55+
```python
56+
FeaturesDict({
57+
'action': FeaturesDict({
58+
'request': FeaturesDict({
59+
'singleActionRequests': Sequence({
60+
'continuousValue': Scalar(shape=(), dtype=float32),
61+
'deviceId': Text(shape=(), dtype=string),
62+
'setpointName': Text(shape=(), dtype=string),
63+
}),
64+
'timestamp': Text(shape=(), dtype=string),
65+
}),
66+
'singleActionResponses': Sequence({
67+
'additionalInfo': Text(shape=(), dtype=string),
68+
'request': FeaturesDict({
69+
'continuousValue': Scalar(shape=(), dtype=float32),
70+
'deviceId': Text(shape=(), dtype=string),
71+
'setpointName': Text(shape=(), dtype=string),
72+
}),
73+
'responseType': Text(shape=(), dtype=string),
74+
}),
75+
'timestamp': Text(shape=(), dtype=string),
76+
}),
77+
'observation': FeaturesDict({
78+
'request': FeaturesDict({
79+
'singleObservationRequests': Sequence({
80+
'deviceId': Text(shape=(), dtype=string),
81+
'measurementName': Text(shape=(), dtype=string),
82+
}),
83+
'timestamp': Text(shape=(), dtype=string),
84+
}),
85+
'singleObservationResponses': Sequence({
86+
'continuousValue': Scalar(shape=(), dtype=float32),
87+
'observationValid': Text(shape=(), dtype=string),
88+
'singleObservationRequest': FeaturesDict({
89+
'deviceId': Text(shape=(), dtype=string),
90+
'measurementName': Text(shape=(), dtype=string),
91+
}),
92+
'timestamp': Text(shape=(), dtype=string),
93+
}),
94+
'timestamp': Text(shape=(), dtype=string),
95+
}),
96+
'reward': FeaturesDict({
97+
'agentRewardValue': Scalar(shape=(), dtype=float32),
98+
'carbonEmissionWeight': Scalar(shape=(), dtype=float32),
99+
'carbonEmitted': Scalar(shape=(), dtype=float32),
100+
'electricityEnergyCost': Scalar(shape=(), dtype=float32),
101+
'endTimestamp': Text(shape=(), dtype=string),
102+
'energyCostWeight': Scalar(shape=(), dtype=float32),
103+
'naturalGasEnergyCost': Scalar(shape=(), dtype=float32),
104+
'normalizedCarbonEmission': Scalar(shape=(), dtype=float32),
105+
'normalizedEnergyCost': Scalar(shape=(), dtype=float32),
106+
'normalizedProductivityRegret': Scalar(shape=(), dtype=float32),
107+
'personProductivity': Scalar(shape=(), dtype=float32),
108+
'productivityRegret': Scalar(shape=(), dtype=float32),
109+
'productivityReward': Scalar(shape=(), dtype=float32),
110+
'productivityWeight': Scalar(shape=(), dtype=float32),
111+
'rewardScale': Scalar(shape=(), dtype=float32),
112+
'startTimestamp': Text(shape=(), dtype=string),
113+
'totalOccupancy': Scalar(shape=(), dtype=float32),
114+
}),
115+
})
116+
```
117+
118+
* **Feature documentation**:
119+
120+
Feature | Class | Shape | Dtype | Description
121+
:------------------------------------------------------------------------------ | :----------- | :---- | :------ | :----------
122+
| FeaturesDict | | |
123+
action | FeaturesDict | | |
124+
action/request | FeaturesDict | | |
125+
action/request/singleActionRequests | Sequence | | |
126+
action/request/singleActionRequests/continuousValue | Scalar | | float32 |
127+
action/request/singleActionRequests/deviceId | Text | | string |
128+
action/request/singleActionRequests/setpointName | Text | | string |
129+
action/request/timestamp | Text | | string |
130+
action/singleActionResponses | Sequence | | |
131+
action/singleActionResponses/additionalInfo | Text | | string |
132+
action/singleActionResponses/request | FeaturesDict | | |
133+
action/singleActionResponses/request/continuousValue | Scalar | | float32 |
134+
action/singleActionResponses/request/deviceId | Text | | string |
135+
action/singleActionResponses/request/setpointName | Text | | string |
136+
action/singleActionResponses/responseType | Text | | string |
137+
action/timestamp | Text | | string |
138+
observation | FeaturesDict | | |
139+
observation/request | FeaturesDict | | |
140+
observation/request/singleObservationRequests | Sequence | | |
141+
observation/request/singleObservationRequests/deviceId | Text | | string |
142+
observation/request/singleObservationRequests/measurementName | Text | | string |
143+
observation/request/timestamp | Text | | string |
144+
observation/singleObservationResponses | Sequence | | |
145+
observation/singleObservationResponses/continuousValue | Scalar | | float32 |
146+
observation/singleObservationResponses/observationValid | Text | | string |
147+
observation/singleObservationResponses/singleObservationRequest | FeaturesDict | | |
148+
observation/singleObservationResponses/singleObservationRequest/deviceId | Text | | string |
149+
observation/singleObservationResponses/singleObservationRequest/measurementName | Text | | string |
150+
observation/singleObservationResponses/timestamp | Text | | string |
151+
observation/timestamp | Text | | string |
152+
reward | FeaturesDict | | |
153+
reward/agentRewardValue | Scalar | | float32 |
154+
reward/carbonEmissionWeight | Scalar | | float32 |
155+
reward/carbonEmitted | Scalar | | float32 |
156+
reward/electricityEnergyCost | Scalar | | float32 |
157+
reward/endTimestamp | Text | | string |
158+
reward/energyCostWeight | Scalar | | float32 |
159+
reward/naturalGasEnergyCost | Scalar | | float32 |
160+
reward/normalizedCarbonEmission | Scalar | | float32 |
161+
reward/normalizedEnergyCost | Scalar | | float32 |
162+
reward/normalizedProductivityRegret | Scalar | | float32 |
163+
reward/personProductivity | Scalar | | float32 |
164+
reward/productivityRegret | Scalar | | float32 |
165+
reward/productivityReward | Scalar | | float32 |
166+
reward/productivityWeight | Scalar | | float32 |
167+
reward/rewardScale | Scalar | | float32 |
168+
reward/startTimestamp | Text | | string |
169+
reward/totalOccupancy | Scalar | | float32 |
170+
171+
* **Supervised keys** (See
172+
[`as_supervised` doc](https://www.tensorflow.org/datasets/api_docs/python/tfds/load#args)):
173+
`None`
174+
175+
* **Figure**
176+
([tfds.show_examples](https://www.tensorflow.org/datasets/api_docs/python/tfds/visualization/show_examples)):
177+
Not supported.
178+
179+
* **Examples**
180+
([tfds.as_dataframe](https://www.tensorflow.org/datasets/api_docs/python/tfds/as_dataframe)):
181+
Missing.
182+
183+
* **Citation**:
184+
185+
```
186+
// TODO(smart_buildings_dataset): BibTeX citation
187+
```
188+
189+
190+
## smart_buildings/sb1 (default config)

0 commit comments

Comments
 (0)