Skip to content

fix misleading comment#3058

Merged
ericl merged 1 commit into
ray-project:masterfrom
marlonjan:patch-3
Oct 15, 2018
Merged

fix misleading comment#3058
ericl merged 1 commit into
ray-project:masterfrom
marlonjan:patch-3

Conversation

@marlonjan

Copy link
Copy Markdown
Contributor

What do these changes do?

Fixes the comment for TIMESTEPS_TOTAL which seems to refer to an integer.

Related issue number

None

Comment thread python/ray/tune/result.py
TIMESTEPS_THIS_ITER = "timesteps_this_iter"

# (Optional/Auto-filled) Accumulated time in seconds for this experiment.
# (Auto-filled) Accumulated number of timesteps for this entire experiment.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the catch! Can you put the Optional part back in? Users can override this field.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems ok for consistency with the rest of the auto-filled fields.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, I guess we say "optional" in other places as well, but it's not all accurate. Probably better to just stick with auto-filled.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh yes, sure! I thought that was also obsolete.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh my page wasn't refreshed... now seeing @ericl's comment.

@AmplabJenkins

Copy link
Copy Markdown

Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/8645/
Test PASSed.

@ericl ericl merged commit 4dc78b7 into ray-project:master Oct 15, 2018
richardliaw pushed a commit that referenced this pull request Oct 16, 2018
## What do these changes do?

Fix the misleading comments in code for:
 - `EPISODES_THIS_ITER`
 - `EPISODES_TOTAL`

Had noted it before and planned to fix it along with some other changes but seemed very relevant to stay next to #3058 so sending this now.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants