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

[air] Minor Doc updates #25097

Merged
merged 3 commits into from
May 25, 2022
Merged

Conversation

xwjiang2010
Copy link
Contributor

@xwjiang2010 xwjiang2010 commented May 23, 2022

Why are these changes needed?

Update a few docs and param names.

Related issue number

Checks

  • 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 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 :(

@amogkam
Copy link
Contributor

amogkam commented May 23, 2022

@xwjiang2010 I can use Predictor in piecemeal fashion by just instantiating it directly right?

create_compatible_checkpoint won't work for all Predictors since some Predictors expect a checkpoint dict and others expect checkpoint dir. I don't think we want to expose these details to the user and instead, only use Checkpoints that have been outputted by Trainers.

@amogkam
Copy link
Contributor

amogkam commented May 23, 2022

Ah I see, the problem is not that I can't create the Predictor, but it's that I need a Checkpoint to actually use it with BatchPredictor or ModelWrapperDeployment.

In that case, I think we should explore this approach: #24977, which should be agnostic to the Checkpoint.

@xwjiang2010
Copy link
Contributor Author

Ah got it, so the idea is that for non training case, user doesn't have to learn the Checkpoint concept, which makes sense. Let me update the PR to reflect that.
How about a Predictor.from_model_and_preprocessor sound?

@xwjiang2010 xwjiang2010 changed the title [air] Add a create_compatible_checkpoint method. [air] Just update a few docs and param names. May 23, 2022
@amogkam amogkam changed the title [air] Just update a few docs and param names. [air] Minor Doc updates May 25, 2022
@amogkam amogkam merged commit 51dbd99 into ray-project:master May 25, 2022
@xwjiang2010 xwjiang2010 deleted the fix_tf_trainer_doc branch July 26, 2023 19:51
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.

2 participants