Skip to content

Commit 08ad9ce

Browse files
authored
data: make downsample required, but permit zero (#4333)
Summary: Suggested by @nfelt on #4314. This hits a flexibility/usability middle ground between “omitted messages are implied to be empty” (which makes it easy to accidentally set `num_points: 0` and wonder why the result is empty) and “you may not set `num_points: 0`” (which excludes legitimate use cases). Test Plan: None needed; this is just a doc update for now, as the service does not yet have any clients or servers. wchargin-branch: data-downsample-required
1 parent c58ea35 commit 08ad9ce

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

tensorboard/data/proto/data_provider.proto

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ message TagFilter {
5656
}
5757

5858
message Downsample {
59-
// Maximum number of points to return. Must be positive.
59+
// Maximum number of points to return. Must be non-negative. Zero means zero.
6060
int64 num_points = 1;
6161
}
6262

@@ -120,8 +120,8 @@ message ReadScalarsRequest {
120120
PluginFilter plugin_filter = 2;
121121
// Optional filter for time series. If omitted, all time series match.
122122
RunTagFilter run_tag_filter = 3;
123-
// Downsampling specification describing how many points to return per time
124-
// series. It is an error if `downsample.num_points <= 0`.
123+
// Required downsampling specification describing how many points to return
124+
// per time series.
125125
Downsample downsample = 4;
126126
}
127127

@@ -187,8 +187,8 @@ message ReadTensorsRequest {
187187
PluginFilter plugin_filter = 2;
188188
// Optional filter for time series. If omitted, all time series match.
189189
RunTagFilter run_tag_filter = 3;
190-
// Downsampling specification describing how many points to return per time
191-
// series. It is an error if `downsample.num_points <= 0`.
190+
// Required downsampling specification describing how many points to return
191+
// per time series.
192192
Downsample downsample = 4;
193193
}
194194

@@ -257,8 +257,8 @@ message ReadBlobSequencesRequest {
257257
PluginFilter plugin_filter = 2;
258258
// Optional filter for time series. If omitted, all time series match.
259259
RunTagFilter run_tag_filter = 3;
260-
// Downsampling specification describing how many points to return per time
261-
// series. It is an error if `downsample.num_points <= 0`.
260+
// Required downsampling specification describing how many points to return
261+
// per time series.
262262
Downsample downsample = 4;
263263
}
264264

tensorboard/data/server/tensorboard.data.pb.rs

Lines changed: 7 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)