Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
yatbear committed Oct 3, 2023
1 parent 4ce7bd4 commit ea680f1
Showing 1 changed file with 10 additions and 14 deletions.
24 changes: 10 additions & 14 deletions tensorboard/data/provider.py
Original file line number Diff line number Diff line change
Expand Up @@ -109,14 +109,16 @@ class DataProvider(metaclass=abc.ABCMeta):
execution.
Each run within an experiment may specify its own value for a
hyperparameter. Runs that were logically executed together with the same
set of hyperparameter values form a hyperparameter session. Often a session
group will contain only a single session. However, in some scenarios, the
same hyperparameters will be used to execute multiple jobs with the idea to
aggregate the metrics across those jobs and analyze non-deterministic
factors. In that case, a session group will contain multiple sessions.
The result will group runs by hyperparameter session group and provide one
set of hyperparameter values for each group.
hyperparameter. Runs that were logically executed together with the same set
of hyperparameter values form a hyperparameter `session`. Sessions that
include the same hyperparameter values can be grouped together in a
hyperparameter `session group`. Often a session group will contain only a
single session. However, in some scenarios, the same hyperparameters will be
used to execute multiple jobs with the idea to aggregate the metrics across
those jobs and analyze non-deterministic factors. In that case, a session
group will contain multiple sessions. The result will group runs by
hyperparameter session group and provide one set of hyperparameter values
for each group.
All methods on this class take a `RequestContext` parameter as the
first positional argument. This argument is temporarily optional to
Expand Down Expand Up @@ -661,12 +663,6 @@ class HyperparameterSessionGroup:
set of hyperparameter values. A session may contain multiple related runs
executed together to train and validate a model.
Often a session group will contain only a single session. However, in some
scenarios, the same hyperparameters will be used to execute multiple jobs
with the idea to aggregate the metrics across those jobs and analyze
non-deterministic factors. In that case, a session group will contain multiple
sessions.
We assume these groups of runs were executed with the same set of
hyperparameter values. However, having the same set of hyperparameter values
is not sufficient to be considered part of the same group -- different
Expand Down

0 comments on commit ea680f1

Please sign in to comment.