Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] [tune] replace tune.report with session.report #34435

Merged
merged 2 commits into from
Apr 21, 2023

Conversation

angelinalg
Copy link
Contributor

Why are these changes needed?

To address CSAT reported feedback that example was using an outdated API (tune.report) which is replaced with session.report.

Related issue number

(#34434)

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
    • I've added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

To address: #34434

Signed-off-by: angelinalg <[email protected]>
@@ -105,7 +105,7 @@ def train_mnist(config):
acc = test(model, test_loader)

# Send the current training result back to Tune
tune.report(mean_accuracy=acc)
session.report(mean_accuracy=acc)
Copy link
Contributor

Choose a reason for hiding this comment

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

Will need to also include the proper import at the top:

from ray.air import session

Does that look right, @matthewdeng? BTW, thanks for catching that.

Signed-off-by: angelinalg <[email protected]>
Copy link
Contributor

@matthewdeng matthewdeng left a comment

Choose a reason for hiding this comment

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

Code looks good to me. Test is failing for an unrelated reason though...

@angelinalg
Copy link
Contributor Author

@matthewdeng I've never merged a PR for this directory before. Are you able to merge it? Or should I rebase and try to get the tests to pass, first?

@angelinalg angelinalg changed the title replace tune.report with session.report [docs] replace tune.report with session.report Apr 20, 2023
@matthewdeng
Copy link
Contributor

@richardliaw can you merge? If somehow this breaks master I will take full responsibility.

@richardliaw richardliaw merged commit 24cbd38 into master Apr 21, 2023
@richardliaw richardliaw deleted the angelinalg-patch-1 branch April 21, 2023 03:36
@krfricke
Copy link
Contributor

@richardliaw can you merge? If somehow this breaks master I will take full responsibility.

famous last words :-D

Screenshot 2023-04-21 at 9 53 56 AM

I'll file a fix

@krfricke krfricke mentioned this pull request Apr 21, 2023
8 tasks
krfricke added a commit that referenced this pull request Apr 21, 2023
One line fix for bug introduced in #34435

Signed-off-by: Kai Fricke <[email protected]>
@matthewdeng
Copy link
Contributor

Lol sigh, thanks @krfricke 😅

@angelinalg angelinalg changed the title [docs] replace tune.report with session.report [docs] [serve] replace tune.report with session.report Apr 21, 2023
@angelinalg angelinalg changed the title [docs] [serve] replace tune.report with session.report [docs] [tune] replace tune.report with session.report Apr 21, 2023
jjyao pushed a commit that referenced this pull request Apr 21, 2023
One line fix for bug introduced in #34435

Signed-off-by: Kai Fricke <[email protected]>
elliottower pushed a commit to elliottower/ray that referenced this pull request Apr 22, 2023
elliottower pushed a commit to elliottower/ray that referenced this pull request Apr 22, 2023
One line fix for bug introduced in ray-project#34435

Signed-off-by: Kai Fricke <[email protected]>
Signed-off-by: elliottower <[email protected]>
ProjectsByJackHe pushed a commit to ProjectsByJackHe/ray that referenced this pull request May 4, 2023
ProjectsByJackHe pushed a commit to ProjectsByJackHe/ray that referenced this pull request May 4, 2023
One line fix for bug introduced in ray-project#34435

Signed-off-by: Kai Fricke <[email protected]>
Signed-off-by: Jack He <[email protected]>
architkulkarni pushed a commit to architkulkarni/ray that referenced this pull request May 16, 2023
architkulkarni pushed a commit to architkulkarni/ray that referenced this pull request May 16, 2023
One line fix for bug introduced in ray-project#34435

Signed-off-by: Kai Fricke <[email protected]>
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.

None yet

4 participants